Package org.flag4j.arrays.sparse

Class CooMatrix

java.lang.Object

org.flag4j.core.TensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,double[],Double>

org.flag4j.core.sparse_base.SparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,double[],Double>

org.flag4j.core.sparse_base.RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>

org.flag4j.arrays.sparse.CooMatrix

All Implemented Interfaces:

Serializable, MatrixComparisonsMixin<CooMatrix>, MatrixManipulationsMixin<CooMatrix,Double>, MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>, MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>, MatrixPropertiesMixin, RealMatrixMixin<CooMatrix,CooCMatrix>, RealTensorMixin<CooMatrix,CooCMatrix>, SparseTensorMixin, TensorComparisonsMixin, TensorManipulationsMixin<CooMatrix>, TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>, TensorPropertiesMixin

public class CooMatrix
extends RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>
implements MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>, RealMatrixMixin<CooMatrix,CooCMatrix>

Real sparse matrix. Matrix is stored in coordinate list (COO) format.

COO matrices are best suited for efficient modification and construction of sparse matrices. Coo matrices are not well suited for matrix-matrix or matrix-vector multiplication (see CsrMatrix).

If a sparse matrix needs to be incrementally constructed, then a COO matrix should be used to construct the matrix as it allows for efficient modification. If the matrix then needs to be used in a matrix-matrix or matrix-vector multiplication problem, it should first be converted to a CsrMatrix in most cases.

See Also:

• CsrMatrix
• CooCMatrix
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int[]	colIndices	Column indices of the non-zero entries of the sparse matrix.
final int	numCols	The number of columns in this matrix.
final int	numRows	The number of rows in this matrix.
final int[]	rowIndices	Row indices of the non-zero entries of the sparse matrix.

Fields inherited from class org.flag4j.core.sparse_base.SparseTensorBase

indices, nnz

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Constructor	Description
CooMatrix(int size)	Creates a square sparse matrix of specified size filled with zeros.
CooMatrix(int size, double[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a square sparse matrix with specified non-zero entries, row indices, and column indices.
CooMatrix(int rows, int cols)	Creates a sparse matrix of specified number of rows and columns filled with zeros.
CooMatrix(int size, int[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a square sparse matrix with specified non-zero entries, row indices, and column indices.
CooMatrix(int rows, int cols, double[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.
CooMatrix(int rows, int cols, int[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.
CooMatrix(CooMatrix A)	Constructs a sparse tensor whose shape and values are given by another sparse tensor.
CooMatrix(Shape shape)	Creates a sparse matrix of specified shape filled with zeros.
CooMatrix(Shape shape, double[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.
CooMatrix(Shape shape, int[] nonZeroEntries, int[] rowIndices, int[] colIndices)	Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.
CooMatrix(Shape shape, List<Double> entries, List<Integer> rowIndices, List<Integer> colIndices)	Creates a sparse matrix with specified shape, non-zero entries, and indices.

Method Summary

Modifier and Type	Method	Description
Matrix	add(double a)	Adds specified value to all entries of this tensor.
CMatrix	add(CMatrix B)	Computes the element-wise addition between two tensors of the same rank.
Matrix	add(Matrix B)	Computes the element-wise addition between two matrices.
CooCMatrix	add(CooCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CooMatrix	add(CooMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CooCMatrix	add(CsrCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CooMatrix	add(CsrMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CMatrix	add(CNumber a)	Adds specified value to all entries of this tensor.
CMatrix	addToEachCol(CVector b)	Adds a vector to each column of a matrix.
Matrix	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.
Matrix	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.
Matrix	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.
Matrix	addToEachRow(CooVector b)	Adds a vector to each row of a matrix.
boolean	allClose(CooMatrix tensor, double relTol, double absTol)	Checks if all entries of this tensor are close to the entries of the argument tensor.
CMatrix	augment(CMatrix B)	Stacks matrices along rows.
CooCMatrix	augment(CVector b)	Augments a matrix with a vector.
Matrix	augment(Matrix B)	Stacks matrices along rows.
CooMatrix	augment(Vector b)	Augments a matrix with a vector.
CooCMatrix	augment(CooCMatrix B)	Stacks matrices along rows.
CooCMatrix	augment(CooCVector b)	Augments a matrix with a vector.
CooMatrix	augment(CooMatrix B)	Stacks matrices along rows.
CooMatrix	augment(CooVector b)	Augments a matrix with a vector.
CooMatrix	copy()	Creates a copy of this tensor.
Double	det()	Computes the determinant of a square matrix.
CooCMatrix	elemDiv(CMatrix B)	Computes the element-wise division between two matrices.
CooMatrix	elemDiv(Matrix B)	Computes the element-wise division between two tensors.
CooCMatrix	elemMult(CMatrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
CooMatrix	elemMult(Matrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
CooCMatrix	elemMult(CooCMatrix B)	Computes the element-wise multiplication (Hadamard product) between two matrices.
CooMatrix	elemMult(CooMatrix B)	Computes the element-wise multiplication between two tensors.
boolean	equals(Object object)	Checks if an object is equal to this sparse COO matrix.
CNumber	fib(CMatrix B)	Computes the Frobenius inner product of two matrices.
Double	fib(Matrix B)	Computes the Frobenius inner product of two matrices.
CNumber	fib(CooCMatrix B)	Computes the Frobenius inner product of two matrices.
Double	fib(CooMatrix B)	Computes the Frobenius inner product of two matrices.
CooMatrix	flatten()	Flattens tensor to single dimension.
CooMatrix	flatten(int axis)	Flattens a tensor along the specified axis.
static CooMatrix	fromDense(Matrix src)	Constructs a sparse COO matrix from a dense matrix.
Double	get(int... indices)	Gets the element in this tensor at the specified indices.
CooVector	getCol(int j)	Get the column of this matrix at the specified index.
CooVector	getCol(int colIdx, int rowStart, int rowEnd)	Gets a specified column of this matrix between rowStart (inclusive) and rowEnd (exclusive).
CooVector	getColBelow(int rowStart, int j)	Get a specified column of this matrix at and below a specified row.
CooVector	getDiag()	Extracts the diagonal elements of this matrix and returns them as a vector.
CooVector	getRow(int i)	Get the row of this matrix at the specified index.
CooVector	getRowAfter(int colStart, int i)	Get a specified row of this matrix at and after a specified column.
protected CooMatrix	getSelf()	Simply returns a reference of this tensor.
CooMatrix	getSlice(int rowStart, int rowEnd, int colStart, int colEnd)	Gets a specified slice of this matrix.
CooMatrix	H()	Compute the hermitian transpose of this matrix.
boolean	isAntiSymmetric()	Checks if a matrix is anti-symmetric.
boolean	isDiag()	Checks if this matrix is diagonal.
boolean	isFullRank()	Checks if a matrix has full rank.
boolean	isI()	Checks if this matrix is the identity matrix.
boolean	isInvertible()	Checks if a matrix is invertible.
boolean	isOrthogonal()	Checks if this matrix is orthogonal.
boolean	isSingular()	Checks if a matrix is singular.
boolean	isSquare()	Checks if this matrix is square.
boolean	isSymmetric()	Checks if a matrix is symmetric.
boolean	isTri()	Checks if this matrix is triangular (i.e.
boolean	isTriL()	Checks if this matrix is lower triangular.
boolean	isTriU()	Checks if this matrix is upper triangular.
boolean	isVector()	Checks if a matrix can be represented as a vector.
protected CooCMatrix	makeComplexTensor(Shape shape, CNumber[] entries, int[][] indices)	A factory for creating a complex sparse tensor.
protected Matrix	makeDenseTensor(Shape shape, double[] entries)	A factory for creating a real dense tensor.
protected CooMatrix	makeTensor(Shape shape, double[] entries, int[][] indices)	A factory for creating a real sparse tensor.
int	matrixRank()	Computes the rank of this matrix (i.e.
CMatrix	mult(CMatrix B)	Computes the matrix multiplication between two matrices.
CVector	mult(CVector b)	Computes matrix-vector multiplication.
Matrix	mult(Matrix B)	Computes the matrix multiplication between two matrices.
Vector	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.
Matrix	mult(CooMatrix B)	Computes the matrix multiplication between two matrices.
Vector	mult(CooVector b)	Computes the matrix-vector multiplication.
CMatrix	mult(CsrCMatrix B)	Computes the matrix multiplication between two matrices.
Matrix	mult(CsrMatrix B)	Computes the matrix multiplication between two matrices.
CMatrix	multTranspose(CMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by {this.mult(B.T()).
Matrix	multTranspose(Matrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
CMatrix	multTranspose(CooCMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
Matrix	multTranspose(CooMatrix B)	Multiplies this matrix with the transpose of the B tensor as if by this.mult(B.T()).
int	numCols()	Gets the number of columns in this matrix.
int	numRows()	Gets the number of rows in this matrix.
Matrix	pow(int exponent)	Computes the matrix power with a given exponent.
CooMatrix	removeCol(int colIndex)	Removes a specified column from this matrix.
CooMatrix	removeCols(int... colIndices)	Removes a specified set of columns from this matrix.
CooMatrix	removeRow(int rowIndex)	Removes a specified row from this matrix.
CooMatrix	removeRows(int... rowIndices)	Removes a specified set of rows from this matrix.
CooMatrix	reshape(Shape newShape)	Copies and reshapes matrix if possible.
CooMatrix	set(double value, int... indices)	Sets an index of this tensor to a specified value.
CooMatrix	set(double value, int row, int col)	Sets an index of this matrix to the specified value.
CooMatrix	set(Double value, int row, int col)	Sets an index of this matrix to the specified value.
CooMatrix	setCol(double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CooMatrix	setCol(int[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CooMatrix	setCol(Double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CooMatrix	setCol(Integer[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CooMatrix	setCol(Vector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CooMatrix	setCol(CooVector values, int j)	Sets a column of this matrix.
CooMatrix	setRow(double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CooMatrix	setRow(int[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CooMatrix	setRow(Double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CooMatrix	setRow(Integer[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CooMatrix	setSlice(double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CooMatrix	setSlice(int[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CooMatrix	setSlice(Double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CooMatrix	setSlice(Integer[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CooMatrix	setSlice(Matrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CooMatrix	setSlice(CooMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Shape	shape()	Gets the shape of this matrix.
void	sortIndices()	Sorts the indices of this tensor in lexicographical order while maintaining the associated value for each index.
CooCMatrix	sqrtComplex()	Computes the complex element-wise square root of a tensor.
CMatrix	stack(CMatrix B)	Stacks matrices along columns.
CooCMatrix	stack(CVector b)	Stacks vector to this matrix along columns.
Matrix	stack(Matrix B)	Stacks matrices along columns.
CooMatrix	stack(Vector b)	Stacks vector to this matrix along columns.
CooCMatrix	stack(CooCMatrix B)	Stacks matrices along columns.
CooCMatrix	stack(CooCVector b)	Stacks vector to this matrix along columns.
CooMatrix	stack(CooMatrix B)	Stacks matrices along columns.
CooMatrix	stack(CooVector b)	Stacks vector to this matrix along columns.
Matrix	sub(double a)	Adds specified value to all entries of this tensor.
CMatrix	sub(CMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
Matrix	sub(Matrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CooCMatrix	sub(CooCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CooMatrix	sub(CooMatrix B)	Computes the element-wise subtraction between two tensors of the same rank.
CooCMatrix	sub(CsrCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CooMatrix	sub(CsrMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CMatrix	sub(CNumber a)	Subtracts a specified value from all entries of this tensor.
Vector	sumCols()	Sums together the columns of a matrix as if each column was a column vector.
Vector	sumRows()	Sums together the rows of a matrix as if each row was a row vector.
CooMatrix	swapCols(int colIndex1, int colIndex2)	Swaps columns in the matrix.
CooMatrix	swapRows(int rowIndex1, int rowIndex2)	Swaps rows in the matrix.
CooMatrix	T()	Computes the transpose of a tensor.
CooCMatrix	toComplex()	Converts this tensor to an equivalent complex tensor.
CsrMatrix	toCsr()	Converts this COO matrix to an equivalent CSR matrix.
Matrix	toDense()	Converts this sparse tensor to an equivalent dense tensor.
String	toString()	Formats this sparse matrix as a human-readable string.
CooTensor	toTensor()	Converts this matrix to an equivalent sparse tensor.
CooVector	toVector()	Converts this matrix to an equivalent vector.
Double	tr()	Computes the trace of this matrix.
Double	trace()	Computes the trace of this matrix.
int	vectorType()	Checks what type of vector this matrix is.

Methods inherited from class org.flag4j.core.sparse_base.RealSparseTensorBase

abs, argMax, argMin, div, div, isNeg, isOnes, isPos, isZeros, max, maxAbs, min, minAbs, mult, mult, nonZeroEntries, recip, reshape, round, round, roundToZero, roundToZero, sqrt, sum

Methods inherited from class org.flag4j.core.sparse_base.SparseTensorBase

density, sparsity

Methods inherited from class org.flag4j.core.TensorBase

allClose, getEntries, getRank, getShape, sameLength, sameShape, tensorEquals, totalEntries

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flag4j.core.MatrixOperationsMixin

augment, augment, mult, multTranspose, multTranspose, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

transpose

Field Details

rowIndices

public final int[] rowIndices

Row indices of the non-zero entries of the sparse matrix.

colIndices

public final int[] colIndices

Column indices of the non-zero entries of the sparse matrix.

numRows

public final int numRows

The number of rows in this matrix.

numCols

public final int numCols

The number of columns in this matrix.

Constructor Details

CooMatrix

public CooMatrix(int size)

Creates a square sparse matrix of specified size filled with zeros.

Parameters:

size - The number of rows/columns in this sparse matrix.

CooMatrix

public CooMatrix(int rows,
 int cols)

Creates a sparse matrix of specified number of rows and columns filled with zeros.

Parameters:

rows - The number of rows in this sparse matrix.

cols - The number of columns in this sparse matrix.

CooMatrix

public CooMatrix(Shape shape)

Creates a sparse matrix of specified shape filled with zeros.

Parameters:

shape - Shape of this sparse matrix.

CooMatrix

public CooMatrix(int size,
 double[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a square sparse matrix with specified non-zero entries, row indices, and column indices.

Parameters:

size - Size of the square sparse matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

CooMatrix

public CooMatrix(int rows,
 int cols,
 double[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.

Parameters:

rows - The number of rows in this sparse matrix.

cols - The number of columns in this sparse matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

CooMatrix

public CooMatrix(Shape shape,
 double[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.

Parameters:

shape - Shape of the sparse matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

CooMatrix

public CooMatrix(int size,
 int[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a square sparse matrix with specified non-zero entries, row indices, and column indices.

Parameters:

size - Size of the square matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

CooMatrix

public CooMatrix(int rows,
 int cols,
 int[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.

Parameters:

rows - The number of rows in this sparse matrix.

cols - The number of columns in this sparse matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

CooMatrix

public CooMatrix(Shape shape,
 int[] nonZeroEntries,
 int[] rowIndices,
 int[] colIndices)

Creates a sparse matrix with specified shape, non-zero entries, row indices, and column indices.

Parameters:

shape - Shape of the sparse matrix.

nonZeroEntries - Non-zero entries of sparse matrix.

rowIndices - Row indices of the non-zero entries.

colIndices - Column indices of the non-zero entries.

Throws:

IllegalArgumentException - If the number of non-zero entries does not fit within the given shape. Or, if the lengths of the non-zero entries, row indices, and column indices arrays are not all the same.

CooMatrix

public CooMatrix(CooMatrix A)

Constructs a sparse tensor whose shape and values are given by another sparse tensor. This effectively copies the tensor.

Parameters:

A - Sparse Matrix to copy.

CooMatrix

public CooMatrix(Shape shape,
 List<Double> entries,
 List<Integer> rowIndices,
 List<Integer> colIndices)

Creates a sparse matrix with specified shape, non-zero entries, and indices.

Parameters:

shape - Shape of the sparse matrix.

entries - Non-zero entries of the sparse matrix.

rowIndices - Non-zero row indices of the sparse matrix.

colIndices - Non-zero column indices of the sparse matrix.

Method Details

equals

public boolean equals(Object object)

Checks if an object is equal to this sparse COO matrix.

Specified by:

equals in interface TensorComparisonsMixin

Overrides:

equals in class Object

Parameters:

object - Object to compare this sparse COO matrix to.

Returns:

True if the object is a CooMatrix, has the same shape as this matrix, and is element-wise equal to this matrix.

fromDense

public static CooMatrix fromDense(Matrix src)

Constructs a sparse COO matrix from a dense matrix. Any value that is not exactly zero will be considered a non-zero value.

Parameters:

src - Dense matrix to convert to sparse COO matrix.

Returns:

An sparse COO matrix equivalent to the dense src matrix.

numRows

public int numRows()

Gets the number of rows in this matrix.

Specified by:

numRows in interface MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The number of rows in this matrix.

numCols

public int numCols()

Gets the number of columns in this matrix.

Specified by:

numCols in interface MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The number of columns in this matrix.

shape

public Shape shape()

Gets the shape of this matrix.

Specified by:

shape in interface MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The shape of this matrix.

toCsr

public CsrMatrix toCsr()

Converts this COO matrix to an equivalent CSR matrix.

Returns:

An equivalent sparse CSR Matrix.

add

public CooMatrix add(CooMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

add in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

B - Second tensor in the addition.

Returns:

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

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

add

public CooMatrix add(CsrMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix add(CsrCMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix add(double a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

add

public CMatrix add(CNumber a)

Adds specified value to all entries of this tensor.

Specified by:

add in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

public CooMatrix sub(CooMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

sub in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

B - Second tensor in element-wise subtraction.

Returns:

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

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

sub

public CooMatrix sub(CsrMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix sub(CsrCMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix sub(double a)

Adds specified value to all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

a - Value to add to all entries of this tensor.

Returns:

The result of adding the specified value to each entry of this tensor.

sub

public CMatrix sub(CNumber a)

Subtracts a specified value from all entries of this tensor.

Specified by:

sub in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

a - Value to subtract from all entries of this tensor.

Returns:

The result of subtracting the specified value from each entry of this tensor.

T

public CooMatrix T()

Computes the transpose of a tensor. Same as TensorOperationsMixin.transpose().

Specified by:

T in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Returns:

The transpose of this tensor.

get

public Double get(int... indices)

Gets the element in this tensor at the specified indices.

Specified by:

get in interface MatrixMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

get in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

indices - Indices of element.

Returns:

The element at the specified indices.

Throws:

IllegalArgumentException - If the number of indices does not match the rank of this tensor.

copy

public CooMatrix copy()

Creates a copy of this tensor.

Specified by:

copy in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

copy in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Returns:

A copy of this tensor.

elemMult

public CooMatrix elemMult(CooMatrix B)

Computes the element-wise multiplication between two tensors.

Specified by:

elemMult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

elemMult in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

B - Tensor to element-wise multiply to this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If this tensor and B do not have the same shape.

elemDiv

public CooMatrix elemDiv(Matrix B)

Computes the element-wise division between two tensors.

Specified by:

elemDiv in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Specified by:

elemDiv in interface TensorOperationsMixin<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,Double>

Parameters:

B - Tensor to element-wise divide with this tensor.

Returns:

The result of the element-wise tensor multiplication.

Throws:

IllegalArgumentException - If this tensor and B do not have the same shape.

makeTensor

protected CooMatrix makeTensor(Shape shape,
 double[] entries,
 int[][] indices)

A factory for creating a real sparse tensor.

Specified by:

makeTensor in class RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>

Parameters:

shape - Shape of the sparse tensor to make.

entries - Non-zero entries of the sparse tensor to make.

indices - Non-zero indices of the sparse tensor to make.

Returns:

A tensor created from the specified parameters.

makeDenseTensor

protected Matrix makeDenseTensor(Shape shape,
 double[] entries)

A factory for creating a real dense tensor.

Specified by:

makeDenseTensor in class RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the dense tensor to make.

Returns:

A tensor created from the specified parameters.

makeComplexTensor

protected CooCMatrix makeComplexTensor(Shape shape,
 CNumber[] entries,
 int[][] indices)

A factory for creating a complex sparse tensor.

Specified by:

makeComplexTensor in class RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>

Parameters:

shape - Shape of the tensor to make.

entries - Non-zero entries of the sparse tensor to make.

indices - Non-zero indices of the sparse tensor to make.

Returns:

A tensor created from the specified parameters.

sortIndices

public void sortIndices()

Sorts the indices of this tensor in lexicographical order while maintaining the associated value for each index.

Specified by:

sortIndices in interface SparseTensorMixin

Overrides:

sortIndices in class RealSparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix>

toDense

public Matrix toDense()

Converts this sparse tensor to an equivalent dense tensor.

Specified by:

toDense in class SparseTensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,double[],Double>

Returns:

A dense tensor which is equivalent to this sparse tensor.

isI

public boolean isI()

Checks if this matrix is the identity matrix.

Specified by:

isI in interface MatrixComparisonsMixin<CooMatrix>

Returns:

True if this matrix is the identity matrix. Otherwise, returns false.

set

public CooMatrix set(double value,
 int row,
 int col)

Sets an index of this matrix to the specified value. For sparse matrices, a new copy of this matrix with the specified value set will be returned.

Specified by:

set in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A copy of this matrix with the specified value set.

set

public CooMatrix set(Double value,
 int row,
 int col)

Sets an index of this matrix to the specified value.

Specified by:

set in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

setCol

public CooMatrix setCol(Double[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Specified by:

setCol in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

public CooMatrix setCol(Integer[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Specified by:

setCol in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

public CooMatrix setCol(double[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Specified by:

setCol in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

public CooMatrix setCol(Vector values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

public CooMatrix setCol(int[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Specified by:

setCol in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setRow

public CooMatrix setRow(Double[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Specified by:

setRow in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

public CooMatrix setRow(Integer[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Specified by:

setRow in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A copy of this matrix with the specified row set.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

public CooMatrix setRow(double[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Specified by:

setRow in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A copy of this matrix with the specified row set.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

public CooMatrix setRow(int[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Specified by:

setRow in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A copy of this matrix with the specified row set.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setSlice

public CooMatrix setSlice(CooMatrix values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSlice

public CooMatrix setSlice(Double[][] values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSlice

public CooMatrix setSlice(Integer[][] values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSlice

public CooMatrix setSlice(double[][] values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSlice

public CooMatrix setSlice(int[][] values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

removeRow

public CooMatrix removeRow(int rowIndex)

Removes a specified row from this matrix.

Specified by:

removeRow in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

rowIndex - Index of the row to remove from this matrix.

Returns:

A copy of this matrix with the specified row removed.

removeRows

public CooMatrix removeRows(int... rowIndices)

Removes a specified set of rows from this matrix.

Specified by:

removeRows in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

rowIndices - The indices of the rows to remove from this matrix. The indices must be sorted and unique otherwise the behavior of this method is undefined. Arrays.sort(rowIndices) must be called first if the array is not already sorted.

Returns:

A copy of this matrix with the specified rows removed.

removeCol

public CooMatrix removeCol(int colIndex)

Removes a specified column from this matrix.

Specified by:

removeCol in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

colIndex - Index of the column to remove from this matrix.

Returns:

A copy of this matrix with the specified column removed.

removeCols

public CooMatrix removeCols(int... colIndices)

Removes a specified set of columns from this matrix.

Specified by:

removeCols in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

colIndices - Indices of the columns to remove from this matrix.

Returns:

A copy of this matrix with the specified columns removed.

swapRows

public CooMatrix swapRows(int rowIndex1,
 int rowIndex2)

Swaps rows in the matrix.

Specified by:

swapRows in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

rowIndex1 - Index of first row to swap.

rowIndex2 - index of second row to swap.

Returns:

A reference to this matrix.

swapCols

public CooMatrix swapCols(int colIndex1,
 int colIndex2)

Swaps columns in the matrix.

Specified by:

swapCols in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

colIndex1 - Index of first column to swap.

colIndex2 - index of second column to swap.

Returns:

A reference to this matrix.

setSlice

public CooMatrix setSlice(Matrix values,
 int rowStart,
 int colStart)

Sets a slice of this matrix to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Specified by:

setSlice in interface MatrixManipulationsMixin<CooMatrix,Double>

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A reference to this matrix.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

add

public Matrix add(Matrix B)

Computes the element-wise addition between two matrices.

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix add(CMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix add(CooCMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix sub(Matrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix sub(CMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix sub(CooCMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix mult(Matrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Vector mult(CooVector b)

Description copied from interface: MatrixOperationsMixin

Computes the matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Parameters:

b - Vector to multiply this matrix to.

Returns:

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

mult

public CVector mult(CVector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CVector mult(CooCVector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix 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()).

Specified by:

multTranspose in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix 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()).

Specified by:

multTranspose in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public 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()).

Specified by:

multTranspose in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public 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()).

Specified by:

multTranspose in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix 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 may be significantly faster for large matrices as it will not make superfluous copies.

Specified by:

pow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Parameters:

exponent - The exponent in the matrix power. If exponent = 0 then the identity matrix will be returned.

Returns:

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

Throws:

IllegalArgumentException - If exponent is negative.

IllegalArgumentException - If this sparse matrix is not square.

elemMult

public CooMatrix elemMult(Matrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix elemMult(CMatrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix elemMult(CooCMatrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix elemDiv(CMatrix B)

Computes the element-wise division between two matrices.

Specified by:

elemDiv in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Double det()

Computes the determinant of a square matrix.

WARNING: Currently, this method will convert this matrix to a dense matrix.

Specified by:

det in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The determinant of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

fib

public Double fib(Matrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Double fib(CooMatrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CNumber fib(CMatrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CNumber fib(CooCMatrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Vector sumCols()

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

Specified by:

sumCols in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public Vector sumRows()

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

Specified by:

sumRows in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

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

Specified by:

addToEachCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

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

Specified by:

addToEachCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public 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.

Specified by:

addToEachCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public 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.

Specified by:

addToEachCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

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

Specified by:

addToEachRow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

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

Specified by:

addToEachRow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public 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.

Specified by:

addToEachRow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public 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.

Specified by:

addToEachRow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix stack(Matrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooMatrix stack(CooMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix stack(CMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix stack(CooCMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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.

augment

public Matrix augment(Matrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooMatrix augment(CooMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix augment(CMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix augment(CooCMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooMatrix stack(Vector b)

Stacks vector to this matrix along columns. Note that the vector will be treated as a row vector.
Also see MatrixOperationsMixin.stack(Vector, int) and augment(Vector).

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public CooMatrix 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 MatrixOperationsMixin.stack(CooVector, int) and augment(CooVector).

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public CooCMatrix 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 MatrixOperationsMixin.stack(CVector, int) and augment(CVector).

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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

public CooCMatrix 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 MatrixOperationsMixin.stack(CooCVector, int) and augment(CooCVector).

Specified by:

stack in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,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.

augment

public CooMatrix augment(Vector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix.
Also see stack(Vector) and MatrixOperationsMixin.stack(Vector, int).

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooMatrix augment(CooVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix.
Also see stack(CooVector) and MatrixOperationsMixin.stack(CooVector, int).

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix augment(CVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix.
Also see stack(CVector) and MatrixOperationsMixin.stack(CVector, int).

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooCMatrix augment(CooCVector b)

Augments a matrix with a vector. That is, stacks a vector along the rows to the right side of a matrix.
Also see stack(CooCVector) and MatrixOperationsMixin.stack(CooCVector, int).

Specified by:

augment in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooVector getRow(int i)

Get the row of this matrix at the specified index.

Specified by:

getRow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Parameters:

i - Index of row to get.

Returns:

The specified row of this matrix.

getCol

public CooVector getCol(int j)

Get the column of this matrix at the specified index.

Specified by:

getCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Parameters:

j - Index of column to get.

Returns:

The specified column of this matrix.

getCol

public CooVector getCol(int colIdx,
 int rowStart,
 int rowEnd)

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

Specified by:

getCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooVector 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.

Specified by:

toVector in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

A vector equivalent to this matrix.

toTensor

public CooTensor toTensor()

Converts this matrix to an equivalent sparse tensor.

Returns:

A tensor which is equivalent to this matrix.

getSlice

public CooMatrix getSlice(int rowStart,
 int rowEnd,
 int colStart,
 int colEnd)

Gets a specified slice of this matrix.

Specified by:

getSlice in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooVector getColBelow(int rowStart,
 int j)

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

Specified by:

getColBelow in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooVector getRowAfter(int colStart,
 int i)

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

Specified by:

getRowAfter in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CooMatrix setCol(CooVector values,
 int j)

Sets a column of this matrix.

Specified by:

setCol in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Double trace()

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

Specified by:

trace in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

tr

public Double tr()

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

Specified by:

tr in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

getDiag

public CooVector getDiag()

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

Specified by:

getDiag in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

A vector containing the diagonal entries of this matrix.

H

public CooMatrix H()

Compute the hermitian transpose of this matrix. That is, the complex conjugate transpose of this matrix. For real matrices, this is equivalent to the standard transpose.

Specified by:

H in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

Returns:

The complex conjugate transpose of this matrix.

mult

public Matrix mult(CooMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Matrix mult(CsrMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix mult(CMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix mult(CooCMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public CMatrix mult(CsrCMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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

public Vector mult(Vector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CooMatrix,Matrix,CooMatrix,CooCMatrix,CooCMatrix,Double,CooVector,Vector>

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.

isSquare

public boolean isSquare()

Checks if this matrix is square.

Specified by:

isSquare in interface MatrixPropertiesMixin

Returns:

True if the matrix is square (i.e. the number of rows equals the number of columns). Otherwise, returns false.

isVector

public boolean isVector()

Checks if a matrix can be represented as a vector. That is, if a matrix has only one row or one column.

Specified by:

isVector in interface MatrixPropertiesMixin

Returns:

True if this matrix can be represented as either a row or column vector.

vectorType

public int vectorType()

Checks what type of vector this matrix is. i.e. not a vector, a 1x1 matrix, a row vector, or a column vector.

Specified by:

vectorType in interface MatrixPropertiesMixin

Returns:

- If this matrix can not be represented as a vector, then returns -1.
- If this matrix is a 1x1 matrix, then returns 0.
- If this matrix is a row vector, then returns 1.
- If this matrix is a column vector, then returns 2.

isTri

public boolean isTri()

Checks if this matrix is triangular (i.e. upper triangular, diagonal, lower triangular).

Specified by:

isTri in interface MatrixPropertiesMixin

Returns:

True is this matrix is triangular. Otherwise, returns false.

isTriL

public boolean isTriL()

Checks if this matrix is lower triangular.

Specified by:

isTriL in interface MatrixPropertiesMixin

Returns:

True is this matrix is lower triangular. Otherwise, returns false.

isTriU

public boolean isTriU()

Checks if this matrix is upper triangular.

Specified by:

isTriU in interface MatrixPropertiesMixin

Returns:

True is this matrix is upper triangular. Otherwise, returns false.

isDiag

public boolean isDiag()

Checks if this matrix is diagonal.

Specified by:

isDiag in interface MatrixPropertiesMixin

Returns:

True is this matrix is diagonal. Otherwise, returns false.

isFullRank

public boolean isFullRank()

Checks if a matrix has full rank. That is, if a matrices rank is equal to the number of rows in the matrix.

WARNING: This method will convert this matrix to a dense matrix.

Specified by:

isFullRank in interface MatrixPropertiesMixin

Returns:

True if this matrix has full rank. Otherwise, returns false.

isSingular

public boolean isSingular()

Checks if a matrix is singular. That is, if the matrix is NOT invertible.

WARNING: Currently, this method will convert this matrix to a dense matrix.

Specified by:

isSingular in interface MatrixPropertiesMixin

Returns:

True if this matrix is singular. Otherwise, returns false.

See Also:

• isInvertible()

isInvertible

public boolean isInvertible()

Checks if a matrix is invertible.

Specified by:

isInvertible in interface MatrixPropertiesMixin

Returns:

True if this matrix is invertible.

See Also:

• isSingular()

matrixRank

public int matrixRank()

Computes the rank of this matrix (i.e. the dimension of the column space of this matrix). Note that here, rank is NOT the same as a tensor rank.

WARNING: This method will convert this matrix to a dense matrix.

Specified by:

matrixRank in interface MatrixPropertiesMixin

Returns:

The matrix rank of this matrix.

isSymmetric

public boolean isSymmetric()

Checks if a matrix is symmetric. That is, if the matrix is equal to its transpose.

Specified by:

isSymmetric in interface RealMatrixMixin<CooMatrix,CooCMatrix>

Returns:

True if this matrix is symmetric. Otherwise, returns false.

isAntiSymmetric

public boolean isAntiSymmetric()

Checks if a matrix is anti-symmetric. That is, if the matrix is equal to the negative of its transpose.

Specified by:

isAntiSymmetric in interface RealMatrixMixin<CooMatrix,CooCMatrix>

Returns:

True if this matrix is anti-symmetric. Otherwise, returns false.

isOrthogonal

public boolean isOrthogonal()

Checks if this matrix is orthogonal. That is, if the inverse of this matrix is equal to its transpose.

Specified by:

isOrthogonal in interface RealMatrixMixin<CooMatrix,CooCMatrix>

Returns:

True if this matrix it is orthogonal. Otherwise, returns false.

sqrtComplex

public CooCMatrix sqrtComplex()

Computes the complex element-wise square root of a tensor.

Specified by:

sqrtComplex in interface RealMatrixMixin<CooMatrix,CooCMatrix>

Returns:

The result of applying an element-wise square root to this tensor. Note, this method will compute the principle square root i.e. the square root with positive real part.

toComplex

public CooCMatrix toComplex()

Converts this tensor to an equivalent complex tensor. That is, the entries of the resultant matrix will be exactly the same value but will have type CNumber rather than Double.

Specified by:

toComplex in interface RealTensorMixin<CooMatrix,CooCMatrix>

Returns:

A complex matrix which is equivalent to this matrix.

getSelf

protected CooMatrix getSelf()

Simply returns a reference of this tensor.

Specified by:

getSelf in class TensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,double[],Double>

Returns:

A reference to this tensor.

allClose

public boolean allClose(CooMatrix tensor,
 double relTol,
 double absTol)

Description copied from class: TensorBase

Checks if all entries of this tensor are close to the entries of the argument tensor.

Specified by:

allClose in class TensorBase<CooMatrix,Matrix,CooCMatrix,CMatrix,CooMatrix,double[],Double>

Parameters:

tensor - Tensor to compare this tensor to.

relTol - Relative tolerance.

absTol - Absolute tolerance.

Returns:

True if the argument tensor is the same shape as this tensor and all entries are 'close', i.e. elements a and b at the same positions in the two tensors respectively satisfy |a-b| <= (atol + rtol*|b|). Otherwise, returns false.

See Also:

• TensorBase.allClose(Object)

set

public CooMatrix set(double value,
 int... indices)

Sets an index of this tensor to a specified value. Note: Unlike with dense matrices, this will return a new copy of the sparse matrix.

Specified by:

set in interface TensorManipulationsMixin<CooMatrix>

Parameters:

value - Value to set.

indices - The indices of this tensor for which to set the value.

Returns:

A copy of this matrix with the specified value set.

Throws:

IllegalArgumentException - If there are not exactly two indices provided.

reshape

public CooMatrix reshape(Shape newShape)

Copies and reshapes matrix if possible. The total number of entries in this matrix must match the total number of entries in the reshaped matrix.

Specified by:

reshape in interface TensorManipulationsMixin<CooMatrix>

Parameters:

newShape - Shape of the new matrix.

Returns:

A matrix which is equivalent to this matrix but with the specified shape.

Throws:

IllegalArgumentException - If this matrix cannot be reshaped to the specified dimensions.

flatten

public CooMatrix flatten()

Flattens tensor to single dimension. To flatten tensor along a single axis.

Specified by:

flatten in interface TensorManipulationsMixin<CooMatrix>

Returns:

The flattened tensor.

flatten

public CooMatrix flatten(int axis)

Flattens a tensor along the specified axis.

Specified by:

flatten in interface TensorManipulationsMixin<CooMatrix>

Parameters:

axis - Axis along which to flatten tensor.

Throws:

IllegalArgumentException - If the axis is not positive or larger than the rank of this tensor.

toString

public String toString()

Formats this sparse matrix as a human-readable string.

Overrides:

toString in class Object

Returns:

A human-readable string representing this sparse matrix.