Package org.flag4j.arrays.dense

Class Matrix

java.lang.Object

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

org.flag4j.core.dense_base.DenseTensorBase<Matrix,CMatrix,Matrix,double[],Double>

org.flag4j.core.dense_base.RealDenseTensorBase<Matrix,CMatrix>

org.flag4j.arrays.dense.Matrix

All Implemented Interfaces:

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

public class Matrix
extends RealDenseTensorBase<Matrix,CMatrix>
implements MatrixMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,Vector>, RealMatrixMixin<Matrix,CMatrix>, DenseMatrixMixin<Matrix,Double>

Real dense matrix. Stored in row major format. This class is mostly equivalent to a real dense tensor. However, specialized methods are provided for this class which may result in slightly better performance than equivalent operations with a real dense tensor of rank 2. Additionally, methods specific to matrices which may not be available for tensors are provided.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int	numCols	The number of columns in this matrix.
final int	numRows	The number of rows in this matrix.

Fields inherited from class org.flag4j.core.TensorBase

DEFAULT_ROUND_TO_ZERO_THRESHOLD, entries, shape

Constructor Summary

Constructors

Constructor	Description
Matrix(double[][] entries)	Creates a real dense matrix whose entries are specified by a double array.
Matrix(int size)	Constructs a square real dense matrix of a specified size.
Matrix(int[][] entries)	Creates a real dense matrix whose entries are specified by a double array.
Matrix(int size, double value)	Creates a square real dense matrix with a specified fill value.
Matrix(int rows, int cols)	Creates a real dense matrix of a specified shape filled with zeros.
Matrix(int rows, int cols, double value)	Creates a real dense matrix with a specified shape and fills the matrix with the specified value.
Matrix(int numRows, int numCols, double[] entries)	Constructs a matrix with specified shape and entries.
Matrix(Double[][] entries)	Creates a real dense matrix whose entries are specified by a double array.
Matrix(Integer[][] entries)	Creates a real dense matrix whose entries are specified by a double array.
Matrix(Matrix A)	Creates a real dense matrix which is a copy of a specified matrix.
Matrix(Shape shape)	Creates a real dense matrix with specified shape filled with zeros.
Matrix(Shape shape, double value)	Creates a real dense matrix with specified shape filled with a specific value.
Matrix(Shape shape, double[] entries)	Constructs a matrix with specified shape and entries.

Method Summary

Modifier and Type	Method	Description
CMatrix	add(CMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CMatrix	add(CooCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
Matrix	add(CooMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CMatrix	add(CsrCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
Matrix	add(CsrMatrix B)	Computes the element-wise addition between two tensors of the same rank.
void	addEq(CooMatrix B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in 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.
CMatrix	augment(CMatrix B)	Stacks matrices along rows.
CMatrix	augment(CVector b)	Augments a matrix with a vector.
Matrix	augment(Matrix B)	Stacks matrices along rows.
Matrix	augment(Vector b)	Augments a matrix with a vector.
CMatrix	augment(CooCMatrix B)	Stacks matrices along rows.
CMatrix	augment(CooCVector b)	Augments a matrix with a vector.
Matrix	augment(CooMatrix B)	Stacks matrices along rows.
Matrix	augment(CooVector b)	Augments a matrix with a vector.
Double	det()	Computes the determinant of a square matrix.
CMatrix	elemDiv(CMatrix B)	Computes the element-wise division between two matrices.
CMatrix	elemMult(CMatrix 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 (Hadamard product) between two matrices.
boolean	equals(Object object)	Checks if an object is equal to this matrix object.
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.
Matrix	flatten()	Flattens a matrix to have a single row.
Matrix	flatten(int axis)	Flattens a matrix along a specified axis.
Double	get(int... indices)	Gets the element in this tensor at the specified indices.
Vector	getCol(int colIdx)	Get the column of this matrix at the specified index.
Vector	getCol(int colIdx, int rowStart, int rowEnd)	Gets a specified column of this matrix between rowStart (inclusive) and rowEnd (exclusive).
Vector	getColAsVector(int colIdx)	Get the column of this matrix at the specified index.
Vector	getColBelow(int rowStart, int colIdx)	Get a specified column of this matrix at and below a specified row.
Vector	getDiag()	Extracts the diagonal elements of this matrix and returns them as a vector.
Vector	getRow(int rowIdx)	Get the row of this matrix at the specified index.
Vector	getRowAfter(int colStart, int rowIdx)	Get a specified row of this matrix at and after a specified column.
Vector	getRowAsVector(int rowIdx)	Get the row of this matrix at the specified index.
protected Matrix	getSelf()	Simply returns this tensor.
Matrix	getSlice(int rowStart, int rowEnd, int colStart, int colEnd)	Gets a specified slice of this matrix.
Matrix	H()	Compute the transpose of this matrix.
static Matrix	I(int size)	Constructs an identity matrix of the specified size.
static Matrix	I(int numRows, int numCols)	Constructs an identity-like matrix of the specified shape.
static Matrix	I(Shape shape)	Constructs an identity-like matrix of the specified shape.
boolean	isAntiSymmetric()	Checks if a matrix is anti-symmetric.
boolean	isCloseToI()	Checks that this matrix is close to the identity matrix according to RealProperties.allClose(double[], double[])
boolean	isFullRank()	Checks if a matrix has full rank.
boolean	isI()	Checks if this matrix is the identity matrix.
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	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 CMatrix	makeComplexTensor(Shape shape, double[] entries)	Factory to create a complex tensor with the specified shape and size.
protected CMatrix	makeComplexTensor(Shape shape, CNumber[] entries)	Factory to create a complex tensor with the specified shape and size.
protected Matrix	makeTensor(Shape shape, double[] entries)	Factory to create a tensor with the specified shape and size.
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 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.
Matrix	removeCol(int colIndex)	Removes a specified column from this matrix.
Matrix	removeCols(int... colIndices)	Removes a specified set of columns from this matrix.
Matrix	removeRow(int rowIndex)	Removes a specified row from this matrix.
Matrix	removeRows(int... rowIndices)	Removes a specified set of rows from this matrix.
private String	rowToString(int i, int colStopIndex, List<Integer> maxList)	Gets row of matrix formatted as a human-readable String.
Matrix	set(double value, int row, int col)	Sets an index of this matrix to the specified value.
Matrix	set(Double value, int row, int col)	Sets an index of this matrix to the specified value.
Matrix	setCol(double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setCol(int[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setCol(Double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setCol(Integer[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setCol(Vector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setCol(CooVector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
Matrix	setRow(double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
Matrix	setRow(int[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
Matrix	setRow(Double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
Matrix	setRow(Integer[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
Matrix	setSlice(double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSlice(int[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSlice(Double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSlice(Integer[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSlice(Matrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSlice(CooMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
Matrix	setSliceCopy(double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setSliceCopy(int[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setSliceCopy(Double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setSliceCopy(Integer[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setSliceCopy(Matrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setSliceCopy(CooMatrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
Matrix	setValues(double[][] values)	Sets the value of this matrix using a 2D array.
Matrix	setValues(int[][] values)	Sets the value of this matrix using a 2D array.
Matrix	setValues(Double[][] values)	Sets the value of this matrix using a 2D array.
Matrix	setValues(Integer[][] values)	Sets the value of this matrix using a 2D array.
Shape	shape()	Gets the shape of this matrix.
CMatrix	sqrtComplex()	Computes the complex element-wise square root of a tensor.
CMatrix	stack(CMatrix B)	Stacks matrices along columns.
CMatrix	stack(CVector b)	Stacks vector to this matrix along columns.
Matrix	stack(Matrix B)	Stacks matrices along columns.
Matrix	stack(Vector b)	Stacks vector to this matrix along columns.
CMatrix	stack(CooCMatrix B)	Stacks matrices along columns.
CMatrix	stack(CooCVector b)	Stacks vector to this matrix along columns.
Matrix	stack(CooMatrix B)	Stacks matrices along columns.
Matrix	stack(CooVector b)	Stacks vector to this matrix along columns.
CMatrix	sub(CMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CMatrix	sub(CooCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
Matrix	sub(CooMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
CMatrix	sub(CsrCMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
Matrix	sub(CsrMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
void	subEq(CooMatrix B)	Computes the element-wise subtraction of two tensors of the same rank and stores the result in 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.
Matrix	swapCols(int colIndex1, int colIndex2)	Swaps specified columns in the matrix.
Matrix	swapRows(int rowIndex1, int rowIndex2)	Swaps specified rows in the matrix.
Matrix	T()	Computes the transpose of a tensor.
CooMatrix	toCoo()	Converts this matrix to a sparse COO matrix.
CsrMatrix	toCsr()	Converts this matrix to an equivalent sparse CSR matrix.
String	toString()	Formats matrix contents as a human-readable String.
Tensor	toTensor()	Converts this matrix to an equivalent complex tensor.
Vector	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.dense_base.RealDenseTensorBase

abs, add, add, add, addEq, addEq, allClose, argMax, argMin, copy, div, div, elemDiv, elemMult, hashCode, isNeg, isOnes, isPos, isZeros, max, maxAbs, min, minAbs, mult, mult, recip, reshape, reshape, round, round, roundToZero, roundToZero, set, sqrt, sub, sub, sub, subEq, subEq, sum, toComplex

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, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flag4j.core.dense_base.DenseMatrixMixin

addEq, subEq

Methods inherited from interface org.flag4j.core.MatrixOperationsMixin

add, augment, augment, copy, elemDiv, elemMult, mult, multTranspose, multTranspose, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, stack, sub

Methods inherited from interface org.flag4j.core.MatrixPropertiesMixin

isDiag, isInvertible, isTri

Methods inherited from interface org.flag4j.core.TensorOperationsMixin

transpose

Field Details

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

Matrix

public Matrix(int size)

Constructs a square real dense matrix of a specified size. The entries of the matrix will default to zero.

Parameters:

size - Size of the square matrix.

Throws:

IllegalArgumentException - if size negative.

Matrix

public Matrix(int size,
 double value)

Creates a square real dense matrix with a specified fill value.

Parameters:

size - Size of the square matrix.

value - Value to fill this matrix with.

Throws:

IllegalArgumentException - if size negative.

Matrix

public Matrix(int rows,
 int cols)

Creates a real dense matrix of a specified shape filled with zeros.

Parameters:

rows - The number of rows in the matrix.

cols - The number of columns in the matrix.

Throws:

IllegalArgumentException - if either m or n is negative.

Matrix

public Matrix(int rows,
 int cols,
 double value)

Creates a real dense matrix with a specified shape and fills the matrix with the specified value.

Parameters:

rows - Number of rows in the matrix.

cols - Number of columns in the matrix.

value - Value to fill this matrix with.

Throws:

IllegalArgumentException - if either m or n is negative.

Matrix

public Matrix(Double[][] entries)

Creates a real dense matrix whose entries are specified by a double array.

Parameters:

entries - Entries of the real dense matrix.

Matrix

public Matrix(Integer[][] entries)

Creates a real dense matrix whose entries are specified by a double array.

Parameters:

entries - Entries of the real dense matrix.

Matrix

public Matrix(double[][] entries)

Creates a real dense matrix whose entries are specified by a double array.

Parameters:

entries - Entries of the real dense matrix.

Matrix

public Matrix(int[][] entries)

Creates a real dense matrix whose entries are specified by a double array.

Parameters:

entries - Entries of the real dense matrix.

Matrix

public Matrix(Matrix A)

Creates a real dense matrix which is a copy of a specified matrix.

Parameters:

A - The matrix defining the entries for this matrix.

Matrix

public Matrix(Shape shape)

Creates a real dense matrix with specified shape filled with zeros.

Parameters:

shape - Shape of matrix.

Throws:

IllegalArgumentException - If the shape is not of rank 2.

Matrix

public Matrix(Shape shape,
 double value)

Creates a real dense matrix with specified shape filled with a specific value.

Parameters:

shape - Shape of matrix.

value - Value to fill matrix with.

Throws:

IllegalArgumentException - If the shape is not of rank 2.

Matrix

public Matrix(Shape shape,
 double[] entries)

Constructs a matrix with specified shape and entries. Note, unlike other constructors, the entries' parameter is not copied.

Parameters:

shape - Shape of the matrix

entries - Entries of the matrix.

Throws:

IllegalArgumentException - If the shape is not of rank 2.

Matrix

public Matrix(int numRows,
 int numCols,
 double[] entries)

Constructs a matrix with specified shape and entries. Note, unlike other constructors, the entries' parameter is not copied.

Parameters:

numRows - Number of rows in this matrix.

numCols - Number of columns in this matrix.

entries - Entries of the matrix.

Method Details

makeTensor

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

Factory to create a tensor with the specified shape and size.

Specified by:

makeTensor in class DenseTensorBase<Matrix,CMatrix,Matrix,double[],Double>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

makeComplexTensor

protected CMatrix makeComplexTensor(Shape shape,
 double[] entries)

Factory to create a complex tensor with the specified shape and size.

Specified by:

makeComplexTensor in class RealDenseTensorBase<Matrix,CMatrix>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

makeComplexTensor

protected CMatrix makeComplexTensor(Shape shape,
 CNumber[] entries)

Factory to create a complex tensor with the specified shape and size.

Specified by:

makeComplexTensor in class RealDenseTensorBase<Matrix,CMatrix>

Parameters:

shape - Shape of the tensor to make.

entries - Entries of the tensor to make.

Returns:

A new tensor with the specified shape and entries.

getSelf

protected Matrix getSelf()

Simply returns this tensor.

Specified by:

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

Returns:

A reference to this tensor.

numRows

public int numRows()

Gets the number of rows in this matrix.

Specified by:

numRows in interface MatrixMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,Vector>

Returns:

The shape of this matrix.

toTensor

public Tensor toTensor()

Converts this matrix to an equivalent complex tensor.

Returns:

A tensor which is equivalent to this matrix.

toVector

public Vector 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,Vector>

Returns:

A vector equivalent to this matrix.

toCoo

public CooMatrix toCoo()

Converts this matrix to a sparse COO matrix.

Specified by:

toCoo in class DenseTensorBase<Matrix,CMatrix,Matrix,double[],Double>

Returns:

A sparse coo matrix equivalent to this matrix.

See Also:

• toCsr()

toCsr

public CsrMatrix toCsr()

Converts this matrix to an equivalent sparse CSR matrix.

Returns:

A sparse coo matrix equivalent to this matrix.

See Also:

• toCoo()

isI

public boolean isI()

Checks if this matrix is the identity matrix. That is, checks if this matrix is square and contains only ones along the principle diagonal and zeros everywhere else.

Specified by:

isI in interface MatrixComparisonsMixin<Matrix>

Returns:

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

See Also:

• isCloseToI()

isCloseToI

public boolean isCloseToI()

Checks that this matrix is close to the identity matrix according to RealProperties.allClose(double[], double[])

Returns:

True if this matrix is approximately the identity matrix.

See Also:

• isI()

equals

public boolean equals(Object object)

Checks if an object is equal to this matrix object.

Specified by:

equals in interface TensorComparisonsMixin

Overrides:

equals in class Object

Parameters:

object - Object to check equality with this matrix.

Returns:

True if the two matrices have the same shape, are numerically equivalent, and are of type Matrix. False otherwise.

flatten

public Matrix flatten()

Flattens a matrix to have a single row. To flatten matrix to a single column, see flatten(int).

Specified by:

flatten in interface TensorManipulationsMixin<Matrix>

Returns:

The flat version of this matrix.

flatten

public Matrix flatten(int axis)

Flattens a matrix along a specified axis. Also see flatten().

Specified by:

flatten in interface TensorManipulationsMixin<Matrix>

Parameters:

axis - - If axis=0, flattens to a row vector.
- If axis=1, flattens to a column vector.

Returns:

The flat version of this matrix.

set

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

Sets an index of this matrix to the specified value.

Specified by:

set in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

set

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

Sets an index of this matrix to the specified value.

Specified by:

set in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

setValues

public Matrix setValues(Double[][] values)

Sets the value of this matrix using a 2D array.

Specified by:

setValues in interface DenseMatrixMixin<Matrix,Double>

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

public Matrix setValues(double[][] values)

Sets the value of this matrix using a 2D array.

Specified by:

setValues in interface DenseMatrixMixin<Matrix,Double>

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

public Matrix setValues(Integer[][] values)

Sets the value of this matrix using a 2D array.

Parameters:

values - New values of the matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

public Matrix setValues(int[][] values)

Sets the value of this matrix using a 2D array.

Specified by:

setValues in interface DenseMatrixMixin<Matrix,Double>

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setCol

public Matrix 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<Matrix,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 Matrix 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<Matrix,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 Matrix 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<Matrix,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 Matrix 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<Matrix,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 Matrix setCol(Vector values,
 int colIndex)

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

Specified by:

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

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 vector has a different length than the number of rows of this matrix.

setCol

public Matrix setCol(CooVector values,
 int colIndex)

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

Parameters:

values - New values for the column. This method assumes that the indices of the sparse vector are sorted. If this is not the case, call CooVector.sortIndices() first.

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

Returns:

A reference to this matrix.

Throws:

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

setRow

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

getSlice

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

Gets a specified slice of this matrix.

Specified by:

getSlice in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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.

setSlice

public Matrix 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 within this matrix.

Specified by:

setSlice in interface MatrixManipulationsMixin<Matrix,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:

IllegalArgumentException - 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 Matrix 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<Matrix,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:

IllegalArgumentException - 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 Matrix 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<Matrix,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:

IllegalArgumentException - 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 Matrix 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<Matrix,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:

IllegalArgumentException - 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 Matrix 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<Matrix,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:

IllegalArgumentException - 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 Matrix 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<Matrix,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:

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

setSliceCopy

public Matrix setSliceCopy(Matrix values,
 int rowStart,
 int colStart)

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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.

setSliceCopy

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

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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.

setSliceCopy

public Matrix setSliceCopy(Double[][] values,
 int rowStart,
 int colStart)

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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.

setSliceCopy

public Matrix setSliceCopy(Integer[][] values,
 int rowStart,
 int colStart)

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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.

setSliceCopy

public Matrix setSliceCopy(double[][] values,
 int rowStart,
 int colStart)

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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.

setSliceCopy

public Matrix setSliceCopy(int[][] values,
 int rowStart,
 int colStart)

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

Specified by:

setSliceCopy in interface DenseMatrixMixin<Matrix,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 copy of this matrix with the given slice set to the specified values.

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 Matrix removeRow(int rowIndex)

Removes a specified row from this matrix.

Specified by:

removeRow in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

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

Returns:

A copy of this matrix with the specified column removed.

removeRows

public Matrix removeRows(int... rowIndices)

Removes a specified set of rows from this matrix.

Specified by:

removeRows in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

rowIndices - The indices of the rows to remove from this matrix. Assumed to contain unique values.

Returns:

a copy of this matrix with the specified column removed.

removeCol

public Matrix removeCol(int colIndex)

Removes a specified column from this matrix.

Specified by:

removeCol in interface MatrixManipulationsMixin<Matrix,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 Matrix removeCols(int... colIndices)

Removes a specified set of columns from this matrix.

Specified by:

removeCols in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

colIndices - Indices of the columns to remove from this matrix. Assumed to contain unique values.

Returns:

a copy of this matrix with the specified column removed.

add

public Matrix add(CooMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CsrMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix add(CsrCMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix add(CMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix add(CooCMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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.

subEq

public void subEq(CooMatrix B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Specified by:

subEq in interface DenseMatrixMixin<Matrix,Double>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

addEq

public void addEq(CooMatrix B)

Computes the element-wise subtraction of two tensors of the same rank and stores the result in this tensor.

Specified by:

addEq in interface DenseMatrixMixin<Matrix,Double>

Parameters:

B - Second tensor in the subtraction.

Throws:

IllegalArgumentException - If this tensor and B have different shapes.

T

public Matrix T()

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

Specified by:

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

Returns:

The transpose of this tensor.

sub

public Matrix sub(CooMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CsrMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CsrCMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CooCMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CooMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Vector mult(CooVector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CVector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 will be significantly faster.

Specified by:

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

Parameters:

exponent - The exponent in the matrix power.

Returns:

The result of multiplying this matrix with itself 'exponent' times. If the exponent is zero, then the identity matrix is returned.

Throws:

IllegalArgumentException - If this matrix is not square or if exponent is negative.

elemMult

public CooMatrix elemMult(CooMatrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix elemMult(CMatrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix elemDiv(CMatrix B)

Computes the element-wise division between two matrices.

Specified by:

elemDiv in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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.

Specified by:

det in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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.

Throws:

IllegalArgumentException - If the vector has a different number of entries as rows in the 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix stack(CooMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CooCMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix augment(CooMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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(CooCMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix 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 MatrixOperationsMixin.stack(Vector, int) and augment(Vector).

Specified by:

stack in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix 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 MatrixOperationsMixin.stack(Vector, int).

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Matrix 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 MatrixOperationsMixin.stack(CooVector, int).

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix 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 MatrixOperationsMixin.stack(CVector, int).

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 CMatrix 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 MatrixOperationsMixin.stack(CooCVector, int).

Specified by:

augment in interface MatrixOperationsMixin<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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 Vector getRow(int rowIdx)

Get the row of this matrix at the specified index.

Specified by:

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

Parameters:

rowIdx - Index of row to get.

Returns:

The specified row of this matrix.

Throws:

ArrayIndexOutOfBoundsException - If rowIdx is less than zero or greater than/equal to the number of rows in this matrix.

getRowAsVector

public Vector getRowAsVector(int rowIdx)

Get the row of this matrix at the specified index.

Parameters:

rowIdx - Index of row to get.

Returns:

The specified row of this matrix as a vector.

Throws:

ArrayIndexOutOfBoundsException - If rowIdx is less than zero or greater than/equal to the number of rows in this matrix.

getCol

public Vector getCol(int colIdx)

Get the column of this matrix at the specified index.

Specified by:

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

Parameters:

colIdx - Index of column to get.

Returns:

The specified column of this matrix.

Throws:

ArrayIndexOutOfBoundsException - If colIdx is less than zero or greater than/equal to the number of columns in this matrix.

getColBelow

public Vector getColBelow(int rowStart,
 int colIdx)

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

Specified by:

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

Parameters:

rowStart - Index of the row to begin at.

colIdx - 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 colIdx is outside the bounds of this matrix.

getCol

public Vector 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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.

getRowAfter

public Vector getRowAfter(int colStart,
 int rowIdx)

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

Specified by:

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

Parameters:

colStart - Index of the row to begin at.

rowIdx - 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 rowIdx or colStart is outside the bounds of this matrix.

getColAsVector

public Vector getColAsVector(int colIdx)

Get the column of this matrix at the specified index.

Parameters:

colIdx - Index of column to get.

Returns:

The specified column of this matrix as a vector.

Throws:

ArrayIndexOutOfBoundsException - If colIdx is less than zero or greater than/equal to the number of rows in 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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,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<Matrix,Matrix,CooMatrix,CMatrix,CooCMatrix,Double,Vector,Vector>

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

getDiag

public Vector getDiag()

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

Specified by:

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

Returns:

A vector containing the diagonal entries of this matrix.

H

public Matrix H()

Compute the transpose of this matrix. That is, the complex conjugate transpose of this matrix. Since this is a real matrix, this is equivalent to the standard transpose.

Specified by:

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

Returns:

The conjugate transpose of this matrix.

I

public static Matrix I(int size)

Constructs an identity matrix of the specified size.

Parameters:

size - Size of the identity matrix.

Returns:

An identity matrix of specified size.

Throws:

IllegalArgumentException - If the specified size is less than 1.

See Also:

• I(Shape)
• I(int, int)

I

public static Matrix I(int numRows,
 int numCols)

Constructs an identity-like matrix of the specified shape. That is, a matrix of zeros with ones along the principle diagonal.

Parameters:

numRows - Number of rows in the identity-like matrix.

numCols - Number of columns in the identity-like matrix.

Returns:

An identity matrix of specified shape.

Throws:

IllegalArgumentException - If the specified number of rows or columns is less than 1.

See Also:

• I(int)
• I(Shape)

I

public static Matrix I(Shape shape)

Constructs an identity-like matrix of the specified shape. That is, a matrix of zeros with ones along the principle diagonal.

Parameters:

shape - Shape of the identity-like matrix.

Returns:

An identity matrix of specified size.

Throws:

IllegalArgumentException - If the specified shape is not rank 2.

See Also:

• I(int)
• I(int, int)

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.

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.

See Also:

• MatrixPropertiesMixin.isTri()
• isTriU()
• MatrixPropertiesMixin.isDiag()

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.

See Also:

• MatrixPropertiesMixin.isTri()
• isTriL()
• MatrixPropertiesMixin.isDiag()

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.

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.
Also see MatrixPropertiesMixin.isInvertible().

Specified by:

isSingular in interface MatrixPropertiesMixin

Returns:

True if this matrix is singular or non-square. Otherwise, returns false.

swapRows

public Matrix swapRows(int rowIndex1,
 int rowIndex2)

Swaps specified rows in the matrix. This is done in place.

Specified by:

swapRows in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

rowIndex1 - Index of the first row to swap.

rowIndex2 - Index of the second row to swap.

Returns:

A reference to this matrix.

Throws:

ArrayIndexOutOfBoundsException - If either index is outside the matrix bounds.

swapCols

public Matrix swapCols(int colIndex1,
 int colIndex2)

Swaps specified columns in the matrix. This is done in place.

Specified by:

swapCols in interface MatrixManipulationsMixin<Matrix,Double>

Parameters:

colIndex1 - Index of the first column to swap.

colIndex2 - Index of the second column to swap.

Returns:

A reference to this matrix.

Throws:

ArrayIndexOutOfBoundsException - If either index is outside the matrix bounds.

get

public Double get(int... indices)

Description copied from class: RealDenseTensorBase

Gets the element in this tensor at the specified indices.

Specified by:

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

Specified by:

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

Overrides:

get in class RealDenseTensorBase<Matrix,CMatrix>

Parameters:

indices - Indices of element.

Returns:

The element at the specified indices.

matrixRank

public int matrixRank()

Computes the rank of this matrix (i.e. the number of linearly independent rows/columns in this matrix). Note that here, rank is NOT the same as a tensor rank (i.e. number of indices needed to specify an entry in the tensor).

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 square and equal to its transpose.

Specified by:

isSymmetric in interface RealMatrixMixin<Matrix,CMatrix>

Returns:

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

See Also:

• isAntiSymmetric()

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<Matrix,CMatrix>

Returns:

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

See Also:

• isSymmetric()

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<Matrix,CMatrix>

Returns:

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

sqrtComplex

public CMatrix sqrtComplex()

Computes the complex element-wise square root of a tensor. That is, ff this tensor contains negative values, the resulting root will be complex rather then Double.NaN.

Specified by:

sqrtComplex in interface RealMatrixMixin<Matrix,CMatrix>

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.

rowToString

private String rowToString(int i,
 int colStopIndex,
 List<Integer> maxList)

Gets row of matrix formatted as a human-readable String. Helper method for toString() method.

Parameters:

i - Index of row to get.

colStopIndex - Stopping index for printing columns.

maxList - List of maximum string representation lengths for each column of this matrix. This is used to align columns when printing.

Returns:

A human-readable String representation of the specified row.

toString

public String toString()

Formats matrix contents as a human-readable String.

Overrides:

toString in class Object

Returns:

Matrix represented as a human-readable String