Class FloatMatrix<U extends Unit<U>,S extends FloatScalar<U,S>,V extends FloatVector<U,S,V>,M extends FloatMatrix<U,S,V,M>>
java.lang.Object
org.djunits.value.IndexedValue<U,S,M,DM>
org.djunits.value.base.Matrix<U,S,V,FloatVectorData,M,FloatMatrixData>
org.djunits.value.vfloat.matrix.base.FloatMatrix<U,S,V,M>
- Type Parameters:
U
- the unitS
- the scalar with unit UV
- the vector type belonging to the matrix typeM
- the generic matrix type
- All Implemented Interfaces:
Serializable
,Cloneable
,Value<U,
M>
- Direct Known Subclasses:
FloatMatrixAbs
,FloatMatrixRel
public abstract class FloatMatrix<U extends Unit<U>,S extends FloatScalar<U,S>,V extends FloatVector<U,S,V>,M extends FloatMatrix<U,S,V,M>>
extends Matrix<U,S,V,FloatVectorData,M,FloatMatrixData>
FloatMatrix utility methods, e.g., for creating FloatMatrixs from different types of data.
Copyright (c) 2015-2024 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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected FloatMatrixData
The stored data as an object, can be sparse or dense. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal M
abs()
Return a new Scalar/Vector/Matrix with absolute value(s).final M
assign
(FloatFunction floatFunction) Execute a function on a cell by cell basis.final M
ceil()
Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).protected final void
checkColumnIndex
(int col) Check that provided column index is valid.protected final void
checkIndex
(int row, int col) Check that provided row and column indices are valid.protected final void
checkRowIndex
(int row) Check that provided row index is valid.protected final void
Check that the matrix is square.int
cols()
Retrieve the number of columns of the matrix.final float
Compute the determinant of the matrix, based on the SI values.boolean
final M
floor()
Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).get
(int row, int column) Retrieve a value from the matrix.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 final FloatMatrixData
getData()
Retrieve the data object.Retrieve the main diagonal of the matrix as a vector.S[]
Retrieve the main diagonal of the matrix as an array of scalars.float[]
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
Retrieve the value stored at a specified row and column converted into a specified unit.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[][]
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.final float[][]
Create a dense float[][] array filled with the values in the original unit.final float[][]
getValuesInUnit
(U targetUnit) Create a dense float[][] array filled with the values converted into a specified unit.final float[][]
Create a dense float[][] array filled with the values in the standard SI unit.int
hashCode()
abstract M
instantiateMatrix
(FloatMatrixData fmd, U displayUnit) Instantiate a new matrix of the class of this matrix.abstract S
instantiateScalarSI
(float valueSI, U displayUnit) Instantiate a new scalar for the class of this matrix.abstract V
instantiateVector
(FloatVectorData fvd, U displayUnit) Instantiate a new vector of the class of this matrix.final M
neg()
Return a new Scalar/Vector/Matrix with negated value(s).final 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 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
Set the value, specified in thevalueUnit
, 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.toDense()
Create and return a dense version of this internal storage.toSparse()
Create and return a sparse version of this internal storage.toString()
Concise description of this value.toString
(boolean verbose, boolean withUnit) Somewhat verbose description of this value with optional type and unit information.Somewhat verbose description of this value with the values expressed in the specified unit.Somewhat verbose description of this value with the values expressed in the specified unit.Methods inherited from class org.djunits.value.base.Matrix
getVectorClass
Methods inherited from class org.djunits.value.IndexedValue
cardinality, checkCopyOnWrite, clone, getDisplayUnit, getScalarClass, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setDisplayUnit, setMutable
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.djunits.value.Value
isAbsolute, isRelative
-
Field Details
-
data
The stored data as an object, can be sparse or dense.
-
-
Constructor Details
-
FloatMatrix
Construct a new FloatMatrix.- Parameters:
data
- FloatMatrixData; an internal data objectunit
- U; the unit
-
-
Method Details
-
instantiateMatrix
Instantiate a new matrix of the class of this matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.- Parameters:
fmd
- FloatMatrixData; the data used to instantiate the matrixdisplayUnit
- U; the display unit of the matrix- Returns:
- V; a matrix of the correct type
-
instantiateVector
Instantiate a new vector of the class of this matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix and/or vector are user-defined.- Parameters:
fvd
- FloatVectorData; the data used to instantiate the vectordisplayUnit
- U; the display unit of the vector- Returns:
- V; a vector of the correct type
-
instantiateScalarSI
Instantiate a new scalar for the class of this matrix. This can be used instead of the FloatScalar.instiantiate() methods in case a matrix of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the matrix and/or scalar are user-defined.- Parameters:
valueSI
- float; the SI value of the scalardisplayUnit
- U; the unit in which the value will be displayed- Returns:
- S; a scalar of the correct type, belonging to the matrix type
-
getData
Description copied from class:IndexedValue
Retrieve the data object. Method can only be used within package and by subclasses.- Specified by:
getData
in classIndexedValue<U extends Unit<U>,
S extends FloatScalar<U, S>, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- D; the internal data
-
setData
Description copied from class:IndexedValue
Set the data object. Method can only be used within package and by subclasses.- Specified by:
setData
in classIndexedValue<U extends Unit<U>,
S extends FloatScalar<U, S>, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
data
- D; the internal data
-
getSI
Retrieve the value stored at a specified row and column in the standard SI unit.- Parameters:
row
- int; row of the value to retrievecolumn
- int; column of the value to retrieve- Returns:
- float; value at position row, column in the standard SI unit
- Throws:
IndexOutOfBoundsException
- when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())
-
getInUnit
Retrieve the value stored at a specified row and column in the original unit.- Parameters:
row
- int; row of the value to retrievecolumn
- int; column of the value to retrieve- Returns:
- float; value at position row, column in the original unit
- Throws:
IndexOutOfBoundsException
- when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())
-
getInUnit
Retrieve the value stored at a specified row and column converted into a specified unit.- Parameters:
row
- int; row of the value to retrievecolumn
- int; column of the value to retrievetargetUnit
- U; the unit for the result- Returns:
- float; value at position row, column converted into the specified unit
- Throws:
IndexOutOfBoundsException
- when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())
-
setSI
Set the value, specified in the standard SI unit, at the specified position.- Parameters:
row
- int; row of the value to setcolumn
- int; column of the value to setvalueSI
- float; the value, specified in the standard SI unit- Throws:
IndexOutOfBoundsException
- when index out of range (index < 0 or index >= size())
-
setInUnit
Set the value, specified in the (current) display unit, at the specified position.- Parameters:
row
- int; row of the value to setcolumn
- int; column of the value to setvalueInUnit
- float; the value, specified in the (current) display unit- Throws:
IndexOutOfBoundsException
- when index out of range (index < 0 or index >= size())
-
setInUnit
public void setInUnit(int row, int column, float valueInUnit, U valueUnit) throws IndexOutOfBoundsException Set the value, specified in thevalueUnit
, at the specified position.- Parameters:
row
- int; row of the value to setcolumn
- int; column of the value to setvalueInUnit
- float; the value, specified in the (current) display unitvalueUnit
- U; the unit in which thevalueInUnit
is expressed- Throws:
IndexOutOfBoundsException
- when index out of range (index < 0 or index >= size())
-
set
Set the scalar value at the specified position.- Parameters:
row
- int; row of the value to setcolumn
- int; column of the value to setvalue
- S; the value to set- Throws:
IndexOutOfBoundsException
- when index out of range (index < 0 or index >= size())
-
getRowSI
Retrieve a row from the matrix as an array of float.- Parameters:
row
- int; row of the values to retrieve- Returns:
- S[]; the row as a float array
- Throws:
IndexOutOfBoundsException
- in case row is out of bounds
-
getColumnSI
Retrieve a column from the matrix as an array of float.- Parameters:
column
- int; column of the values to retrieve- Returns:
- S[]; the column as a float array
- Throws:
IndexOutOfBoundsException
- in case column is out of bounds
-
getDiagonalSI
Retrieve the main diagonal of the matrix as an array of float.- 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.- 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.- Returns:
- float[][]; the values in the original unit
-
getValuesInUnit
Create a dense float[][] array filled with the values converted into a specified unit.- 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()Description copied from class:Matrix
Retrieve the number of rows of the matrix.- Specified by:
rows
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- int; the number of rows of the matrix
-
cols
public int cols()Description copied from class:Matrix
Retrieve the number of columns of the matrix.- Specified by:
cols
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- int; the number of columns of the matrix
-
getScalars
Description copied from class:Matrix
Return the vector as a 2D-array of scalars.- Specified by:
getScalars
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- S[][]; the vector as a 2D-array of scalars
-
get
Description copied from class:Matrix
Retrieve a value from the matrix.- Specified by:
get
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
row
- int; row of the value to retrievecolumn
- int; column of the value to retrieve- Returns:
- S; the value as a Scalar
- Throws:
IndexOutOfBoundsException
- in case row or column is out of bounds
-
getRow
Description copied from class:Matrix
Retrieve a row from the matrix as a vector.- Specified by:
getRow
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
row
- int; row of the values to retrieve- Returns:
- V; the row as a Vector
- Throws:
IndexOutOfBoundsException
- in case row is out of bounds
-
getColumn
Description copied from class:Matrix
Retrieve a column from the matrix as a vector.- Specified by:
getColumn
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
column
- int; column of the values to retrieve- Returns:
- V; the column as a Vector
- Throws:
IndexOutOfBoundsException
- in case column is out of bounds
-
getDiagonal
Description copied from class:Matrix
Retrieve the main diagonal of the matrix as a vector.- Specified by:
getDiagonal
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- V; the main diagonal as a Vector
- Throws:
ValueRuntimeException
- in case the matrix is not square
-
getRowScalars
Description copied from class:Matrix
Retrieve a row from the matrix as an array of scalars.- Specified by:
getRowScalars
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
row
- int; row of the values to retrieve- Returns:
- S[]; the row as a Scalar array
- Throws:
IndexOutOfBoundsException
- in case row is out of bounds
-
getColumnScalars
Description copied from class:Matrix
Retrieve a column from the matrix as an array of scalars.- Specified by:
getColumnScalars
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Parameters:
col
- int; column of the values to retrieve- Returns:
- S[]; the column as a Scalar array
- Throws:
IndexOutOfBoundsException
- in case column is out of bounds
-
getDiagonalScalars
Description copied from class:Matrix
Retrieve the main diagonal of the matrix as an array of scalars.- Specified by:
getDiagonalScalars
in classMatrix<U extends Unit<U>,
S extends FloatScalar<U, S>, V extends FloatVector<U, S, V>, FloatVectorData, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- V; the main diagonal as a Scalar array
- Throws:
ValueRuntimeException
- in case the matrix is not square
-
toSparse
Description copied from class:IndexedValue
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 classIndexedValue<U extends Unit<U>,
S extends FloatScalar<U, S>, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- T; a sparse version of this internal storage
-
toDense
Description copied from class:IndexedValue
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 classIndexedValue<U extends Unit<U>,
S extends FloatScalar<U, S>, M extends FloatMatrix<U, S, V, M>, FloatMatrixData> - Returns:
- T; a dense version of this internal storage
-
assign
Execute a function on a cell by cell basis. Note: May be expensive when used on sparse data.- Parameters:
floatFunction
- FloatFunction; the function to apply- Returns:
- M; this updated matrix
-
abs
Description copied from interface:Value
Return a new Scalar/Vector/Matrix with absolute value(s).- Returns:
- R; a new R with absolute value(s)
-
ceil
Description copied from interface:Value
Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).- Returns:
- R; a new R with absolute value(s)
-
floor
Description copied from interface:Value
Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).- Returns:
- R; a new R with absolute value(s)
-
neg
Description copied from interface:Value
Return a new Scalar/Vector/Matrix with negated value(s).- Returns:
- R; a new R with negated value(s)
-
rint
Description copied from interface:Value
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.- Returns:
- R; a new R with absolute value(s)
-
toString
Description copied from interface:Value
Concise description of this value. -
toString
Description copied from interface:Value
Somewhat verbose description of this value with the values expressed in the specified unit.- 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
Description copied from interface:Value
Somewhat verbose description of this value with optional type and unit information.- Parameters:
verbose
- boolean; if true; include type info; if false; exclude type infowithUnit
- boolean; if true; include the unit; of false; exclude the unit- Returns:
- String; printable string with the value contents
-
toString
Description copied from interface:Value
Somewhat verbose description of this value with the values expressed in the specified unit.- Parameters:
displayUnit
- U; the unit into which the values are converted for displayverbose
- boolean; if true; include type info; if false; exclude type infowithUnit
- boolean; if true; include the unit; of false; exclude the unit- Returns:
- String; printable string with the value contents
-
checkIndex
Check that provided row and column indices are valid.- Parameters:
row
- int; the row value to checkcol
- int; the column value to check- Throws:
IndexOutOfBoundsException
- when row or column is invalid
-
checkRowIndex
Check that provided row index is valid.- Parameters:
row
- int; the row value to check- Throws:
IndexOutOfBoundsException
- when row is invalid
-
checkColumnIndex
Check that provided column index is valid.- Parameters:
col
- int; the column value to check- Throws:
IndexOutOfBoundsException
- when row is invalid
-
checkSquare
Check that the matrix is square.- Throws:
ValueRuntimeException
- when matrix is not square
-
determinantSI
Compute the determinant of the matrix, based on the SI values.- Returns:
- float; the determinant of the matrix
- Throws:
ValueRuntimeException
- when matrix is neither sparse, nor dense, or not square
-
hashCode
public int hashCode() -
equals
-