Package org.flag4j.arrays.dense

Class CMatrix

java.lang.Object

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

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

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

org.flag4j.arrays.dense.CMatrix

All Implemented Interfaces:

Serializable, ComplexMatrixMixin<CMatrix>, ComplexTensorMixin<CMatrix,Matrix>, DenseMatrixMixin<CMatrix,CNumber>, DenseMixin<CNumber>, MatrixComparisonsMixin<CMatrix>, MatrixManipulationsMixin<CMatrix,CNumber>, MatrixMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>, MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>, MatrixPropertiesMixin, TensorComparisonsMixin, TensorManipulationsMixin<CMatrix>, TensorOperationsMixin<CMatrix,CMatrix,CMatrix,CMatrix,Matrix,CNumber>, TensorPropertiesMixin

public class CMatrix
extends ComplexDenseTensorBase<CMatrix,Matrix>
implements MatrixMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>, ComplexMatrixMixin<CMatrix>, DenseMatrixMixin<CMatrix,CNumber>

Complex dense matrix. Stored in row major format. This class is mostly equivalent to a complex dense tensor. However, specialized methods are provided for this class which may result in slightly better performance than equivalent operations with a complex 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
CMatrix(double[][] entries)	Creates a complex dense matrix whose entries are specified by a double array.
CMatrix(int size)	Constructs a square complex dense matrix of a specified size.
CMatrix(int[][] entries)	Creates a complex dense matrix whose entries are specified by a double array.
CMatrix(int size, double value)	Creates a square complex dense matrix with a specified fill value.
CMatrix(int rows, int cols)	Creates a complex dense matrix of a specified shape filled with zeros.
CMatrix(int rows, int cols, double value)	Creates a complex dense matrix with a specified shape and fills the matrix with the specified value.
CMatrix(int rows, int cols, CNumber value)	Creates a complex dense matrix with a specified shape and fills the matrix with the specified value.
CMatrix(int numRows, int numCols, CNumber[] entries)	Constructs a complex matrix with specified shapes and entries.
CMatrix(int size, CNumber value)	Creates a square complex dense matrix with a specified fill value.
CMatrix(String[][] entries)	Creates a complex dense matrix whose entries are specified by a double array.
CMatrix(CMatrix A)	Creates a complex dense matrix which is a copy of a specified matrix.
CMatrix(Matrix A)	Creates a complex dense matrix which is a copy of a specified matrix.
CMatrix(CNumber[][] entries)	Creates a complex dense matrix whose entries are specified by a double array.
CMatrix(Shape shape)	Creates a complex dense matrix with specified shape.
CMatrix(Shape shape, double value)	Creates a complex dense matrix with specified shape filled with specified value.
CMatrix(Shape shape, double... entries)	Creates a complex dense matrix with specified shape filled with specified entries.
CMatrix(Shape shape, CNumber value)	Creates a complex dense matrix with specified shape filled with specified value.
CMatrix(Shape shape, CNumber... entries)	Constructs a complex matrix with specified shapes and entries.

Method Summary

Modifier and Type	Method	Description
CMatrix	add(Matrix B)	Computes the element-wise addition between two matrices.
CMatrix	add(CooCMatrix B)	Computes the element-wise addition between two tensors of the same rank.
CMatrix	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.
CMatrix	add(CsrMatrix B)	Computes the element-wise addition between two tensors of the same rank.
void	addEq(Matrix B)	Computes the element-wise addition of a matrix with a real dense matrix.
void	addEq(CooCMatrix B)	Adds a complex sparse matrix to this matrix and stores the result in this matrix.
void	addEq(CooMatrix B)	Computes the element-wise addition of a matrix with a real sparse matrix.
CMatrix	addToEachCol(CVector b)	Adds a vector to each column of a matrix.
CMatrix	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.
CMatrix	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.
CMatrix	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.
CMatrix	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.
CMatrix	augment(Matrix B)	Stacks matrices along rows.
CMatrix	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.
CMatrix	augment(CooMatrix B)	Stacks matrices along rows.
CMatrix	augment(CooVector b)	Augments a matrix with a vector.
CNumber	det()	Computes the determinant of a square matrix.
CMatrix	elemDiv(Matrix B)	Computes the element-wise division between two matrices.
CMatrix	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.
CooCMatrix	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.
CNumber	fib(Matrix B)	Computes the Frobenius inner product of two matrices.
CNumber	fib(CooCMatrix B)	Computes the Frobenius inner product of two matrices.
CNumber	fib(CooMatrix B)	Computes the Frobenius inner product of two matrices.
CMatrix	flatten()	Flattens a matrix to have a single row.
CMatrix	flatten(int axis)	Flattens a matrix along a specified axis.
CNumber	get(int... indices)	Gets the element in this tensor at the specified indices.
CVector	getCol(int j)	Get the column of this matrix at the specified index.
CVector	getCol(int colIdx, int rowStart, int rowEnd)	Gets a specified column of this matrix between rowStart (inclusive) and rowEnd (exclusive).
CVector	getColAsVector(int j)	Get the column of this matrix at the specified index.
CVector	getColBelow(int rowStart, int j)	Get a specified column of this matrix at and below a specified row.
CVector	getDiag()	Extracts the diagonal elements of this matrix and returns them as a vector.
static CMatrix	getEmpty(int rows, int cols)	Constructs an empty complex dense matrix.
CVector	getRow(int i)	Get the row of this matrix at the specified index.
CVector	getRowAfter(int colStart, int i)	Get a specified row of this matrix at and after a specified column.
CVector	getRowAsVector(int i)	Get the row of this matrix at the specified index.
protected CMatrix	getSelf()	Simply returns a reference of this tensor.
CMatrix	getSlice(int rowStart, int rowEnd, int colStart, int colEnd)	Gets a specified slice of this matrix.
CMatrix	H()	Computes the hermitian transpose (i.e.
static CMatrix	I(int size)	Constructs an identity matrix of the specified size.
static CMatrix	I(int numRows, int numCols)	Constructs an identity-like matrix of the specified shape.
static CMatrix	I(Shape shape)	Constructs an identity-like matrix of the specified shape.
boolean	isAntiHermitian()	Checks if a matrix is anti-Hermitian.
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	isHermitian()	Checks if a matrix is Hermitian.
boolean	isI()	Checks if this matrix is the identity matrix.
boolean	isSingular()	Checks if a matrix is singular.
boolean	isSquare()	Checks if this matrix is square.
boolean	isTriL()	Checks if this matrix is lower triangular.
boolean	isTriU()	Checks if this matrix is upper triangular.
boolean	isUnitary()	Checks if this matrix is unitary.
boolean	isVector()	Checks if a matrix can be represented as a vector.
protected Matrix	makeRealTensor(Shape shape, double[] entries)	Factory to create a real tensor with the specified shape and size.
protected CMatrix	makeTensor(Shape shape, CNumber... 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.
CMatrix	mult(Matrix B)	Computes the matrix multiplication between two matrices.
CVector	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.
CMatrix	mult(CooMatrix B)	Computes the matrix multiplication between two matrices.
CVector	mult(CooVector b)	Computes matrix-vector multiplication.
CMatrix	mult(CsrCMatrix B)	Computes the matrix multiplication between two matrices.
CMatrix	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()).
CMatrix	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()).
CMatrix	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.
CMatrix	pow(int exponent)	Computes the matrix power with a given exponent.
CMatrix	removeCol(int colIndex)	Removes a specified column from this matrix.
CMatrix	removeCols(int... colIndices)	Removes a specified set of columns from this matrix.
CMatrix	removeRow(int rowIndex)	Removes a specified row from this matrix.
CMatrix	removeRows(int... rowIndices)	Removes a specified set of rows from this matrix.
CMatrix	round()	Rounds this matrix to the nearest whole number.
CMatrix	round(int precision)	Rounds a matrix to the nearest whole number.
CMatrix	roundToZero()	Rounds values which are close to zero in absolute value to zero.
CMatrix	roundToZero(double threshold)	Rounds values which are close to zero in absolute value to zero.
private String	rowToString(int i, int colStopIndex, List<Integer> maxList)	Gets row of matrix formatted as a human-readable String.
CMatrix	set(double value, int row, int col)	Sets an index of this matrix to the specified value.
CMatrix	set(CNumber value, int row, int col)	Sets an index of this matrix to the specified value.
CMatrix	setCol(double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(int[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(Double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(Integer[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(CVector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(Vector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(CooCVector values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setCol(CNumber[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
CMatrix	setRow(double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(int[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(Double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(Integer[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(CVector values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(CooCVector values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setRow(CNumber[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
CMatrix	setSlice(double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(int[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(Double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(Integer[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(CMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(Matrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(CooCMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(CooMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSlice(CNumber[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
CMatrix	setSliceCopy(double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(int[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(Double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(Integer[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(CMatrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(Matrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(CooCMatrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(CooMatrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setSliceCopy(CNumber[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
CMatrix	setValues(double[][] values)	Sets the value of this matrix using a 2D array.
CMatrix	setValues(int[][] values)	Sets the value of this matrix using a 2D array.
CMatrix	setValues(Double[][] values)	Sets the value of this matrix using a 2D array.
CMatrix	setValues(CNumber[][] values)	Sets the value of this matrix using a 2D array.
Shape	shape()	Gets the shape of this matrix.
CMatrix	stack(CMatrix B)	Stacks matrices along columns.
CMatrix	stack(CVector b)	Stacks vector to this matrix along columns.
CMatrix	stack(Matrix B)	Stacks matrices along columns.
CMatrix	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.
CMatrix	stack(CooMatrix B)	Stacks matrices along columns.
CMatrix	stack(CooVector b)	Stacks vector to this matrix along columns.
CMatrix	sub(Matrix 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.
CMatrix	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.
CMatrix	sub(CsrMatrix B)	Computes the element-wise subtraction of two tensors of the same rank.
void	subEq(Matrix B)	Computes the element-wise subtraction of this matrix with a real dense matrix.
void	subEq(CooCMatrix B)	Subtracts a complex sparse matrix from this matrix and stores the result in this matrix.
void	subEq(CooMatrix B)	Computes the element-wise subtraction of this matrix with a real sparse matrix.
CVector	sumCols()	Sums together the columns of a matrix as if each column was a column vector.
CVector	sumRows()	Sums together the rows of a matrix as if each row was a row vector.
CMatrix	swapCols(int colIndex1, int colIndex2)	Swaps specified columns in the matrix.
CMatrix	swapRows(int rowIndex1, int rowIndex2)	Swaps specified rows in the matrix.
CMatrix	T()	Computes the transpose of a tensor.
CooCMatrix	toCoo()	Converts this dense matrix to an equivalent CooCMatrix.
CsrCMatrix	toCsr()	Converts this matrix to an equivalent sparse CSR matrix.
String	toString()	Formats matrix contents as a human-readable String.
CTensor	toTensor()	Converts this matrix to an equivalent complex tensor.
CVector	toVector()	Converts this matrix to an equivalent vector.
CNumber	tr()	Computes the trace of this matrix.
CNumber	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.ComplexDenseTensorBase

abs, add, add, add, addEq, addEq, addEq, allClose, argMax, argMin, conj, copy, div, div, elemDiv, elemMult, hashCode, isComplex, isOnes, isReal, isZeros, max, maxAbs, min, minAbs, mult, mult, recip, reshape, reshape, set, set, sqrt, sub, sub, sub, subEq, subEq, subEq, sum, toReal, toRealSafe

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

conj, conjT, isComplex, isReal

Methods inherited from interface org.flag4j.core.ComplexTensorMixin

hermTranspose

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

CMatrix

public CMatrix(int size)

Constructs a square complex 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.

CMatrix

public CMatrix(int size,
 double value)

Creates a square complex 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.

CMatrix

public CMatrix(int size,
 CNumber value)

Creates a square complex 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.

CMatrix

public CMatrix(int rows,
 int cols)

Creates a complex 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 rows or cols is negative.

CMatrix

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

Creates a complex 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 rows or cols is negative.

CMatrix

public CMatrix(int rows,
 int cols,
 CNumber value)

Creates a complex 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 rows or cols is negative.

CMatrix

public CMatrix(Shape shape)

Creates a complex dense matrix with specified shape.

Parameters:

shape - Shape of the matrix.

CMatrix

public CMatrix(Shape shape,
 double value)

Creates a complex dense matrix with specified shape filled with specified value.

Parameters:

shape - Shape of the matrix.

value - Value to fill matrix with.

CMatrix

public CMatrix(Shape shape,
 double... entries)

Creates a complex dense matrix with specified shape filled with specified entries.

Parameters:

shape - Shape of the matrix.

entries - Entries of this matrix.

CMatrix

public CMatrix(Shape shape,
 CNumber value)

Creates a complex dense matrix with specified shape filled with specified value.

Parameters:

shape - Shape of the matrix.

value - Value to fill matrix with.

CMatrix

public CMatrix(String[][] entries)

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

Parameters:

entries - Entries of the real dense matrix.

CMatrix

public CMatrix(CNumber[][] entries)

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

Parameters:

entries - Entries of the real dense matrix.

CMatrix

public CMatrix(double[][] entries)

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

Parameters:

entries - Entries of the real dense matrix.

CMatrix

public CMatrix(int[][] entries)

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

Parameters:

entries - Entries of the real dense matrix.

CMatrix

public CMatrix(Matrix A)

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

Parameters:

A - The matrix defining the entries for this matrix.

CMatrix

public CMatrix(CMatrix A)

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

Parameters:

A - The matrix defining the entries for this matrix.

CMatrix

public CMatrix(Shape shape,
 CNumber... entries)

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

Parameters:

shape - Shape of the matrix.

entries - Entries of the matrix.

CMatrix

public CMatrix(int numRows,
 int numCols,
 CNumber[] entries)

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

Parameters:

numRows - Number of rows in the matrix.

numCols - Number of columns in the matrix.

entries - Entries of the matrix.

Method Details

getEmpty

public static CMatrix getEmpty(int rows,
 int cols)

Constructs an empty complex dense matrix. Note, the entries of this matrix will be null as contrast to CMatrix(int, int) which will create the zero matrix.

Parameters:

rows - The number of rows for the empty matrix to construct.

cols - The number of columns for the empty matrix to construct.

Returns:

An empty matrix with the specified number of rows and columns.

makeTensor

protected CMatrix makeTensor(Shape shape,
 CNumber... entries)

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

Specified by:

makeTensor in class DenseTensorBase<CMatrix,CMatrix,Matrix,CNumber[],CNumber>

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 CMatrix getSelf()

Simply returns a reference of this tensor.

Specified by:

getSelf in class TensorBase<CMatrix,CMatrix,CMatrix,CMatrix,Matrix,CNumber[],CNumber>

Returns:

A reference to this tensor.

makeRealTensor

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

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

Specified by:

makeRealTensor in class ComplexDenseTensorBase<CMatrix,Matrix>

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.

numRows

public int numRows()

Gets the number of rows in this matrix.

Specified by:

numRows in interface MatrixMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The number of columns in this matrix.

shape

public Shape shape()

Gets the shape of this matrix.

Specified by:

shape in interface MatrixMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The shape of this matrix.

toTensor

public CTensor toTensor()

Converts this matrix to an equivalent complex tensor.

Returns:

A complex tensor which is equivalent to this matrix.

toVector

public CVector 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

A vector equivalent to this matrix.

toCoo

public CooCMatrix toCoo()

Converts this dense matrix to an equivalent CooCMatrix. Note, this is likely only worthwhile for very sparse matrices.

Specified by:

toCoo in class DenseTensorBase<CMatrix,CMatrix,Matrix,CNumber[],CNumber>

Returns:

A CooCMatrix that is equivalent to this dense matrix.

See Also:

• toCsr()

toCsr

public CsrCMatrix toCsr()

Converts this matrix to an equivalent sparse CSR matrix.

Returns:

A sparse coo matrix equivalent to this matrix.

See Also:

• toCoo()

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 CMatrix. False otherwise.

isI

public boolean isI()

Checks if this matrix is the identity matrix.

Specified by:

isI in interface MatrixComparisonsMixin<CMatrix>

Returns:

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

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

flatten

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

Returns:

The flat version of this matrix.

flatten

public CMatrix flatten(int axis)

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

Specified by:

flatten in interface TensorManipulationsMixin<CMatrix>

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.

setValues

public CMatrix setValues(CNumber[][] values)

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

Specified by:

setValues in interface DenseMatrixMixin<CMatrix,CNumber>

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 CMatrix setValues(Double[][] values)

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

Specified by:

setValues in interface DenseMatrixMixin<CMatrix,CNumber>

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 CMatrix setValues(double[][] values)

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

Specified by:

setValues in interface DenseMatrixMixin<CMatrix,CNumber>

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 CMatrix setValues(int[][] values)

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

Specified by:

setValues in interface DenseMatrixMixin<CMatrix,CNumber>

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.

set

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

Description copied from interface: MatrixManipulationsMixin

Sets an index of this matrix to the specified value.

Specified by:

set in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

set

public CMatrix set(CNumber value,
 int row,
 int col)

Description copied from interface: MatrixManipulationsMixin

Sets an index of this matrix to the specified value.

Specified by:

set in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

setCol

public CMatrix setCol(CNumber[] values,
 int colIndex)

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

Specified by:

setCol in interface ComplexMatrixMixin<CMatrix>

Specified by:

setCol in interface MatrixManipulationsMixin<CMatrix,CNumber>

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

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

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

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

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 CMatrix setRow(CNumber[] values,
 int rowIndex)

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

Specified by:

setRow in interface ComplexMatrixMixin<CMatrix>

Specified by:

setRow in interface MatrixManipulationsMixin<CMatrix,CNumber>

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

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.

setCol

public CMatrix setCol(CVector values,
 int colIndex)

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

Specified by:

setCol in interface ComplexMatrixMixin<CMatrix>

Specified by:

setCol in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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

setCol

public CMatrix setCol(CooCVector values,
 int colIndex)

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

Specified by:

setCol in interface ComplexMatrixMixin<CMatrix>

Parameters:

values - New values for the column.

colIndex - The index of the columns 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 CMatrix setRow(CVector values,
 int rowIndex)

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

Specified by:

setRow in interface ComplexMatrixMixin<CMatrix>

Parameters:

values - New values for the row.

rowIndex - The index of the row 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 columns of this matrix.

setRow

public CMatrix setRow(CooCVector values,
 int rowIndex)

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

Specified by:

setRow in interface ComplexMatrixMixin<CMatrix>

Parameters:

values - New values for the row.

rowIndex - The index of the row 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 columns of this matrix.

setSlice

public CMatrix setSlice(CooCMatrix 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 ComplexMatrixMixin<CMatrix>

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 CMatrix setSliceCopy(CooCMatrix 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.

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:

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

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

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.

setRow

public CMatrix 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<CMatrix,CNumber>

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

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

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.

setSlice

public CMatrix setSlice(CMatrix 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<CMatrix,CNumber>

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 CMatrix setSlice(CNumber[][] 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<CMatrix,CNumber>

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

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

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

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

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 CMatrix setSliceCopy(CMatrix 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<CMatrix,CNumber>

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:

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 CMatrix setSliceCopy(CNumber[][] 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<CMatrix,CNumber>

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:

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

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

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:

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

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:

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

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:

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

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:

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

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:

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.

removeRow

public CMatrix removeRow(int rowIndex)

Removes a specified row from this matrix.

Specified by:

removeRow in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

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

Returns:

a copy of this matrix with the specified row removed.

removeRows

public CMatrix removeRows(int... rowIndices)

Removes a specified set of rows from this matrix.

Specified by:

removeRows in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

rowIndices - The indices of the rows to remove from this matrix. Must be sorted and unique.

Returns:

a copy of this matrix with the specified rows removed.

removeCol

public CMatrix removeCol(int colIndex)

Removes a specified column from this matrix.

Specified by:

removeCol in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

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

Returns:

a copy of this matrix with the specified column removed.

removeCols

public CMatrix removeCols(int... colIndices)

Removes a specified set of columns from this matrix.

Specified by:

removeCols in interface MatrixManipulationsMixin<CMatrix,CNumber>

Parameters:

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

Returns:

a copy of this matrix with the specified columns removed.

round

public CMatrix round()

Rounds this matrix to the nearest whole number. If the matrix is complex, both the real and imaginary component will be rounded independently.

Specified by:

round in interface TensorManipulationsMixin<CMatrix>

Overrides:

round in class ComplexDenseTensorBase<CMatrix,Matrix>

Returns:

A copy of this matrix with each entry rounded to the nearest whole number.

See Also:

• TensorManipulationsMixin.round(int)
• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.roundToZero(double)

round

public CMatrix round(int precision)

Rounds a matrix to the nearest whole number. If the matrix is complex, both the real and imaginary component will be rounded independently.

Specified by:

round in interface TensorManipulationsMixin<CMatrix>

Overrides:

round in class ComplexDenseTensorBase<CMatrix,Matrix>

Parameters:

precision - The number of decimal places to round to. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

Throws:

IllegalArgumentException - If precision is negative.

See Also:

• TensorManipulationsMixin.round()
• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.roundToZero(double)

roundToZero

public CMatrix roundToZero()

Rounds values which are close to zero in absolute value to zero. If the matrix is complex, both the real and imaginary components will be rounded independently. By default, the values must be within 1.0*E^-12 of zero. To specify a threshold value see roundToZero(double).

Specified by:

roundToZero in interface TensorManipulationsMixin<CMatrix>

Overrides:

roundToZero in class ComplexDenseTensorBase<CMatrix,Matrix>

Returns:

A copy of this matrix with rounded values.

See Also:

• TensorManipulationsMixin.roundToZero(double)
• TensorManipulationsMixin.round()
• TensorManipulationsMixin.round(int)

roundToZero

public CMatrix roundToZero(double threshold)

Rounds values which are close to zero in absolute value to zero.

Specified by:

roundToZero in interface TensorManipulationsMixin<CMatrix>

Overrides:

roundToZero in class ComplexDenseTensorBase<CMatrix,Matrix>

Parameters:

threshold - Threshold for rounding values to zero. That is, if a value in this matrix is less than the threshold in absolute value then it will be rounded to zero. This value must be non-negative.

Returns:

A copy of this matrix with rounded values.

Throws:

IllegalArgumentException - If threshold is negative.

See Also:

• TensorManipulationsMixin.roundToZero()
• TensorManipulationsMixin.round()
• TensorManipulationsMixin.round(int)

add

public CMatrix add(Matrix B)

Computes the element-wise addition between two matrices.

Specified by:

add in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CsrMatrix B)

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

Specified by:

add in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix sub(Matrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CsrMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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.

T

public CMatrix T()

Computes the transpose of a tensor. Same as TensorOperationsMixin.transpose().
This method does NOT compute the conjugate transpose. You may be looking for H().

Specified by:

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

Returns:

The transpose of this tensor.

H

public CMatrix H()

Computes the hermitian transpose (i.e. the conjugate transpose) of the matrix. Same as ComplexTensorMixin.hermTranspose().

Specified by:

H in interface ComplexMatrixMixin<CMatrix>

Specified by:

H in interface ComplexTensorMixin<CMatrix,Matrix>

Specified by:

H in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The conjugate transpose.

isHermitian

public boolean isHermitian()

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

Specified by:

isHermitian in interface ComplexMatrixMixin<CMatrix>

Returns:

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

isAntiHermitian

public boolean isAntiHermitian()

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

Specified by:

isAntiHermitian in interface ComplexMatrixMixin<CMatrix>

Returns:

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

isUnitary

public boolean isUnitary()

Checks if this matrix is unitary. That is, if this matrices inverse is equal to its hermitian transpose.

Specified by:

isUnitary in interface ComplexMatrixMixin<CMatrix>

Returns:

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

sub

public CMatrix sub(CooCMatrix B)

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

Specified by:

sub in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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.

addEq

public void addEq(Matrix B)

Computes the element-wise addition of a matrix with a real dense matrix. The result is stored in this matrix.

Specified by:

addEq in interface DenseMatrixMixin<CMatrix,CNumber>

Parameters:

B - The matrix to add to this matrix.

subEq

public void subEq(Matrix B)

Computes the element-wise subtraction of this matrix with a real dense matrix. The result is stored in this matrix.

Specified by:

subEq in interface DenseMatrixMixin<CMatrix,CNumber>

Parameters:

B - The matrix to subtract from this matrix.

addEq

public void addEq(CooMatrix B)

Computes the element-wise addition of a matrix with a real sparse matrix. The result is stored in this matrix.

Specified by:

addEq in interface DenseMatrixMixin<CMatrix,CNumber>

Parameters:

B - The sparse matrix to add to this matrix.

subEq

public void subEq(CooMatrix B)

Computes the element-wise subtraction of this matrix with a real sparse matrix. The result is stored in this matrix.

Specified by:

subEq in interface DenseMatrixMixin<CMatrix,CNumber>

Parameters:

B - The sparse matrix to subtract from this matrix.

mult

public CMatrix mult(Matrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CsrMatrix B)

Computes the matrix multiplication between two matrices.

Specified by:

mult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector mult(Vector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooVector b)

Computes matrix-vector multiplication.

Specified by:

mult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

exponent - The exponent in the matrix power.

Returns:

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

elemMult

public CMatrix elemMult(Matrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

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

Specified by:

elemMult in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(Matrix B)

Computes the element-wise division between two matrices.

Specified by:

elemDiv in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CNumber det()

Computes the determinant of a square matrix.

Specified by:

det in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The determinant of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

fib

public CNumber fib(Matrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

Computes the Frobenius inner product of two matrices.

Specified by:

fib in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector sumCols()

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

Specified by:

sumCols in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector sumRows()

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

Specified by:

sumRows in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix stack(Matrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

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

Specified by:

stack in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix augment(Matrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(CooMatrix B)

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

Specified by:

augment in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

b - Vector to stack to this matrix.

Returns:

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

Throws:

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

stack

public CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

b - Vector to stack to this matrix.

Returns:

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

Throws:

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

stack

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

b - Vector to stack to this matrix.

Returns:

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

Throws:

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

stack

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

b - Vector to stack to this matrix.

Returns:

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

Throws:

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

augment

public CMatrix 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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(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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector getRow(int i)

Get the row of this matrix at the specified index.

Specified by:

getRow in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

i - Index of row to get.

Returns:

The specified row of this matrix.

getRowAsVector

public CVector getRowAsVector(int i)

Get the row of this matrix at the specified index.

Parameters:

i - Index of row to get.

Returns:

The specified row of this matrix as a vector.

Throws:

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

getCol

public CVector getCol(int j)

Get the column of this matrix at the specified index.

Specified by:

getCol in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Parameters:

j - Index of column to get.

Returns:

The specified column of this matrix.

getColAsVector

public CVector getColAsVector(int j)

Get the column of this matrix at the specified index.

Parameters:

j - Index of column to get.

Returns:

The specified column of this matrix as a vector.

Throws:

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

getSlice

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

Gets a specified slice of this matrix.

Specified by:

getSlice in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector getColBelow(int rowStart,
 int j)

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

Specified by:

getColBelow in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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.

getCol

public CVector 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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 CVector getRowAfter(int colStart,
 int i)

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

Specified by:

getRowAfter in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

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.

trace

public CNumber 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

tr

public CNumber 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<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

The trace of this matrix.

Throws:

IllegalArgumentException - If this matrix is not square.

getDiag

public CVector getDiag()

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

Specified by:

getDiag in interface MatrixOperationsMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Returns:

A vector containing the diagonal entries of this matrix.

I

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

I

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

I

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

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.

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.

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. Otherwise, returns false.

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.

Specified by:

matrixRank in interface MatrixPropertiesMixin

Returns:

The matrix rank of this matrix.

addEq

public void addEq(CooCMatrix B)

Adds a complex sparse matrix to this matrix and stores the result in this matrix.

Parameters:

B - Complex sparse matrix to add to this matrix,

subEq

public void subEq(CooCMatrix B)

Subtracts a complex sparse matrix from this matrix and stores the result in this matrix.

Parameters:

B - Complex sparse matrix to subtract from this matrix,

swapRows

public CMatrix swapRows(int rowIndex1,
 int rowIndex2)

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

Specified by:

swapRows in interface MatrixManipulationsMixin<CMatrix,CNumber>

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 CMatrix swapCols(int colIndex1,
 int colIndex2)

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

Specified by:

swapCols in interface MatrixManipulationsMixin<CMatrix,CNumber>

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 CNumber get(int... indices)

Description copied from class: ComplexDenseTensorBase

Gets the element in this tensor at the specified indices.

Specified by:

get in interface MatrixMixin<CMatrix,CMatrix,CooCMatrix,CMatrix,CooCMatrix,CNumber,CVector,CVector>

Specified by:

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

Overrides:

get in class ComplexDenseTensorBase<CMatrix,Matrix>

Parameters:

indices - Indices of element.

Returns:

The element at the specified indices.

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