Package org.djunits.value.vdouble.matrix.base

Class AbstractDoubleMatrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,M,DoubleMatrixData>

org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrix<U,S,V,M>

Type Parameters:

U - the unit

S - the scalar with unit U

V - the vector type belonging to the matrix type

M - the generic matrix type

All Implemented Interfaces:

Serializable, Cloneable, Matrix<U,S,V,M>, ValueFunctions<U,M>, IndexedValue<U,S,M>, Value<U,M>, DoubleMatrixInterface<U,S,V,M>

Direct Known Subclasses:

AbstractDoubleMatrixAbs, AbstractDoubleMatrixRel

public abstract class AbstractDoubleMatrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>
extends AbstractIndexedValue<U,S,M,DoubleMatrixData>
implements DoubleMatrixInterface<U,S,V,M>

The most basic abstract class for the DoubleMatrix.

Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.base.Matrix

Matrix.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>, Matrix.Rel<U extends Unit<U>,S extends Scalar<U,S>,V extends Vector<U,S,V>,RM extends Matrix.Rel<U,S,V,RM>>, Matrix.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>

Field Summary

Fields

Modifier and Type	Field	Description
protected DoubleMatrixData	data	The stored data as an object, can be sparse or dense.

Constructor Summary

Constructors

Constructor	Description
AbstractDoubleMatrix(DoubleMatrixData data, U unit)	Construct a new DoubleMatrix.

Method Summary

Modifier and Type	Method	Description
M	abs()	Return a new Scalar/Vector/Matrix with absolute value(s).
M	assign(DoubleFunction doubleFunction)	Execute a function on a cell by cell basis.
M	ceil()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).
protected void	checkColumnIndex(int col)	Check that provided column index is valid.
protected void	checkIndex(int row, int col)	Check that provided row and column indices are valid.
protected void	checkRowIndex(int row)	Check that provided row index is valid.
protected void	checkSquare()	Check that the matrix is square.
int	cols()	Retrieve the number of columns of the matrix.
double	determinantSI()	Compute the determinant of the matrix, based on the SI values in the matrix.
boolean	equals(Object obj)
M	floor()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).
S	get(int row, int column)	Retrieve a value from the matrix.
V	getColumn(int column)	Retrieve a column from the matrix as a vector.
S[]	getColumnScalars(int col)	Retrieve a column from the matrix as an array of scalars.
double[]	getColumnSI(int column)	Retrieve a column from the matrix as an array of double.
protected DoubleMatrixData	getData()	Retrieve the data object.
V	getDiagonal()	Retrieve the main diagonal of the matrix as a vector.
S[]	getDiagonalScalars()	Retrieve the main diagonal of the matrix as an array of scalars.
double[]	getDiagonalSI()	Retrieve the main diagonal of the matrix as an array of double.
double	getInUnit(int row, int column)	Retrieve the value stored at a specified row and column in the original unit.
double	getInUnit(int row, int column, U targetUnit)	Retrieve the value stored at a specified row and column converted into a specified unit.
V	getRow(int row)	Retrieve a row from the matrix as a vector.
S[]	getRowScalars(int row)	Retrieve a row from the matrix as an array of scalars.
double[]	getRowSI(int row)	Retrieve a row from the matrix as an array of double.
S[][]	getScalars()	Return the vector as a 2D-array of scalars.
double	getSI(int row, int column)	Retrieve the value stored at a specified row and column in the standard SI unit.
double[][]	getValuesInUnit()	Create a dense double[][] array filled with the values in the original unit.
double[][]	getValuesInUnit(U targetUnit)	Create a dense double[][] array filled with the values converted into a specified unit.
double[][]	getValuesSI()	Create a dense double[][] array filled with the values in the standard SI unit.
int	hashCode()
M	neg()	Return a new Scalar/Vector/Matrix with negated value(s).
M	rint()	Return a new Scalar/Vector/Matrix with the nearest integer value(s).
int	rows()	Retrieve the number of rows of the matrix.
void	set(int row, int column, S value)	Set the scalar value at the specified position.
protected void	setData(DoubleMatrixData data)	Set the data object.
void	setInUnit(int row, int column, double valueInUnit)	Set the value, specified in the (current) display unit, at the specified position.
void	setInUnit(int row, int column, double valueInUnit, U valueUnit)	Set the value, specified in the valueUnit, at the specified position.
void	setSI(int row, int column, double valueSI)	Set the value, specified in the standard SI unit, at the specified position.
M	toDense()	Create and return a dense version of this internal storage.
M	toSparse()	Create and return a sparse version of this internal storage.
String	toString()	Concise description of this value.
String	toString(boolean verbose, boolean withUnit)	Somewhat verbose description of this value with optional type and unit information.
String	toString(U displayUnit)	Somewhat verbose description of this value with the values expressed in the specified unit.
String	toString(U displayUnit, boolean verbose, boolean withUnit)	Somewhat verbose description of this value with the values expressed in the specified unit.

Methods inherited from class org.djunits.value.AbstractIndexedValue

cardinality, checkCopyOnWrite, clone, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setMutable

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.vdouble.matrix.base.DoubleMatrixInterface

instantiateMatrix, instantiateScalarSI, instantiateVector

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getScalarClass, getStorageType, immutable, isDense, isMutable, isSparse, mutable

Methods inherited from interface org.djunits.value.base.Matrix

getVectorClass

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Field Detail

data

protected DoubleMatrixData data

The stored data as an object, can be sparse or dense.

Constructor Detail

AbstractDoubleMatrix

AbstractDoubleMatrix(DoubleMatrixData data,
                     U unit)

Construct a new DoubleMatrix.

Parameters:

data - DoubleMatrixData; an internal data object

unit - U; the unit

Method Detail

getData

protected final DoubleMatrixData getData()

Retrieve the data object. Method can only be used within package and by subclasses.

Specified by:

getData in class AbstractIndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,M extends AbstractDoubleMatrix<U,S,V,M>,DoubleMatrixData>

Returns:

D; the internal data

setData

protected void setData(DoubleMatrixData data)

Set the data object. Method can only be used within package and by subclasses.

Specified by:

setData in class AbstractIndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,M extends AbstractDoubleMatrix<U,S,V,M>,DoubleMatrixData>

Parameters:

data - D; the internal data

getSI

public double getSI(int row,
                    int column)
             throws ValueRuntimeException

Retrieve the value stored at a specified row and column in the standard SI unit.

Specified by:

getSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

double; value at position row, column in the standard SI unit

Throws:

ValueRuntimeException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

getInUnit

public double getInUnit(int row,
                        int column)
                 throws ValueRuntimeException

Retrieve the value stored at a specified row and column in the original unit.

Specified by:

getInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

double; value at position row, column in the original unit

Throws:

ValueRuntimeException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

getInUnit

public double getInUnit(int row,
                        int column,
                        U targetUnit)
                 throws ValueRuntimeException

Retrieve the value stored at a specified row and column converted into a specified unit.

Specified by:

getInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

targetUnit - U; the unit for the result

Returns:

double; value at position row, column converted into the specified unit

Throws:

ValueRuntimeException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

setSI

public void setSI(int row,
                  int column,
                  double valueSI)
           throws ValueRuntimeException

Set the value, specified in the standard SI unit, at the specified position.

Specified by:

setSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to set

column - int; column of the value to set

valueSI - double; the value, specified in the standard SI unit

Throws:

ValueRuntimeException - when index out of range (index < 0 or index >= size())

setInUnit

public void setInUnit(int row,
                      int column,
                      double valueInUnit)
               throws ValueRuntimeException

Set the value, specified in the (current) display unit, at the specified position.

Specified by:

setInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to set

column - int; column of the value to set

valueInUnit - double; the value, specified in the (current) display unit

Throws:

ValueRuntimeException - when index out of range (index < 0 or index >= size())

setInUnit

public void setInUnit(int row,
                      int column,
                      double valueInUnit,
                      U valueUnit)
               throws ValueRuntimeException

Set the value, specified in the valueUnit, at the specified position.

Specified by:

setInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to set

column - int; column of the value to set

valueInUnit - double; the value, specified in the (current) display unit

valueUnit - U; the unit in which the valueInUnit is expressed

Throws:

ValueRuntimeException - when index out of range (index < 0 or index >= size())

set

public void set(int row,
                int column,
                S value)
         throws ValueRuntimeException

Set the scalar value at the specified position.

Specified by:

set in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to set

column - int; column of the value to set

value - S; the value to set

Throws:

ValueRuntimeException - when index out of range (index < 0 or index >= size())

getRowSI

public double[] getRowSI(int row)
                  throws ValueRuntimeException

Retrieve a row from the matrix as an array of double.

Specified by:

getRowSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the values to retrieve

Returns:

S[]; the row as a double array

Throws:

ValueRuntimeException - in case row is out of bounds

getColumnSI

public double[] getColumnSI(int column)
                     throws ValueRuntimeException

Retrieve a column from the matrix as an array of double.

Specified by:

getColumnSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

column - int; column of the values to retrieve

Returns:

S[]; the column as a double array

Throws:

ValueRuntimeException - in case column is out of bounds

getDiagonalSI

public double[] getDiagonalSI()
                       throws ValueRuntimeException

Retrieve the main diagonal of the matrix as an array of double.

Specified by:

getDiagonalSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

V; the main diagonal as a double array

Throws:

ValueRuntimeException - in case the matrix is not square

getValuesSI

public final double[][] getValuesSI()

Create a dense double[][] array filled with the values in the standard SI unit.

Specified by:

getValuesSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

double[][]; array of values in the standard SI unit

getValuesInUnit

public final double[][] getValuesInUnit()

Create a dense double[][] array filled with the values in the original unit.

Specified by:

getValuesInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

double[][]; the values in the original unit

getValuesInUnit

public final double[][] getValuesInUnit(U targetUnit)

Create a dense double[][] array filled with the values converted into a specified unit.

Specified by:

getValuesInUnit in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

targetUnit - U; the unit into which the values are converted for use

Returns:

double[][]; the values converted into the specified unit

rows

public int rows()

Retrieve the number of rows of the matrix.

Specified by:

rows in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

int; the number of rows of the matrix

cols

public int cols()

Retrieve the number of columns of the matrix.

Specified by:

cols in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

int; the number of columns of the matrix

getScalars

public S[][] getScalars()

Return the vector as a 2D-array of scalars.

Specified by:

getScalars in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

S[][]; the vector as a 2D-array of scalars

get

public S get(int row,
             int column)
      throws ValueRuntimeException

Retrieve a value from the matrix.

Specified by:

get in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

S; the value as a Scalar

Throws:

ValueRuntimeException - in case row or column is out of bounds

getRow

public V getRow(int row)
         throws ValueRuntimeException

Retrieve a row from the matrix as a vector.

Specified by:

getRow in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the values to retrieve

Returns:

V; the row as a Vector

Throws:

ValueRuntimeException - in case row is out of bounds

getColumn

public V getColumn(int column)
            throws ValueRuntimeException

Retrieve a column from the matrix as a vector.

Specified by:

getColumn in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

column - int; column of the values to retrieve

Returns:

V; the column as a Vector

Throws:

ValueRuntimeException - in case column is out of bounds

getDiagonal

public V getDiagonal()
              throws ValueRuntimeException

Retrieve the main diagonal of the matrix as a vector.

Specified by:

getDiagonal in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

V; the main diagonal as a Vector

Throws:

ValueRuntimeException - in case the matrix is not square

getRowScalars

public S[] getRowScalars(int row)
                  throws ValueRuntimeException

Retrieve a row from the matrix as an array of scalars.

Specified by:

getRowScalars in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

row - int; row of the values to retrieve

Returns:

S[]; the row as a Scalar array

Throws:

ValueRuntimeException - in case row is out of bounds

getColumnScalars

public S[] getColumnScalars(int col)
                     throws ValueRuntimeException

Retrieve a column from the matrix as an array of scalars.

Specified by:

getColumnScalars in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

col - int; column of the values to retrieve

Returns:

S[]; the column as a Scalar array

Throws:

ValueRuntimeException - in case column is out of bounds

getDiagonalScalars

public S[] getDiagonalScalars()
                       throws ValueRuntimeException

Retrieve the main diagonal of the matrix as an array of scalars.

Specified by:

getDiagonalScalars in interface Matrix<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

V; the main diagonal as a Scalar array

Throws:

ValueRuntimeException - in case the matrix is not square

toSparse

public M toSparse()

Create and return a sparse version of this internal storage. When the data was already sparse, the current version is returned and no copy will be made of the data.

Specified by:

toSparse in interface IndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

T; a sparse version of this internal storage

toDense

public M toDense()

Create and return a dense version of this internal storage. When the data was already dense, the current version is returned and no copy will be made of the data.

Specified by:

toDense in interface IndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

T; a dense version of this internal storage

assign

public final M assign(DoubleFunction doubleFunction)

Execute a function on a cell by cell basis. Note: May be expensive when used on sparse data.

Specified by:

assign in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Parameters:

doubleFunction - DoubleFunction; the function to apply

Returns:

M; this updated matrix

abs

public final M abs()

Return a new Scalar/Vector/Matrix with absolute value(s).

Specified by:

abs in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

ceil

public final M ceil()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).

Specified by:

ceil in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

floor

public final M floor()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).

Specified by:

floor in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

neg

public final M neg()

Return a new Scalar/Vector/Matrix with negated value(s).

Specified by:

neg in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with negated value(s)

rint

public final M rint()

Return a new Scalar/Vector/Matrix with the nearest integer value(s). When the value is exactly in the middle between two integer values, the even one is returned.

Specified by:

rint in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

toString

public String toString()

Concise description of this value.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Overrides:

toString in class Object

Returns:

a String with the value, non-verbose, with the unit attached.

toString

public String toString(U displayUnit)

Somewhat verbose description of this value with the values expressed in the specified unit.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Parameters:

displayUnit - U; the unit into which the values are converted for display

Returns:

String; printable string with the value contents expressed in the specified unit

toString

public String toString(boolean verbose,
                       boolean withUnit)

Somewhat verbose description of this value with optional type and unit information.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Parameters:

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the value contents

toString

public String toString(U displayUnit,
                       boolean verbose,
                       boolean withUnit)

Somewhat verbose description of this value with the values expressed in the specified unit.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Parameters:

displayUnit - U; the unit into which the values are converted for display

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the value contents

checkIndex

protected final void checkIndex(int row,
                                int col)
                         throws ValueRuntimeException

Check that provided row and column indices are valid.

Parameters:

row - int; the row value to check

col - int; the column value to check

Throws:

ValueRuntimeException - when row or column is invalid

checkRowIndex

protected final void checkRowIndex(int row)
                            throws ValueRuntimeException

Check that provided row index is valid.

Parameters:

row - int; the row value to check

Throws:

ValueRuntimeException - when row is invalid

checkColumnIndex

protected final void checkColumnIndex(int col)
                               throws ValueRuntimeException

Check that provided column index is valid.

Parameters:

col - int; the column value to check

Throws:

ValueRuntimeException - when row is invalid

checkSquare

protected final void checkSquare()
                          throws ValueRuntimeException

Check that the matrix is square.

Throws:

ValueRuntimeException - when matrix is not square

determinantSI

public final double determinantSI()
                           throws ValueRuntimeException

Compute the determinant of the matrix, based on the SI values in the matrix.

Specified by:

determinantSI in interface DoubleMatrixInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,M extends AbstractDoubleMatrix<U,S,V,M>>

Returns:

double; the determinant of the matrix

Throws:

ValueRuntimeException - when matrix is neither sparse, nor dense, or not square

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object