Package org.flag4j.core

Interface MatrixOperationsMixin<T,U,V,W,Y,X extends Number,TT extends VectorMixin<TT,UU,?,?,?,?,?,?>,UU extends VectorMixin<UU,UU,?,CVector,X,U,U,CMatrix>>

Type Parameters:

T - Matrix type.

U - Dense matrix type.

V - Sparse matrix type.

W - Complex matrix type.

Y - Complex sparse matrix type.

X - Matrix entry type.

TT - Vector type equivalent.

UU - Dense vector type.

All Known Subinterfaces:

MatrixMixin<T,U,V,W,VV,X,TT,UU>

All Known Implementing Classes:

CMatrix, CooCMatrix, CooMatrix, CsrCMatrix, CsrMatrix, Matrix

public interface MatrixOperationsMixin<T,U,V,W,Y,X extends Number,TT extends VectorMixin<TT,UU,?,?,?,?,?,?>,UU extends VectorMixin<UU,UU,?,CVector,X,U,U,CMatrix>>

This interface specifies operations which should be implemented by any matrix (rank 2 tensor).

Method Summary

Modifier and Type	Method	Description
CMatrix	add(CMatrix B)	Computes the element-wise addition between two tensors of the same rank.
U	add(Matrix B)	Computes the element-wise addition between two matrices.
W	add(CooCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
T	add(CooMatrix B)	Computes the element-wise addition between two tensors of the same rank.
W	add(CsrCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
T	add(CsrMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CMatrix	addToEachCol(CVector b)	Adds a vector to each column of a matrix.
U	addToEachCol(Vector b)	Adds a vector to each column of a matrix.
CMatrix	addToEachCol(CooCVector b)	Adds a vector to each column of a matrix.
U	addToEachCol(CooVector b)	Adds a vector to each column of a matrix.
CMatrix	addToEachRow(CVector b)	Adds a vector to each row of a matrix.
U	addToEachRow(Vector b)	Adds a vector to each row of a matrix.
CMatrix	addToEachRow(CooCVector b)	Adds a vector to each row of a matrix.
U	addToEachRow(CooVector b)	Adds a vector to each row of a matrix.
CMatrix	augment(CMatrix B)	Stacks matrices along rows.
W	augment(CVector b)	Augments a matrix with a vector.
U	augment(Matrix B)	Stacks matrices along rows.
T	augment(Vector b)	Augments a matrix with a vector.
W	augment(CooCMatrix B)	Stacks matrices along rows.
W	augment(CooCVector b)	Augments a matrix with a vector.
T	augment(CooMatrix B)	Stacks matrices along rows.
T	augment(CooVector b)	Augments a matrix with a vector.
default W	augment(CsrCMatrix B)	Stacks matrices along rows.
default T	augment(CsrMatrix B)	Stacks matrices along rows.
T	copy()	Copies this matrix.
X	det()	Computes the determinant of a square matrix.
W	elemDiv(CMatrix B)	Computes the element-wise division between two matrices.
T	elemDiv(Matrix B)	Computes the element-wise division between two matrices.
W	elemMult(CMatrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
T	elemMult(Matrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
Y	elemMult(CooCMatrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
V	elemMult(CooMatrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
CNumber	fib(CMatrix B)	Computes the Frobenius inner product of two matrices.
X	fib(Matrix B)	Computes the Frobenius inner product of two matrices.
CNumber	fib(CooCMatrix B)	Computes the Frobenius inner product of two matrices.
X	fib(CooMatrix B)	Computes the Frobenius inner product of two matrices.
TT	getCol(int j)	Get the column of this matrix at the specified index.
TT	getCol(int colIdx, int rowStart, int rowEnd)	Gets a specified column of this matrix between rowStart (inclusive) and rowEnd (exclusive).
TT	getColBelow(int rowStart, int j)	Get a specified column of this matrix at and below a specified row.
TT	getDiag()	Extracts the diagonal elements of this matrix and returns them as a vector.
TT	getRow(int i)	Get the row of this matrix at the specified index.
TT	getRowAfter(int colStart, int i)	Get a specified row of this matrix at and after a specified column.
T	getSlice(int rowStart, int rowEnd, int colStart, int colEnd)	Gets a specified slice of this matrix.
T	H()	Compute the hermitian transpose of this matrix.
T	mult(double factor)	Computes scalar multiplication of a matrix.
CMatrix	mult(CMatrix B)	Computes the matrix multiplication between two matrices.
CVector	mult(CVector b)	Computes matrix-vector multiplication.
U	mult(Matrix B)	Computes the matrix multiplication between two matrices.
UU	mult(Vector b)	Computes matrix-vector multiplication.
CMatrix	mult(CooCMatrix B)	Computes the matrix multiplication between two matrices.
CVector	mult(CooCVector b)	Computes matrix-vector multiplication.
U	mult(CooMatrix B)	Computes the matrix multiplication between two matrices.
UU	mult(CooVector b)	Computes matrix-vector multiplication.
CMatrix	mult(CsrCMatrix B)	Computes the matrix multiplication between two matrices.
U	mult(CsrMatrix B)	Computes the matrix multiplication between two matrices.
U	mult(T B)	Computes the matrix multiplication between two matrices.
UU	mult(TT b)	Computes the matrix-vector multiplication.
default CMatrix	multTranspose(CMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by {this.mult(B.T()).
default U	multTranspose(Matrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
default CMatrix	multTranspose(CooCMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
default U	multTranspose(CooMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
default CMatrix	multTranspose(CsrCMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
default U	multTranspose(CsrMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
U	pow(int exponent)	Computes the matrix power with a given exponent.
T	setCol(TT values, int j)	Sets a column of this matrix.
CMatrix	stack(CMatrix B)	Stacks matrices along columns.
default CMatrix	stack(CMatrix B, int axis)	Stacks matrices along specified axis.
W	stack(CVector b)	Stacks vector to this matrix along columns.
default W	stack(CVector b, int axis)	Stacks matrix and vector along specified axis.
U	stack(Matrix B)	Stacks matrices along columns.
default U	stack(Matrix B, int axis)	Stacks matrices along specified axis.
T	stack(Vector b)	Stacks vector to this matrix along columns.
default T	stack(Vector b, int axis)	Stacks matrix and vector along specified axis.
W	stack(CooCMatrix B)	Stacks matrices along columns.
default W	stack(CooCMatrix B, int axis)	Stacks matrices along specified axis.
W	stack(CooCVector b)	Stacks vector to this matrix along columns.
default W	stack(CooCVector b, int axis)	Stacks matrix and vector along specified axis.
T	stack(CooMatrix B)	Stacks matrices along columns.
default T	stack(CooMatrix B, int axis)	Stacks matrices along specified axis.
T	stack(CooVector b)	Stacks vector to this matrix along columns.
default T	stack(CooVector b, int axis)	Stacks matrix and vector along specified axis.
default W	stack(CsrCMatrix B)	Stacks matrices along columns.
default W	stack(CsrCMatrix B, int axis)	Stacks matrices along specified axis.
default T	stack(CsrMatrix B)	Stacks matrices along columns.
default T	stack(CsrMatrix B, int axis)	Stacks matrices along specified axis.
CMatrix	sub(CMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
U	sub(Matrix B)	Computes the element-wise subtraction of two tensors of the same rank.
W	sub(CooCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
T	sub(CooMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
W	sub(CsrCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
T	sub(CsrMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
UU	sumCols()	Sums together the columns of a matrix as if each column was a column vector.
UU	sumRows()	Sums together the rows of a matrix as if each row was a row vector.
TT	toVector()	Converts this matrix to an equivalent vector.
X	tr()	Computes the trace of this matrix.
X	trace()	Computes the trace of this matrix.

Method Details

add

U add(Matrix B)

Computes the element-wise addition between two matrices.

Parameters:

B - Second matrix in the addition.

Returns:

The result of adding the matrix B to this matrix element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

add

T add(CooMatrix B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

add

T add(CsrMatrix B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

add

W add(CsrCMatrix B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

add

CMatrix add(CMatrix B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

add

W add(CooCMatrix B)

Computes the element-wise addition between two tensors of the same rank.

Parameters:

B - Second tensor in the addition.

Returns:

The result of adding the tensor B to this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

U sub(Matrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

T sub(CooMatrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

T sub(CsrMatrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

W sub(CsrCMatrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

CMatrix sub(CMatrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

sub

W sub(CooCMatrix B)

Computes the element-wise subtraction of two tensors of the same rank.

Parameters:

B - Second tensor in the subtraction.

Returns:

The result of subtracting the tensor B from this tensor element-wise.

Throws:

IllegalArgumentException - If A and B have different shapes.

mult

U mult(Matrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

UU mult(TT b)

Computes the matrix-vector multiplication.

Parameters:

b - Vector to multiply this matrix to.

Returns:

The vector result from multiplying this matrix by the vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of entries b.

mult

U mult(T B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

U mult(CooMatrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

U mult(CsrMatrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

CMatrix mult(CMatrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

CMatrix mult(CooCMatrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

CMatrix mult(CsrCMatrix B)

Computes the matrix multiplication between two matrices.

Parameters:

B - Second matrix in the matrix multiplication.

Returns:

The result of matrix multiplying this matrix with matrix B.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of rows in matrix B.

mult

UU mult(Vector b)

Computes matrix-vector multiplication.

Parameters:

b - Vector in the matrix-vector multiplication.

Returns:

The result of matrix multiplying this matrix with vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of entries in the vector b.

mult

UU mult(CooVector b)

Computes matrix-vector multiplication.

Parameters:

b - Vector in the matrix-vector multiplication.

Returns:

The result of matrix multiplying this matrix with vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of entries in the vector b.

mult

CVector mult(CVector b)

Computes matrix-vector multiplication.

Parameters:

b - Vector in the matrix-vector multiplication.

Returns:

The result of matrix multiplying this matrix with vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of entries in the vector b.

mult

CVector mult(CooCVector b)

Computes matrix-vector multiplication.

Parameters:

b - Vector in the matrix-vector multiplication.

Returns:

The result of matrix multiplying this matrix with vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix do not equal the number of entries in the vector b.

multTranspose

default U multTranspose(Matrix B)

Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

multTranspose

default U multTranspose(CooMatrix B)

Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

multTranspose

default U multTranspose(CsrMatrix B)

Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

multTranspose

default CMatrix multTranspose(CMatrix B)

Multiplies this matrix with the transpose of the B tensor as if by {this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

multTranspose

default CMatrix multTranspose(CooCMatrix B)

Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

multTranspose

default CMatrix multTranspose(CsrCMatrix B)

Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()). For large matrices, this method may be significantly faster than directly computing the transpose followed by the multiplication as this.mult(B.T()).

Parameters:

B - The second matrix in the multiplication and the matrix to transpose/

Returns:

The result of multiplying this matrix with the transpose of B.

pow

U pow(int exponent)

Computes the matrix power with a given exponent. This is equivalent to multiplying a matrix to itself 'exponent' times. Note, this method is preferred over repeated multiplication of a matrix as this method will be significantly faster.

Parameters:

exponent - The exponent in the matrix power.

Returns:

The result of multiplying this matrix with itself 'exponent' times.

elemMult

T elemMult(Matrix B)

Computes the element-wise multiplication (Hadamard product) between two matrices.

Parameters:

B - Second matrix in the element-wise multiplication.

Returns:

The result of element-wise multiplication of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

elemMult

V elemMult(CooMatrix B)

Computes the element-wise multiplication (Hadamard product) between two matrices.

Parameters:

B - Second matrix in the element-wise multiplication.

Returns:

The result of element-wise multiplication of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

elemMult

W elemMult(CMatrix B)

Computes the element-wise multiplication (Hadamard product) between two matrices.

Parameters:

B - Second matrix in the element-wise multiplication.

Returns:

The result of element-wise multiplication of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

elemMult

Y elemMult(CooCMatrix B)

Computes the element-wise multiplication (Hadamard product) between two matrices.

Parameters:

B - Second matrix in the element-wise multiplication.

Returns:

The result of element-wise multiplication of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

elemDiv

T elemDiv(Matrix B)

Computes the element-wise division between two matrices.

Parameters:

B - Second matrix in the element-wise division.

Returns:

The result of element-wise division of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

ArithmeticException - If B contains any zero entries.

elemDiv

W elemDiv(CMatrix B)

Computes the element-wise division between two matrices.

Parameters:

B - Second matrix in the element-wise division.

Returns:

The result of element-wise division of this matrix with the matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

ArithmeticException - If B contains any zero entries.

det

X det()

Computes the determinant of a square matrix.

Returns:

The determinant of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

fib

X fib(Matrix B)

Computes the Frobenius inner product of two matrices.

Parameters:

B - Second matrix in the Frobenius inner product

Returns:

The Frobenius inner product of this matrix and matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

fib

X fib(CooMatrix B)

Computes the Frobenius inner product of two matrices.

Parameters:

B - Second matrix in the Frobenius inner product

Returns:

The Frobenius inner product of this matrix and matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

fib

CNumber fib(CMatrix B)

Computes the Frobenius inner product of two matrices.

Parameters:

B - Second matrix in the Frobenius inner product

Returns:

The Frobenius inner product of this matrix and matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

fib

CNumber fib(CooCMatrix B)

Computes the Frobenius inner product of two matrices.

Parameters:

B - Second matrix in the Frobenius inner product

Returns:

The Frobenius inner product of this matrix and matrix B.

Throws:

IllegalArgumentException - If this matrix and B have different shapes.

sumCols

UU sumCols()

Sums together the columns of a matrix as if each column was a column vector.

Returns:

The result of summing together all columns of the matrix as column vectors. If this matrix is an m-by-n matrix, then the result will be a vectors of length m.

sumRows

UU sumRows()

Sums together the rows of a matrix as if each row was a row vector.

Returns:

The result of summing together all rows of the matrix as row vectors. If this matrix is an m-by-n matrix, then the result will be a vector of length n.

addToEachCol

U addToEachCol(Vector b)

Adds a vector to each column of a matrix. The vector need not be a column vector. If it is a row vector it will be treated as if it were a column vector.

Parameters:

b - Vector to add to each column of this matrix.

Returns:

The result of adding the vector b to each column of this matrix.

addToEachCol

U addToEachCol(CooVector b)

Adds a vector to each column of a matrix. The vector need not be a column vector. If it is a row vector it will be treated as if it were a column vector.

Parameters:

b - Vector to add to each column of this matrix.

Returns:

The result of adding the vector b to each column of this matrix.

addToEachCol

CMatrix addToEachCol(CVector b)

Adds a vector to each column of a matrix. The vector need not be a column vector. If it is a row vector it will be treated as if it were a column vector.

Parameters:

b - Vector to add to each column of this matrix.

Returns:

The result of adding the vector b to each column of this matrix.

addToEachCol

CMatrix addToEachCol(CooCVector b)

Adds a vector to each column of a matrix. The vector need not be a column vector. If it is a row vector it will be treated as if it were a column vector.

Parameters:

b - Vector to add to each column of this matrix.

Returns:

The result of adding the vector b to each column of this matrix.

addToEachRow

U addToEachRow(Vector b)

Adds a vector to each row of a matrix. The vector need not be a row vector. If it is a column vector it will be treated as if it were a row vector for this operation.

Parameters:

b - Vector to add to each row of this matrix.

Returns:

The result of adding the vector b to each row of this matrix.

addToEachRow

U addToEachRow(CooVector b)

Adds a vector to each row of a matrix. The vector need not be a row vector. If it is a column vector it will be treated as if it were a row vector for this operation.

Parameters:

b - Vector to add to each row of this matrix.

Returns:

The result of adding the vector b to each row of this matrix.

addToEachRow

CMatrix addToEachRow(CVector b)

Adds a vector to each row of a matrix. The vector need not be a row vector. If it is a column vector it will be treated as if it were a row vector for this operation.

Parameters:

b - Vector to add to each row of this matrix.

Returns:

The result of adding the vector b to each row of this matrix.

addToEachRow

CMatrix addToEachRow(CooCVector b)

Adds a vector to each row of a matrix. The vector need not be a row vector. If it is a column vector it will be treated as if it were a row vector for this operation.

Parameters:

b - Vector to add to each row of this matrix.

Returns:

The result of adding the vector b to each row of this matrix.

stack

U stack(Matrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

T stack(CooMatrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

default T stack(CsrMatrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

default W stack(CsrCMatrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

CMatrix stack(CMatrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

W stack(CooCMatrix B)

Stacks matrices along columns.
Also see stack(Matrix, int) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking this matrix on top of the matrix B.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of columns.

stack

default U stack(Matrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default T stack(CooMatrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default W stack(CsrCMatrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default T stack(CsrMatrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default CMatrix stack(CMatrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default W stack(CooCMatrix B,
 int axis)

Stacks matrices along specified axis.
Also see stack(Matrix) and augment(Matrix).

Parameters:

B - Matrix to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Matrix). - If axis=1, then stacks along columns and is equivalent to stack(Matrix).

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different length along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

augment

U augment(Matrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

augment

T augment(CooMatrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

augment

default T augment(CsrMatrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

augment

default W augment(CsrCMatrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

augment

CMatrix augment(CMatrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

augment

W augment(CooCMatrix B)

Stacks matrices along rows.
Also see stack(Matrix) and stack(Matrix, int).

Parameters:

B - Matrix to stack to this matrix.

Returns:

The result of stacking B to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix and matrix B have a different number of rows.

stack

T stack(Vector b)

Stacks vector to this matrix along columns. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. All vectors will be treated as row vectors.
Also see stack(Vector, int) and augment(Vector).

Parameters:

b - Vector to stack to this matrix.

Returns:

The result of stacking this matrix on top of the vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix is different from the number of entries in the vector b.

stack

T stack(CooVector b)

Stacks vector to this matrix along columns. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. All vectors will be treated as row vectors.
Also see stack(CooVector, int) and augment(CooVector).

Parameters:

b - Vector to stack to this matrix.

Returns:

The result of stacking this matrix on top of the vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix is different from the number of entries in the vector b.

stack

W stack(CVector b)

Stacks vector to this matrix along columns. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. All vectors will be treated as row vectors.
Also see stack(CVector, int) and augment(CVector).

Parameters:

b - Vector to stack to this matrix.

Returns:

The result of stacking this matrix on top of the vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix is different from the number of entries in the vector b.

stack

W stack(CooCVector b)

Stacks vector to this matrix along columns. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. All vectors will be treated as row vectors.
Also see stack(CooCVector, int) and augment(CooCVector).

Parameters:

b - Vector to stack to this matrix.

Returns:

The result of stacking this matrix on top of the vector b.

Throws:

IllegalArgumentException - If the number of columns in this matrix is different from the number of entries in the vector b.

stack

default T stack(Vector b,
 int axis)

Stacks matrix and vector along specified axis. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. See the axis parameter for more info.

Parameters:

b - Vector to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(Vector). In this case, the vector b will be treated as a column vector regardless of the true orientation.
- If axis=1, then stacks along columns and is equivalent to stack(Vector). In this case, the vector b will be treated as a row vector regardless of the true orientation.

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If the number of entries in b is different from the length of this matrix along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default T stack(CooVector b,
 int axis)

Stacks matrix and vector along specified axis. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. See the axis parameter for more info.

Parameters:

b - Vector to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(CooVector). In this case, the vector b will be treated as a column vector regardless of the true orientation.
- If axis=1, then stacks along columns and is equivalent to stack(CooVector). In this case, the vector b will be treated as a row vector regardless of the true orientation.

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If the number of entries in b is different from the length of this matrix along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default W stack(CVector b,
 int axis)

Stacks matrix and vector along specified axis. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. See the axis parameter for more info.

Parameters:

b - Vector to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(CVector). In this case, the vector b will be treated as a column vector regardless of the true orientation.
- If axis=1, then stacks along columns and is equivalent to stack(CVector). In this case, the vector b will be treated as a row vector regardless of the true orientation.

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If the number of entries in b is different from the length of this matrix along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

stack

default W stack(CooCVector b,
 int axis)

Stacks matrix and vector along specified axis. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. See the axis parameter for more info.

Parameters:

b - Vector to stack to this matrix.

axis - Axis along which to stack.
- If axis=0, then stacks along rows and is equivalent to augment(CooCVector). In this case, the vector b will be treated as a column vector regardless of the true orientation.
- If axis=1, then stacks along columns and is equivalent to stack(CooCVector). In this case, the vector b will be treated as a row vector regardless of the true orientation.

Returns:

The result of stacking this matrix and B along the specified axis.

Throws:

IllegalArgumentException - If the number of entries in b is different from the length of this matrix along the corresponding axis.

IllegalArgumentException - If axis is not either 0 or 1.

augment

T augment(Vector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. The vector will be treated as a column vector regardless of the true orientation.
Also see stack(Vector) and stack(Vector, int).

Parameters:

b - vector to augment to this matrix.

Returns:

The result of augmenting b to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix has a different number of rows as entries in b.

augment

T augment(CooVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. The vector will be treated as a column vector regardless of the true orientation.
Also see stack(CooVector) and stack(CooVector, int).

Parameters:

b - vector to augment to this matrix.

Returns:

The result of augmenting b to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix has a different number of rows as entries in b.

augment

W augment(CVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. The vector will be treated as a column vector regardless of the true orientation.
Also see stack(CVector) and stack(CVector, int).

Parameters:

b - vector to augment to this matrix.

Returns:

The result of augmenting b to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix has a different number of rows as entries in b.

augment

W augment(CooCVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix. Note that the orientation of the vector (i.e. row/column vector) does not affect the output of this function. The vector will be treated as a column vector regardless of the true orientation.
Also see stack(CooCVector) and stack(CooCVector, int).

Parameters:

b - vector to augment to this matrix.

Returns:

The result of augmenting b to the right of this matrix.

Throws:

IllegalArgumentException - If this matrix has a different number of rows as entries in b.

getRow

TT getRow(int i)

Get the row of this matrix at the specified index.

Parameters:

i - Index of row to get.

Returns:

The specified row of this matrix.

getCol

TT getCol(int j)

Get the column of this matrix at the specified index.

Parameters:

j - Index of column to get.

Returns:

The specified column of this matrix.

getCol

TT getCol(int colIdx,
 int rowStart,
 int rowEnd)

Gets a specified column of this matrix between rowStart (inclusive) and rowEnd (exclusive).

Parameters:

colIdx - Index of the column of this matrix to get.

rowStart - Starting row of the column (inclusive).

rowEnd - Ending row of the column (exclusive).

Returns:

The column at index colIdx of this matrix between the rowStart and rowEnd indices.

Throws:

IllegalArgumentException - If rowStart is less than 0.

NegativeArraySizeException - If rowEnd is less than rowStart.

toVector

TT toVector()

Converts this matrix to an equivalent vector. If this matrix is not shaped as a row/column vector, it will be flattened then converted to a vector.

Returns:

A vector equivalent to this matrix.

getSlice

T getSlice(int rowStart,
 int rowEnd,
 int colStart,
 int colEnd)

Gets a specified slice of this matrix.

Parameters:

rowStart - Starting row index of slice (inclusive).

rowEnd - Ending row index of slice (exclusive).

colStart - Starting column index of slice (inclusive).

colEnd - Ending row index of slice (exclusive).

Returns:

The specified slice of this matrix. This is a completely new matrix and NOT a view into the matrix.

Throws:

ArrayIndexOutOfBoundsException - If any of the indices are out of bounds of this matrix.

IllegalArgumentException - If rowEnd is not greater than rowStart or if colEnd is not greater than colStart.

getColBelow

TT getColBelow(int rowStart,
 int j)

Get a specified column of this matrix at and below a specified row.

Parameters:

rowStart - Index of the row to begin at.

j - Index of column to get.

Returns:

The specified column of this matrix beginning at the specified row.

Throws:

NegativeArraySizeException - If rowStart is larger than the number of rows in this matrix.

ArrayIndexOutOfBoundsException - If rowStart or j is outside the bounds of this matrix.

getRowAfter

TT getRowAfter(int colStart,
 int i)

Get a specified row of this matrix at and after a specified column.

Parameters:

colStart - Index of the row to begin at.

i - Index of the row to get.

Returns:

The specified row of this matrix beginning at the specified column.

Throws:

NegativeArraySizeException - If colStart is larger than the number of columns in this matrix.

ArrayIndexOutOfBoundsException - If i or colStart is outside the bounds of this matrix.

setCol

T setCol(TT values,
 int j)

Sets a column of this matrix.

Parameters:

values - Vector containing the new values for the matrix.

j - Index of the column of this matrix to set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the number of entries in the values vector is not the same as the number of rows in this matrix.

IndexOutOfBoundsException - If j is not within the bounds of this matrix.

trace

X trace()

Computes the trace of this matrix. That is, the sum of elements along the principle diagonal of this matrix. Same as tr().

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

tr

X tr()

Computes the trace of this matrix. That is, the sum of elements along the principle diagonal of this matrix. Same as trace().

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

getDiag

TT getDiag()

Extracts the diagonal elements of this matrix and returns them as a vector.

Returns:

A vector containing the diagonal entries of this matrix.

H

T H()

Compute the hermitian transpose of this matrix. That is, the complex conjugate transpose of this matrix.

Returns:

The complex conjugate transpose of this matrix.

copy

T copy()

Copies this matrix.

Returns:

A deep copy of this matrix.

mult

T mult(double factor)

Computes scalar multiplication of a matrix.

Parameters:

factor - Scalar value to multiply with matrix.

Returns:

The result of multiplying this matrix by the specified scalar.