com.landawn.abacus.util

Class Matrix<T>

java.lang.Object

com.landawn.abacus.util.AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

com.landawn.abacus.util.Matrix<T>

public final class Matrix<T>
extends AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Since:

0.8

Author:

Haiyang Li

Field Summary

Fields inherited from class com.landawn.abacus.util.AbstractMatrix

cols, count, rows

Constructor Summary

Constructors

Constructor and Description
Matrix(T[][] a)

Method Summary

Modifier and Type	Method and Description
Stream<IntPair>	adjacent4Points(int i, int j) Returns the four adjacencies with order: up, right, down, left.
Stream<IntPair>	adjacent8Points(int i, int j) Returns the eight adjacencies with order: left-up, up, right-up, right, right-down, down, left-down, left.
T[]	column(int columnIndex)
Matrix<T>	copy()
Matrix<T>	copy(int fromRowIndex, int toRowIndex)
Matrix<T>	copy(int fromRowIndex, int toRowIndex, int fromColumnIndex, int toColumnIndex)
static <T> Matrix<T>	diagonal(T[] leftUp2RighDownDiagonal, T[] rightUp2LeftDownDiagonal)
static <T> Matrix<T>	diagonalLU2RD(T[] leftUp2RighDownDiagonal)
static <T> Matrix<T>	diagonalRU2LD(T[] rightUp2LeftDownDiagonal)
Nullable<T>	downOf(int i, int j)
boolean	equals(java.lang.Object obj)
Matrix<T>	extend(int newRows, int newCols)
Matrix<T>	extend(int toUp, int toDown, int toLeft, int toRight)
Matrix<T>	extend(int toUp, int toDown, int toLeft, int toRight, T defaultValueForNewCell)
Matrix<T>	extend(int newRows, int newCols, T defaultValueForNewCell)
void	fill(int fromRowIndex, int fromColumnIndex, T[][] b)
void	fill(T val)
void	fill(T[][] b)
java.util.List<T>	flatten()
Matrix<T>	flipH()
Matrix<T>	flipV()
<E extends java.lang.Exception> void	forEach(int fromRowIndex, int toRowIndex, int fromColumnIndex, int toColumnIndex, Try.Consumer<? super T,E> action)
<E extends java.lang.Exception> void	forEach(Try.Consumer<? super T,E> action)
T	get(int i, int j)
T	get(IntPair point)
T[]	getLU2RD()
T[]	getRU2LD()
int	hashCode()
Matrix<T>	hstack(Matrix<? extends T> b)
Nullable<T>	leftOf(int i, int j)
<R,E extends java.lang.Exception> Matrix<R>	map(java.lang.Class<R> cls, Try.Function<? super T,R,E> func)
<E extends java.lang.Exception> Matrix<T>	map(Try.UnaryOperator<T,E> func)
<E extends java.lang.Exception> BooleanMatrix	mapToBoolean(Try.ToBooleanFunction<? super T,E> func)
<E extends java.lang.Exception> ByteMatrix	mapToByte(Try.ToByteFunction<? super T,E> func)
<E extends java.lang.Exception> CharMatrix	mapToChar(Try.ToCharFunction<? super T,E> func)
<E extends java.lang.Exception> DoubleMatrix	mapToDouble(Try.ToDoubleFunction<? super T,E> func)
<E extends java.lang.Exception> FloatMatrix	mapToFloat(Try.ToFloatFunction<? super T,E> func)
<E extends java.lang.Exception> IntMatrix	mapToInt(Try.ToIntFunction<? super T,E> func)
<E extends java.lang.Exception> LongMatrix	mapToLong(Try.ToLongFunction<? super T,E> func)
<E extends java.lang.Exception> ShortMatrix	mapToShort(Try.ToShortFunction<? super T,E> func)
static <T> Matrix<T>	of(T[]... a)
static <T> Matrix<T>	repeat(T val, int len)
Matrix<T>	repelem(int rowRepeats, int colRepeats) Repeat elements rowRepeats times in row direction and colRepeats times in column direction.
<E extends java.lang.Exception> void	replaceIf(Try.IntBiPredicate<E> predicate, T newValue) Replace elements by Predicate.test(i, j) based on points
<E extends java.lang.Exception> void	replaceIf(Try.Predicate<? super T,E> predicate, T newValue)
Matrix<T>	repmat(int rowRepeats, int colRepeats) Repeat this matrix rowRepeats times in row direction and colRepeats times in column direction.
Matrix<T>	reshape(int newRows, int newCols)
void	reverseH()
void	reverseV()
Nullable<T>	rightOf(int i, int j)
Matrix<T>	rotate180() Rotate this matrix clockwise 180
Matrix<T>	rotate270() Rotate this matrix clockwise 270
Matrix<T>	rotate90() Rotate this matrix clockwise 90
T[]	row(int rowIndex)
void	set(int i, int j, T val)
void	set(IntPair point, T val)
void	setColumn(int columnIndex, T[] column)
void	setLU2RD(T[] diagonal)
void	setRow(int rowIndex, T[] row)
void	setRU2LD(T[] diagonal)
Stream<Stream<T>>	streamC()
Stream<Stream<T>>	streamC(int fromColumnIndex, int toColumnIndex)
Stream<T>	streamH()
Stream<T>	streamH(int rowIndex)
Stream<T>	streamH(int fromRowIndex, int toRowIndex)
Stream<T>	streamLU2RD()
Stream<Stream<T>>	streamR()
Stream<Stream<T>>	streamR(int fromRowIndex, int toRowIndex)
Stream<T>	streamRU2LD()
Stream<T>	streamV()
Stream<T>	streamV(int columnIndex)
Stream<T>	streamV(int fromColumnIndex, int toColumnIndex)
java.lang.String	toString()
Matrix<T>	transpose()
<E extends java.lang.Exception> void	updateAll(Try.IntBiFunction<T,E> func) Update all elements based on points
<E extends java.lang.Exception> void	updateAll(Try.UnaryOperator<T,E> func)
<E extends java.lang.Exception> void	updateColumn(int columnIndex, Try.UnaryOperator<T,E> func)
<E extends java.lang.Exception> void	updateLU2RD(Try.UnaryOperator<T,E> func)
<E extends java.lang.Exception> void	updateRow(int rowIndex, Try.UnaryOperator<T,E> func)
<E extends java.lang.Exception> void	updateRU2LD(Try.UnaryOperator<T,E> func)
Nullable<T>	upOf(int i, int j)
Matrix<T>	vstack(Matrix<? extends T> b)
<B,C,R,E extends java.lang.Exception> Matrix<R>	zipWith(java.lang.Class<R> cls, Matrix<B> matrixB, Matrix<C> matrixC, Try.TriFunction<? super T,? super B,? super C,R,E> zipFunction)
<B,R,E extends java.lang.Exception> Matrix<R>	zipWith(java.lang.Class<R> cls, Matrix<B> matrixB, Try.BiFunction<? super T,? super B,R,E> zipFunction)
<B,C,E extends java.lang.Exception> Matrix<T>	zipWith(Matrix<B> matrixB, Matrix<C> matrixC, Try.TriFunction<? super T,? super B,? super C,T,E> zipFunction)
<B,E extends java.lang.Exception> Matrix<T>	zipWith(Matrix<B> matrixB, Try.BiFunction<? super T,? super B,T,E> zipFunction)

Methods inherited from class com.landawn.abacus.util.AbstractMatrix

array, isEmpty, isSameShape, pointsC, pointsC, pointsH, pointsH, pointsH, pointsLU2RD, pointsR, pointsR, pointsRU2LD, pointsV, pointsV, pointsV, println, reshape

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Matrix

public Matrix(T[][] a)

Method Detail

of

@SafeVarargs
public static <T> Matrix<T> of(T[]... a)

repeat

public static <T> Matrix<T> repeat(T val,
                                   int len)

diagonalLU2RD

public static <T> Matrix<T> diagonalLU2RD(T[] leftUp2RighDownDiagonal)

diagonalRU2LD

public static <T> Matrix<T> diagonalRU2LD(T[] rightUp2LeftDownDiagonal)

diagonal

public static <T> Matrix<T> diagonal(T[] leftUp2RighDownDiagonal,
                                     T[] rightUp2LeftDownDiagonal)

get

public T get(int i,
             int j)

get

public T get(IntPair point)

set

public void set(int i,
                int j,
                T val)

set

public void set(IntPair point,
                T val)

upOf

public Nullable<T> upOf(int i,
                        int j)

downOf

public Nullable<T> downOf(int i,
                          int j)

leftOf

public Nullable<T> leftOf(int i,
                          int j)

rightOf

public Nullable<T> rightOf(int i,
                           int j)

adjacent4Points

public Stream<IntPair> adjacent4Points(int i,
                                       int j)

Returns the four adjacencies with order: up, right, down, left. null is set if the adjacency doesn't exist.

Parameters:

i -

j -

Returns:

adjacent8Points

public Stream<IntPair> adjacent8Points(int i,
                                       int j)

Returns the eight adjacencies with order: left-up, up, right-up, right, right-down, down, left-down, left. null is set if the adjacency doesn't exist.

Parameters:

i -

j -

Returns:

row

public T[] row(int rowIndex)

column

public T[] column(int columnIndex)

setRow

public void setRow(int rowIndex,
                   T[] row)

setColumn

public void setColumn(int columnIndex,
                      T[] column)

updateRow

public <E extends java.lang.Exception> void updateRow(int rowIndex,
                                                      Try.UnaryOperator<T,E> func)
                                               throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

updateColumn

public <E extends java.lang.Exception> void updateColumn(int columnIndex,
                                                         Try.UnaryOperator<T,E> func)
                                                  throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

getLU2RD

public T[] getLU2RD()

setLU2RD

public void setLU2RD(T[] diagonal)

updateLU2RD

public <E extends java.lang.Exception> void updateLU2RD(Try.UnaryOperator<T,E> func)
                                                 throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

getRU2LD

public T[] getRU2LD()

setRU2LD

public void setRU2LD(T[] diagonal)

updateRU2LD

public <E extends java.lang.Exception> void updateRU2LD(Try.UnaryOperator<T,E> func)
                                                 throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

updateAll

public <E extends java.lang.Exception> void updateAll(Try.UnaryOperator<T,E> func)
                                               throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

updateAll

public <E extends java.lang.Exception> void updateAll(Try.IntBiFunction<T,E> func)
                                               throws E extends java.lang.Exception

Update all elements based on points

Parameters:

func -

Throws:

E extends java.lang.Exception

replaceIf

public <E extends java.lang.Exception> void replaceIf(Try.Predicate<? super T,E> predicate,
                                                      T newValue)
                                               throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

replaceIf

public <E extends java.lang.Exception> void replaceIf(Try.IntBiPredicate<E> predicate,
                                                      T newValue)
                                               throws E extends java.lang.Exception

Replace elements by Predicate.test(i, j) based on points

Parameters:

predicate -

newValue -

Throws:

E extends java.lang.Exception

map

public <E extends java.lang.Exception> Matrix<T> map(Try.UnaryOperator<T,E> func)
                                              throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

map

public <R,E extends java.lang.Exception> Matrix<R> map(java.lang.Class<R> cls,
                                                       Try.Function<? super T,R,E> func)
                                                throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToBoolean

public <E extends java.lang.Exception> BooleanMatrix mapToBoolean(Try.ToBooleanFunction<? super T,E> func)
                                                           throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToByte

public <E extends java.lang.Exception> ByteMatrix mapToByte(Try.ToByteFunction<? super T,E> func)
                                                     throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToChar

public <E extends java.lang.Exception> CharMatrix mapToChar(Try.ToCharFunction<? super T,E> func)
                                                     throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToShort

public <E extends java.lang.Exception> ShortMatrix mapToShort(Try.ToShortFunction<? super T,E> func)
                                                       throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToInt

public <E extends java.lang.Exception> IntMatrix mapToInt(Try.ToIntFunction<? super T,E> func)
                                                   throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToLong

public <E extends java.lang.Exception> LongMatrix mapToLong(Try.ToLongFunction<? super T,E> func)
                                                     throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToFloat

public <E extends java.lang.Exception> FloatMatrix mapToFloat(Try.ToFloatFunction<? super T,E> func)
                                                       throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

mapToDouble

public <E extends java.lang.Exception> DoubleMatrix mapToDouble(Try.ToDoubleFunction<? super T,E> func)
                                                         throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

fill

public void fill(T val)

fill

public void fill(T[][] b)

fill

public void fill(int fromRowIndex,
                 int fromColumnIndex,
                 T[][] b)

copy

public Matrix<T> copy()

Specified by:

copy in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

copy

public Matrix<T> copy(int fromRowIndex,
                      int toRowIndex)

Specified by:

copy in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

copy

public Matrix<T> copy(int fromRowIndex,
                      int toRowIndex,
                      int fromColumnIndex,
                      int toColumnIndex)

Specified by:

copy in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

extend

public Matrix<T> extend(int newRows,
                        int newCols)

extend

public Matrix<T> extend(int newRows,
                        int newCols,
                        T defaultValueForNewCell)

extend

public Matrix<T> extend(int toUp,
                        int toDown,
                        int toLeft,
                        int toRight)

extend

public Matrix<T> extend(int toUp,
                        int toDown,
                        int toLeft,
                        int toRight,
                        T defaultValueForNewCell)

reverseH

public void reverseH()

reverseV

public void reverseV()

flipH

public Matrix<T> flipH()

Returns:

See Also:

IntMatrix.flipH()

flipV

public Matrix<T> flipV()

Returns:

See Also:

IntMatrix.flipV()

rotate90

public Matrix<T> rotate90()

Description copied from class: AbstractMatrix

Rotate this matrix clockwise 90

Specified by:

rotate90 in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

rotate180

public Matrix<T> rotate180()

Description copied from class: AbstractMatrix

Rotate this matrix clockwise 180

Specified by:

rotate180 in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

rotate270

public Matrix<T> rotate270()

Description copied from class: AbstractMatrix

Rotate this matrix clockwise 270

Specified by:

rotate270 in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a new Matrix

transpose

public Matrix<T> transpose()

Specified by:

transpose in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

reshape

public Matrix<T> reshape(int newRows,
                         int newCols)

Specified by:

reshape in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

repelem

public Matrix<T> repelem(int rowRepeats,
                         int colRepeats)

Repeat elements rowRepeats times in row direction and colRepeats times in column direction.

Specified by:

repelem in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

rowRepeats -

colRepeats -

Returns:

a new matrix

See Also:

IntMatrix.repelem(int, int)

repmat

public Matrix<T> repmat(int rowRepeats,
                        int colRepeats)

Repeat this matrix rowRepeats times in row direction and colRepeats times in column direction.

Specified by:

repmat in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

rowRepeats -

colRepeats -

Returns:

a new matrix

See Also:

IntMatrix.repmat(int, int)

flatten

public java.util.List<T> flatten()

Specified by:

flatten in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

vstack

public Matrix<T> vstack(Matrix<? extends T> b)

Parameters:

b -

Returns:

See Also:

IntMatrix.vstack(IntMatrix)

hstack

public Matrix<T> hstack(Matrix<? extends T> b)

Parameters:

b -

Returns:

See Also:

IntMatrix.hstack(IntMatrix)

zipWith

public <B,E extends java.lang.Exception> Matrix<T> zipWith(Matrix<B> matrixB,
                                                           Try.BiFunction<? super T,? super B,T,E> zipFunction)
                                                    throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

zipWith

public <B,R,E extends java.lang.Exception> Matrix<R> zipWith(java.lang.Class<R> cls,
                                                             Matrix<B> matrixB,
                                                             Try.BiFunction<? super T,? super B,R,E> zipFunction)
                                                      throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

zipWith

public <B,C,E extends java.lang.Exception> Matrix<T> zipWith(Matrix<B> matrixB,
                                                             Matrix<C> matrixC,
                                                             Try.TriFunction<? super T,? super B,? super C,T,E> zipFunction)
                                                      throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

zipWith

public <B,C,R,E extends java.lang.Exception> Matrix<R> zipWith(java.lang.Class<R> cls,
                                                               Matrix<B> matrixB,
                                                               Matrix<C> matrixC,
                                                               Try.TriFunction<? super T,? super B,? super C,R,E> zipFunction)
                                                        throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

streamLU2RD

public Stream<T> streamLU2RD()

Specified by:

streamLU2RD in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a stream composed by elements on the diagonal line from left up to right down.

streamRU2LD

public Stream<T> streamRU2LD()

Specified by:

streamRU2LD in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a stream composed by elements on the diagonal line from right up to left down.

streamH

public Stream<T> streamH()

Specified by:

streamH in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a stream based on the order of row.

streamH

public Stream<T> streamH(int rowIndex)

Specified by:

streamH in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

streamH

public Stream<T> streamH(int fromRowIndex,
                         int toRowIndex)

Specified by:

streamH in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

fromRowIndex -

toRowIndex -

Returns:

a stream based on the order of row.

streamV

@Beta
public Stream<T> streamV()

Specified by:

streamV in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a stream based on the order of column.

streamV

public Stream<T> streamV(int columnIndex)

Specified by:

streamV in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

streamV

@Beta
public Stream<T> streamV(int fromColumnIndex,
                                int toColumnIndex)

Specified by:

streamV in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

fromColumnIndex -

toColumnIndex -

Returns:

a stream based on the order of column.

streamR

public Stream<Stream<T>> streamR()

Specified by:

streamR in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a row stream based on the order of row.

streamR

public Stream<Stream<T>> streamR(int fromRowIndex,
                                 int toRowIndex)

Specified by:

streamR in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

fromRowIndex -

toRowIndex -

Returns:

a row stream based on the order of row.

streamC

@Beta
public Stream<Stream<T>> streamC()

Specified by:

streamC in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Returns:

a column stream based on the order of column.

streamC

@Beta
public Stream<Stream<T>> streamC(int fromColumnIndex,
                                        int toColumnIndex)

Specified by:

streamC in class AbstractMatrix<T[],java.util.List<T>,Stream<T>,Stream<Stream<T>>,Matrix<T>>

Parameters:

fromColumnIndex -

toColumnIndex -

Returns:

a column stream based on the order of column.

forEach

public <E extends java.lang.Exception> void forEach(Try.Consumer<? super T,E> action)
                                             throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

forEach

public <E extends java.lang.Exception> void forEach(int fromRowIndex,
                                                    int toRowIndex,
                                                    int fromColumnIndex,
                                                    int toColumnIndex,
                                                    Try.Consumer<? super T,E> action)
                                             throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object