Package org.djunits.value.vdouble.matrix

Class AmountOfSubstanceMatrix

java.lang.Object

org.djunits.value.IndexedValue<U,S,M,DM>

org.djunits.value.base.Matrix<U,S,V,DoubleVectorData,M,DoubleMatrixData>

org.djunits.value.vdouble.matrix.base.DoubleMatrix<U,S,RV,RM>

org.djunits.value.vdouble.matrix.base.DoubleMatrixRel<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,AmountOfSubstanceMatrix>

org.djunits.value.vdouble.matrix.AmountOfSubstanceMatrix

All Implemented Interfaces:

Serializable, Cloneable, Relative<AmountOfSubstanceUnit,AmountOfSubstanceMatrix>, Value<AmountOfSubstanceUnit,AmountOfSubstanceMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class AmountOfSubstanceMatrix
extends DoubleMatrixRel<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,AmountOfSubstanceMatrix>

Immutable Double AmountOfSubstanceMatrix, a matrix of values with a AmountOfSubstanceUnit.

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.vdouble.matrix.base.DoubleMatrix

data

Constructor Summary

Constructors

Constructor	Description
AmountOfSubstanceMatrix(double[][] data)	Construct a AmountOfSubstanceMatrix from a double[][] object with SI-unit values.
AmountOfSubstanceMatrix(double[][] data, AmountOfSubstanceUnit displayUnit)	Construct a AmountOfSubstanceMatrix from a double[][] object.
AmountOfSubstanceMatrix(double[][] data, AmountOfSubstanceUnit displayUnit, StorageType storageType)	Construct a AmountOfSubstanceMatrix from a double[][] object.
AmountOfSubstanceMatrix(double[][] data, StorageType storageType)	Construct a AmountOfSubstanceMatrix from a double[][] object with SI-unit values.
AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data, int rows, int cols)	Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue objects.
AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data, int rows, int cols, StorageType storageType)	Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue objects.
AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data, AmountOfSubstanceUnit displayUnit, int rows, int cols)	Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue objects.
AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data, AmountOfSubstanceUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue objects.
AmountOfSubstanceMatrix(DoubleMatrixData data, AmountOfSubstanceUnit displayUnit)	Construct a AmountOfSubstanceMatrix from an internal data object.
AmountOfSubstanceMatrix(AmountOfSubstance[][] data)	Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects.
AmountOfSubstanceMatrix(AmountOfSubstance[][] data, AmountOfSubstanceUnit displayUnit)	Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects.
AmountOfSubstanceMatrix(AmountOfSubstance[][] data, AmountOfSubstanceUnit displayUnit, StorageType storageType)	Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects.
AmountOfSubstanceMatrix(AmountOfSubstance[][] data, StorageType storageType)	Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects.

Method Summary

Modifier and Type	Method	Description
Class<AmountOfSubstance>	getScalarClass()	Return the class of the corresponding scalar.
Class<AmountOfSubstanceVector>	getVectorClass()	Return the class of the corresponding vector.
AmountOfSubstanceMatrix	instantiateMatrix(DoubleMatrixData dmd, AmountOfSubstanceUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
AmountOfSubstance	instantiateScalarSI(double valueSI, AmountOfSubstanceUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
AmountOfSubstanceVector	instantiateVector(DoubleVectorData dvd, AmountOfSubstanceUnit displayUnit)	Instantiate a new vector of the class of this matrix.

Methods inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrixRel

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

Methods inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrix

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(DoubleMatrixData data,
 AmountOfSubstanceUnit displayUnit)

Construct a AmountOfSubstanceMatrix from an internal data object.

Parameters:

data - DoubleMatrixData; the internal data object for the matrix

displayUnit - AmountOfSubstanceUnit; the display unit of the matrix data

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(double[][] data,
 AmountOfSubstanceUnit displayUnit,
 StorageType storageType)

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

Parameters:

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

displayUnit - AmountOfSubstanceUnit; 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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(double[][] data,
 AmountOfSubstanceUnit displayUnit)

Construct a AmountOfSubstanceMatrix from a double[][] object. The double 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 - double[][]; the data for the matrix

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(double[][] data,
 StorageType storageType)

Construct a AmountOfSubstanceMatrix from a double[][] object with SI-unit values.

Parameters:

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

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(double[][] data)

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

Parameters:

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(AmountOfSubstance[][] data,
 AmountOfSubstanceUnit displayUnit,
 StorageType storageType)

Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects. The AmountOfSubstance 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 - AmountOfSubstance[][]; the data for the matrix

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

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(AmountOfSubstance[][] data,
 AmountOfSubstanceUnit displayUnit)

Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects. The AmountOfSubstance 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 - AmountOfSubstance[][]; the data for the matrix

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(AmountOfSubstance[][] data,
 StorageType storageType)

Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects. The AmountOfSubstance 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 - AmountOfSubstance[][]; the data for the matrix

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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(AmountOfSubstance[][] data)

Construct a AmountOfSubstanceMatrix from an array of an array of AmountOfSubstance objects. The AmountOfSubstance 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 - AmountOfSubstance[][]; the data for the matrix

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data,
 AmountOfSubstanceUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; the data for the matrix

displayUnit - AmountOfSubstanceUnit; 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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data,
 AmountOfSubstanceUnit displayUnit,
 int rows,
 int cols)

Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; the data for the matrix

displayUnit - AmountOfSubstanceUnit; 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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; 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

AmountOfSubstanceMatrix

public AmountOfSubstanceMatrix(Collection<DoubleSparseValue<AmountOfSubstanceUnit,AmountOfSubstance>> data,
 int rows,
 int cols)

Construct a AmountOfSubstanceMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; 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<AmountOfSubstance> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceMatrix,DoubleMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<AmountOfSubstanceVector> getVectorClass()

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,DoubleVectorData,AmountOfSubstanceMatrix,DoubleMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public AmountOfSubstanceMatrix instantiateMatrix(DoubleMatrixData dmd,
 AmountOfSubstanceUnit displayUnit)

Instantiate a new matrix of the class of this matrix. This can be used instead of the DoubleMatrix.instiantiate() methods in case another matrix of this class is known. The method is faster than DoubleMatrix.instantiate, and it will also work if the matrix is user-defined.

Specified by:

instantiateMatrix in class DoubleMatrix<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,AmountOfSubstanceMatrix>

Parameters:

dmd - DoubleMatrixData; 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 AmountOfSubstanceVector instantiateVector(DoubleVectorData dvd,
 AmountOfSubstanceUnit displayUnit)

Instantiate a new vector of the class of this matrix. This can be used instead of the DoubleVector.instiantiate() methods in case another matrix of this class is known. The method is faster than DoubleVector.instantiate, and it will also work if the matrix and/or vector are user-defined.

Specified by:

instantiateVector in class DoubleMatrix<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,AmountOfSubstanceMatrix>

Parameters:

dvd - DoubleVectorData; 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 AmountOfSubstance instantiateScalarSI(double valueSI,
 AmountOfSubstanceUnit displayUnit)

Instantiate a new scalar for the class of this matrix. This can be used instead of the DoubleScalar.instiantiate() methods in case a matrix of this class is known. The method is faster than DoubleScalar.instantiate, and it will also work if the matrix and/or scalar are user-defined.

Specified by:

instantiateScalarSI in class DoubleMatrix<AmountOfSubstanceUnit,AmountOfSubstance,AmountOfSubstanceVector,AmountOfSubstanceMatrix>

Parameters:

valueSI - double; 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