Package org.djunits.value.vfloat.matrix

Class FloatAmountOfSubstanceMatrix

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,RV,RM>

org.djunits.value.vfloat.matrix.base.AbstractFloatMatrixRel<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceVector,FloatAmountOfSubstanceMatrix>

org.djunits.value.vfloat.matrix.FloatAmountOfSubstanceMatrix

All Implemented Interfaces:

Serializable, Cloneable, Matrix<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceVector,FloatAmountOfSubstanceMatrix>, Matrix.Rel<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceVector,FloatAmountOfSubstanceMatrix>, ValueFunctions<AmountOfSubstanceUnit,FloatAmountOfSubstanceMatrix>, IndexedValue<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceMatrix>, Relative<AmountOfSubstanceUnit,FloatAmountOfSubstanceMatrix>, Value<AmountOfSubstanceUnit,FloatAmountOfSubstanceMatrix>, FloatMatrixInterface<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceVector,FloatAmountOfSubstanceMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class FloatAmountOfSubstanceMatrix
extends AbstractFloatMatrixRel<AmountOfSubstanceUnit,FloatAmountOfSubstance,FloatAmountOfSubstanceVector,FloatAmountOfSubstanceMatrix>

Immutable FloatFloatAmountOfSubstanceMatrix, a matrix of values with a AmountOfSubstanceUnit.

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 inherited from class org.djunits.value.vfloat.matrix.base.AbstractFloatMatrix

data

Constructor Summary

Constructors

Constructor	Description
FloatAmountOfSubstanceMatrix(FloatMatrixData data, AmountOfSubstanceUnit unit)

Method Summary

Modifier and Type	Method	Description
Class<FloatAmountOfSubstance>	getScalarClass()	Return the class of the corresponding scalar.
Class<FloatAmountOfSubstanceVector>	getVectorClass()	Return the class of the corresponding vector.
FloatAmountOfSubstanceMatrix	instantiateMatrix(FloatMatrixData fmd, AmountOfSubstanceUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
FloatAmountOfSubstance	instantiateScalarSI(float valueSI, AmountOfSubstanceUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
FloatAmountOfSubstanceVector	instantiateVector(FloatVectorData fvd, AmountOfSubstanceUnit displayUnit)	Instantiate a new vector of the class of this matrix.

Methods inherited from class org.djunits.value.vfloat.matrix.base.AbstractFloatMatrixRel

decrementBy, decrementBy, divide, divide, divide, divideBy, incrementBy, incrementBy, minus, multiplyBy, plus, times, times, times, zSum

Methods inherited from class org.djunits.value.vfloat.matrix.base.AbstractFloatMatrix

abs, assign, ceil, checkColumnIndex, checkIndex, checkRowIndex, checkSquare, cols, determinantSI, equals, floor, get, getColumn, getColumnScalars, getColumnSI, getData, getDiagonal, getDiagonalScalars, getDiagonalSI, getInUnit, getInUnit, getRow, getRowScalars, getRowSI, getScalars, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, neg, rint, rows, set, setData, setInUnit, setInUnit, setSI, toDense, toSparse, toString, toString, toString, toString

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

cardinality, getStorageType, immutable, isDense, isMutable, isSparse, mutable, toDense, toSparse

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

cols, get, getColumn, getColumnScalars, getDiagonal, getDiagonalScalars, getRow, getRowScalars, getScalars, rows

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Constructor Detail

FloatAmountOfSubstanceMatrix

public FloatAmountOfSubstanceMatrix(FloatMatrixData data,
                                    AmountOfSubstanceUnit unit)

Parameters:

data - FloatMatrixData; an internal data object

unit - AmountOfSubstanceUnit; the unit

Method Detail

getScalarClass

public Class<FloatAmountOfSubstance> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FloatAmountOfSubstanceVector> getVectorClass()

Return the class of the corresponding vector.

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FloatAmountOfSubstanceMatrix instantiateMatrix(FloatMatrixData fmd,
                                                      AmountOfSubstanceUnit displayUnit)

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 matrix

displayUnit - U; the display unit of the matrix

Returns:

V; a matrix of the correct type

instantiateVector

public FloatAmountOfSubstanceVector instantiateVector(FloatVectorData fvd,
                                                      AmountOfSubstanceUnit displayUnit)

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 vector

displayUnit - U; the display unit of the vector

Returns:

V; a vector of the correct type

instantiateScalarSI

public FloatAmountOfSubstance instantiateScalarSI(float valueSI,
                                                  AmountOfSubstanceUnit displayUnit)

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 scalar

displayUnit - U; the unit in which the value will be displayed

Returns:

S; a scalar of the correct type, belonging to the matrix type