java.lang.Object

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

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

org.djunits.value.vfloat.matrix.base.AbstractFloatMatrix<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>, FloatMatrixInterface<U,S,V,M>

Direct Known Subclasses:: AbstractFloatMatrixAbs, AbstractFloatMatrixRel

public abstract class AbstractFloatMatrix<U extends Unit<U>,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
extends AbstractIndexedValue<U,S,M,FloatMatrixData>
implements FloatMatrixInterface<U,S,V,M>

The most basic abstract class for the FloatMatrix.

Copyright (c) 2013-2020 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, Wouter Schakel
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,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 FloatMatrixData data
The stored data as an object, can be sparse or dense.
Constructor Summary

Constructors

Constructor Description

AbstractFloatMatrix(FloatMatrixData data, U unit)
Construct a new FloatMatrix.

Method Summary

Modifier and Type	Method	Description
`M`	`abs()`	Return a new Scalar/Vector/Matrix with absolute value(s).
`M`	`assign(FloatFunction floatFunction)`	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.
`float`	`determinant()`	Compute the determinant of 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.
`float[]`	`getColumnSI(int column)`	Retrieve a column from the matrix as an array of float.
`protected FloatMatrixData`	`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.
`float[]`	`getDiagonalSI()`	Retrieve the main diagonal of the matrix as an array of float.
`float`	`getInUnit(int row, int column)`	Retrieve the value stored at a specified row and column in the original unit.
`float`	`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.
`float[]`	`getRowSI(int row)`	Retrieve a row from the matrix as an array of float.
`S[][]`	`getScalars()`	Return the vector as a 2D-array of scalars.
`float`	`getSI(int row, int column)`	Retrieve the value stored at a specified row and column in the standard SI unit.
`float[][]`	`getValuesInUnit()`	Create a dense float[][] array filled with the values in the original unit.
`float[][]`	`getValuesInUnit(U targetUnit)`	Create a dense float[][] array filled with the values converted into a specified unit.
`float[][]`	`getValuesSI()`	Create a dense float[][] 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(FloatMatrixData data)`	Set the data object.
`void`	`setInUnit(int row, int column, float valueInUnit)`	Set the value, specified in the (current) display unit, at the specified position.
`void`	`setInUnit(int row, int column, float valueInUnit, U valueUnit)`	Set the value, specified in the `valueUnit`, at the specified position.
`void`	`setSI(int row, int column, float 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.vfloat.matrix.base.FloatMatrixInterface

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 Details
- data
  
  protected FloatMatrixData data
  
  The stored data as an object, can be sparse or dense.
Constructor Details
- AbstractFloatMatrix
  
  AbstractFloatMatrix(FloatMatrixData data, U unit)
  
  Construct a new FloatMatrix.
  
  Parameters:
  
  data - FloatMatrixData; an internal data object
  
  unit - U; the unit
Method Details
- getData
 
 protected final FloatMatrixData getData()
 
 Retrieve the data object. Method can only be used within package and by subclasses.
 
 Specified by:
 
 getData in class AbstractIndexedValue,S extends AbstractFloatScalar<U,S>,M extends AbstractFloatMatrix<U,S,V,M>,FloatMatrixData>
 
 Returns:
 
 D; the internal data
- setData
 
 protected void setData(FloatMatrixData data)
 
 Set the data object. Method can only be used within package and by subclasses.
 
 Specified by:
 
 setData in class AbstractIndexedValue,S extends AbstractFloatScalar<U,S>,M extends AbstractFloatMatrix<U,S,V,M>,FloatMatrixData>
 
 Parameters:
 
 data - D; the internal data
- getSI
 
 public float 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 FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the value to retrieve
 
 column - int; column of the value to retrieve
 
 Returns:
 
 float; 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 float 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 FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the value to retrieve
 
 column - int; column of the value to retrieve
 
 Returns:
 
 float; 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 float 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 FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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:
 
 float; 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, float valueSI) throws ValueRuntimeException
 
 Set the value, specified in the standard SI unit, at the specified position.
 
 Specified by:
 
 setSI in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the value to set
 
 column - int; column of the value to set
 
 valueSI - float; 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, float valueInUnit) throws ValueRuntimeException
 
 Set the value, specified in the (current) display unit, at the specified position.
 
 Specified by:
 
 setInUnit in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the value to set
 
 column - int; column of the value to set
 
 valueInUnit - float; 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, float valueInUnit, U valueUnit) throws ValueRuntimeException
 
 Set the value, specified in the valueUnit, at the specified position.
 
 Specified by:
 
 setInUnit in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the value to set
 
 column - int; column of the value to set
 
 valueInUnit - float; 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 FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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 float[] getRowSI(int row) throws ValueRuntimeException
 
 Retrieve a row from the matrix as an array of float.
 
 Specified by:
 
 getRowSI in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 row - int; row of the values to retrieve
 
 Returns:
 
 S[]; the row as a float array
 
 Throws:
 
 ValueRuntimeException - in case row is out of bounds
- getColumnSI
 
 public float[] getColumnSI(int column) throws ValueRuntimeException
 
 Retrieve a column from the matrix as an array of float.
 
 Specified by:
 
 getColumnSI in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 column - int; column of the values to retrieve
 
 Returns:
 
 S[]; the column as a float array
 
 Throws:
 
 ValueRuntimeException - in case column is out of bounds
- getDiagonalSI
 
 public float[] getDiagonalSI() throws ValueRuntimeException
 
 Retrieve the main diagonal of the matrix as an array of float.
 
 Specified by:
 
 getDiagonalSI in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Returns:
 
 V; the main diagonal as a float array
 
 Throws:
 
 ValueRuntimeException - in case the matrix is not square
- getValuesSI
 
 public final float[][] getValuesSI()
 
 Create a dense float[][] array filled with the values in the standard SI unit.
 
 Specified by:
 
 getValuesSI in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Returns:
 
 float[][]; array of values in the standard SI unit
- getValuesInUnit
 
 public final float[][] getValuesInUnit()
 
 Create a dense float[][] array filled with the values in the original unit.
 
 Specified by:
 
 getValuesInUnit in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Returns:
 
 float[][]; the values in the original unit
- getValuesInUnit
 
 public final float[][] getValuesInUnit(U targetUnit)
 
 Create a dense float[][] array filled with the values converted into a specified unit.
 
 Specified by:
 
 getValuesInUnit in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 targetUnit - U; the unit into which the values are converted for use
 
 Returns:
 
 float[][]; 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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<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,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>>
 
 Returns:
 
 T; a dense version of this internal storage
- assign
 
 public final M assign(FloatFunction floatFunction)
 
 Execute a function on a cell by cell basis. Note: May be expensive when used on sparse data.
 
 Specified by:
 
 assign in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Parameters:
 
 floatFunction - FloatFunction; 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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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,S extends AbstractFloatScalar<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
- determinant
 
 public final float determinant() throws ValueRuntimeException
 
 Compute the determinant of the matrix.
 
 Specified by:
 
 determinant in interface FloatMatrixInterface,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>
 
 Returns:
 
 float; 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

Class AbstractFloatMatrix<U extends Unit<U>,​S extends AbstractFloatScalar<U,​S>,​V extends AbstractFloatVector<U,​S,​V>,​M extends AbstractFloatMatrix<U,​S,​V,​M>>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.AbstractIndexedValue

Methods inherited from class org.djunits.value.AbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vfloat.matrix.base.FloatMatrixInterface

Methods inherited from interface org.djunits.value.IndexedValue

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

Methods inherited from interface org.djunits.value.Value

Field Details

Constructor Details

Method Details

Class AbstractFloatMatrix<U extends Unit<U>,S extends AbstractFloatScalar<U,S>,V extends AbstractFloatVector<U,S,V>,M extends AbstractFloatMatrix<U,S,V,M>>