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<Pair.IntPair>	adjacent4Points(int i, int j) Returns the four adjacencies with order: up, right, down, left.
Stream<Pair.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[][]	array()
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)
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()
void	forEach(Consumer<? super T> action)
void	forEach(int fromRowIndex, int toRowIndex, int fromColumnIndex, int toColumnIndex, Consumer<? super T> action)
T	get(int i, int j)
T	get(Pair.IntPair point)
T[]	getLU2RD()
T[]	getRU2LD()
int	hashCode()
Matrix<T>	hstack(Matrix<T> b)
NullabLe<T>	leftOf(int i, int j)
<R> Matrix<R>	map(java.lang.Class<R> cls, Function<? super T,R> func)
Matrix<T>	map(Function<? super T,T> func)
BooleanMatrix	mapToBoolean(ToBooleanFunction<? super T> func)
ByteMatrix	mapToByte(ToByteFunction<? super T> func)
CharMatrix	mapToChar(ToCharFunction<? super T> func)
DoubleMatrix	mapToDouble(ToDoubleFunction<? super T> func)
FloatMatrix	mapToFloat(ToFloatFunction<? super T> func)
IntMatrix	mapToInt(ToIntFunction<? super T> func)
LongMatrix	mapToLong(ToLongFunction<? super T> func)
ShortMatrix	mapToShort(ToShortFunction<? super T> 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.
void	replaceIf(IntBiPredicate predicate, T newValue) Replace elements by Predicate.test(i, j) based on points
void	replaceIf(Predicate<? super T> 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(Pair.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()
void	updateAll(IntBiFunction<T> func) Update all elements based on points
void	updateAll(UnaryOperator<T> func)
void	updateColumn(int columnIndex, UnaryOperator<T> func)
void	updateLU2RD(UnaryOperator<T> func)
void	updateRow(int rowIndex, UnaryOperator<T> func)
void	updateRU2LD(UnaryOperator<T> func)
NullabLe<T>	upOf(int i, int j)
Matrix<T>	vstack(Matrix<? extends T> b)
<B,R> Matrix<R>	zipWith(java.lang.Class<R> cls, Matrix<B> matrixB, BiFunction<? super T,? super B,R> zipFunction)
<B,C,R> Matrix<R>	zipWith(java.lang.Class<R> cls, Matrix<B> matrixB, Matrix<C> matrixC, TriFunction<? super T,? super B,? super C,R> zipFunction)
<B> Matrix<T>	zipWith(Matrix<B> matrixB, BiFunction<? super T,? super B,T> zipFunction)
<B,C> Matrix<T>	zipWith(Matrix<B> matrixB, Matrix<C> matrixC, TriFunction<? super T,? super B,? super C,T> zipFunction)

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

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)

array

public T[][] array()

get

public T get(int i,
             int j)

get

public T get(Pair.IntPair point)

set

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

set

public void set(Pair.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<Pair.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<Pair.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 void updateRow(int rowIndex,
                      UnaryOperator<T> func)

updateColumn

public void updateColumn(int columnIndex,
                         UnaryOperator<T> func)

getLU2RD

public T[] getLU2RD()

setLU2RD

public void setLU2RD(T[] diagonal)

updateLU2RD

public void updateLU2RD(UnaryOperator<T> func)

getRU2LD

public T[] getRU2LD()

setRU2LD

public void setRU2LD(T[] diagonal)

updateRU2LD

public void updateRU2LD(UnaryOperator<T> func)

updateAll

public void updateAll(UnaryOperator<T> func)

updateAll

public void updateAll(IntBiFunction<T> func)

Update all elements based on points

Parameters:

func -

replaceIf

public void replaceIf(Predicate<? super T> predicate,
                      T newValue)

replaceIf

public void replaceIf(IntBiPredicate predicate,
                      T newValue)

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

Parameters:

predicate -

newValue -

map

public Matrix<T> map(Function<? super T,T> func)

map

public <R> Matrix<R> map(java.lang.Class<R> cls,
                         Function<? super T,R> func)

mapToBoolean

public BooleanMatrix mapToBoolean(ToBooleanFunction<? super T> func)

mapToByte

public ByteMatrix mapToByte(ToByteFunction<? super T> func)

mapToChar

public CharMatrix mapToChar(ToCharFunction<? super T> func)

mapToShort

public ShortMatrix mapToShort(ToShortFunction<? super T> func)

mapToInt

public IntMatrix mapToInt(ToIntFunction<? super T> func)

mapToLong

public LongMatrix mapToLong(ToLongFunction<? super T> func)

mapToFloat

public FloatMatrix mapToFloat(ToFloatFunction<? super T> func)

mapToDouble

public DoubleMatrix mapToDouble(ToDoubleFunction<? super T> func)

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

reverseH

public void reverseH()

reverseV

public void reverseV()

flipH

public Matrix<T> flipH()

flipV

public Matrix<T> 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

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

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<T> b)

Parameters:

b -

Returns:

See Also:

IntMatrix.hstack(IntMatrix)

zipWith

public <B> Matrix<T> zipWith(Matrix<B> matrixB,
                             BiFunction<? super T,? super B,T> zipFunction)

zipWith

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

zipWith

public <B,C> Matrix<T> zipWith(Matrix<B> matrixB,
                               Matrix<C> matrixC,
                               TriFunction<? super T,? super B,? super C,T> zipFunction)

zipWith

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

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 void forEach(Consumer<? super T> action)

forEach

public void forEach(int fromRowIndex,
                    int toRowIndex,
                    int fromColumnIndex,
                    int toColumnIndex,
                    Consumer<? super T> action)

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