Package org.djunits.value.vfloat.matrix

Class FloatEquivalentDoseMatrix

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

org.djunits.value.vfloat.matrix.base.FloatMatrixRel<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatEquivalentDoseMatrix>

org.djunits.value.vfloat.matrix.FloatEquivalentDoseMatrix

All Implemented Interfaces:

Serializable, Cloneable, Relative<EquivalentDoseUnit,FloatEquivalentDoseMatrix>, Value<EquivalentDoseUnit,FloatEquivalentDoseMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatEquivalentDoseMatrix
extends FloatMatrixRel<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatEquivalentDoseMatrix>

Immutable FloatFloatEquivalentDoseMatrix, a matrix of values with a EquivalentDoseUnit.

Copyright (c) 2013-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:

• Serialized Form

Field Summary

Fields inherited from class org.djunits.value.vfloat.matrix.base.FloatMatrix

data

Constructor Summary

Constructors

Constructor	Description
FloatEquivalentDoseMatrix(float[][] data)	Construct a FloatEquivalentDoseMatrix from a float[][] object with SI-unit values.
FloatEquivalentDoseMatrix(float[][] data, EquivalentDoseUnit displayUnit)	Construct a FloatEquivalentDoseMatrix from a float[][] object.
FloatEquivalentDoseMatrix(float[][] data, EquivalentDoseUnit displayUnit, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from a float[][] object.
FloatEquivalentDoseMatrix(float[][] data, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from a float[][] object with SI-unit values.
FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data, int rows, int cols)	Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects.
FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data, int rows, int cols, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects.
FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data, EquivalentDoseUnit displayUnit, int rows, int cols)	Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects.
FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data, EquivalentDoseUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects.
FloatEquivalentDoseMatrix(FloatMatrixData data, EquivalentDoseUnit displayUnit)	Construct a FloatEquivalentDoseMatrix from an internal data object.
FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data)	Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects.
FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data, EquivalentDoseUnit displayUnit)	Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects.
FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data, EquivalentDoseUnit displayUnit, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects.
FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data, StorageType storageType)	Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects.

Method Summary

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

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

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

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

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

cardinality, checkCopyOnWrite, clone, getDisplayUnit, 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

Constructor Details

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(FloatMatrixData data,
 EquivalentDoseUnit displayUnit)

Construct a FloatEquivalentDoseMatrix from an internal data object.

Parameters:

data - FloatMatrixData; the internal data object for the matrix

displayUnit - EquivalentDoseUnit; the display unit of the matrix data

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(float[][] data,
 EquivalentDoseUnit displayUnit,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from a float[][] object. The float values are expressed in the displayUnit, and will be printed using the displayUnit.

Parameters:

data - float[][]; the data for the matrix, expressed in the displayUnit

displayUnit - EquivalentDoseUnit; the unit of the values in the data array, and display unit when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(float[][] data,
 EquivalentDoseUnit displayUnit)

Construct a FloatEquivalentDoseMatrix from a float[][] object. The float values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - float[][]; the data for the matrix

displayUnit - EquivalentDoseUnit; the unit of the values in the data array, and display unit when printing

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(float[][] data,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from a float[][] object with SI-unit values.

Parameters:

data - float[][]; the data for the matrix, in SI units

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(float[][] data)

Construct a FloatEquivalentDoseMatrix from a float[][] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - float[][]; the data for the matrix, in SI units

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data,
 EquivalentDoseUnit displayUnit,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects. The FloatEquivalentDose values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.

Parameters:

data - FloatEquivalentDose[][]; the data for the matrix

displayUnit - EquivalentDoseUnit; the display unit of the values when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data,
 EquivalentDoseUnit displayUnit)

Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects. The FloatEquivalentDose values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - FloatEquivalentDose[][]; the data for the matrix

displayUnit - EquivalentDoseUnit; the display unit of the values when printing

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects. The FloatEquivalentDose values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer the data as an array of an array.

Parameters:

data - FloatEquivalentDose[][]; the data for the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(FloatEquivalentDose[][] data)

Construct a FloatEquivalentDoseMatrix from an array of an array of FloatEquivalentDose objects. The FloatEquivalentDose values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - FloatEquivalentDose[][]; the data for the matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data,
 EquivalentDoseUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

displayUnit - EquivalentDoseUnit; the display unit of the matrix data, and the unit of the data points

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data,
 EquivalentDoseUnit displayUnit,
 int rows,
 int cols)

Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Assume the storage type is SPARSE, since we offer the data as a collection.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

displayUnit - EquivalentDoseUnit; the display unit of the matrix data, and the unit of the data points

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatEquivalentDoseMatrix

public FloatEquivalentDoseMatrix(Collection<FloatSparseValue<EquivalentDoseUnit,FloatEquivalentDose>> data,
 int rows,
 int cols)

Construct a FloatEquivalentDoseMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a collection.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

Method Details

getScalarClass

public Class<FloatEquivalentDose> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseMatrix,FloatMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FloatEquivalentDoseVector> getVectorClass()

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatVectorData,FloatEquivalentDoseMatrix,FloatMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FloatEquivalentDoseMatrix instantiateMatrix(FloatMatrixData fmd,
 EquivalentDoseUnit 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.

Specified by:

instantiateMatrix in class FloatMatrix<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatEquivalentDoseMatrix>

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 FloatEquivalentDoseVector instantiateVector(FloatVectorData fvd,
 EquivalentDoseUnit 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.

Specified by:

instantiateVector in class FloatMatrix<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatEquivalentDoseMatrix>

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 FloatEquivalentDose instantiateScalarSI(float valueSI,
 EquivalentDoseUnit 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.

Specified by:

instantiateScalarSI in class FloatMatrix<EquivalentDoseUnit,FloatEquivalentDose,FloatEquivalentDoseVector,FloatEquivalentDoseMatrix>

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