Package org.djunits.value.vfloat.matrix

Class FloatAbsorbedDoseMatrix

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<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseVector,FloatAbsorbedDoseMatrix>

org.djunits.value.vfloat.matrix.FloatAbsorbedDoseMatrix

All Implemented Interfaces:

Serializable, Cloneable, Matrix<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseVector,FloatAbsorbedDoseMatrix>, Matrix.Rel<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseVector,FloatAbsorbedDoseMatrix>, ValueFunctions<AbsorbedDoseUnit,FloatAbsorbedDoseMatrix>, IndexedValue<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseMatrix>, Relative<AbsorbedDoseUnit,FloatAbsorbedDoseMatrix>, Value<AbsorbedDoseUnit,FloatAbsorbedDoseMatrix>, FloatMatrixInterface<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseVector,FloatAbsorbedDoseMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class FloatAbsorbedDoseMatrix
extends AbstractFloatMatrixRel<AbsorbedDoseUnit,FloatAbsorbedDose,FloatAbsorbedDoseVector,FloatAbsorbedDoseMatrix>

Immutable FloatFloatAbsorbedDoseMatrix, a matrix of values with a AbsorbedDoseUnit.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim 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
FloatAbsorbedDoseMatrix(FloatMatrixData data, AbsorbedDoseUnit unit)

Method Summary

Modifier and Type	Method	Description
Class<FloatAbsorbedDose>	getScalarClass()	Return the class of the corresponding scalar.
Class<FloatAbsorbedDoseVector>	getVectorClass()	Return the class of the corresponding vector.
FloatAbsorbedDoseMatrix	instantiateMatrix(FloatMatrixData fmd, AbsorbedDoseUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
FloatAbsorbedDose	instantiateScalarSI(float valueSI, AbsorbedDoseUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
FloatAbsorbedDoseVector	instantiateVector(FloatVectorData fvd, AbsorbedDoseUnit 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, determinant, 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

FloatAbsorbedDoseMatrix

public FloatAbsorbedDoseMatrix(FloatMatrixData data,
                               AbsorbedDoseUnit unit)

Parameters:

data - FloatMatrixData; an internal data object

unit - AbsorbedDoseUnit; the unit

Method Detail

getScalarClass

public Class<FloatAbsorbedDose> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FloatAbsorbedDoseVector> getVectorClass()

Return the class of the corresponding vector.

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FloatAbsorbedDoseMatrix instantiateMatrix(FloatMatrixData fmd,
                                                 AbsorbedDoseUnit 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 FloatAbsorbedDoseVector instantiateVector(FloatVectorData fvd,
                                                 AbsorbedDoseUnit 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 FloatAbsorbedDose instantiateScalarSI(float valueSI,
                                             AbsorbedDoseUnit 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