Package org.djunits.value.vdouble.matrix
Class VolumeMatrix
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<VolumeUnit,Volume,VolumeVector,VolumeMatrix>
org.djunits.value.vdouble.matrix.VolumeMatrix
- All Implemented Interfaces:
Serializable
,Cloneable
,Relative<VolumeUnit,
,VolumeMatrix> Value<VolumeUnit,
VolumeMatrix>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class VolumeMatrix
extends DoubleMatrixRel<VolumeUnit,Volume,VolumeVector,VolumeMatrix>
Immutable Double VolumeMatrix, a matrix of values with a VolumeUnit.
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:
-
Field Summary
Fields inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrix
data
-
Constructor Summary
ConstructorDescriptionVolumeMatrix
(double[][] data) Construct a VolumeMatrix from a double[][] object with SI-unit values.VolumeMatrix
(double[][] data, VolumeUnit displayUnit) Construct a VolumeMatrix from a double[][] object.VolumeMatrix
(double[][] data, VolumeUnit displayUnit, StorageType storageType) Construct a VolumeMatrix from a double[][] object.VolumeMatrix
(double[][] data, StorageType storageType) Construct a VolumeMatrix from a double[][] object with SI-unit values.VolumeMatrix
(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, int rows, int cols) Construct a VolumeMatrix from a (sparse) collection of DoubleSparseValue objects.VolumeMatrix
(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, int rows, int cols, StorageType storageType) Construct a VolumeMatrix from a (sparse) collection of DoubleSparseValue objects.VolumeMatrix
(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, VolumeUnit displayUnit, int rows, int cols) Construct a VolumeMatrix from a (sparse) collection of DoubleSparseValue objects.VolumeMatrix
(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, VolumeUnit displayUnit, int rows, int cols, StorageType storageType) Construct a VolumeMatrix from a (sparse) collection of DoubleSparseValue objects.VolumeMatrix
(DoubleMatrixData data, VolumeUnit displayUnit) Construct a VolumeMatrix from an internal data object.VolumeMatrix
(Volume[][] data) Construct a VolumeMatrix from an array of an array of Volume objects.VolumeMatrix
(Volume[][] data, VolumeUnit displayUnit) Construct a VolumeMatrix from an array of an array of Volume objects.VolumeMatrix
(Volume[][] data, VolumeUnit displayUnit, StorageType storageType) Construct a VolumeMatrix from an array of an array of Volume objects.VolumeMatrix
(Volume[][] data, StorageType storageType) Construct a VolumeMatrix from an array of an array of Volume objects. -
Method Summary
Modifier and TypeMethodDescriptionReturn the class of the corresponding scalar.Return the class of the corresponding vector.instantiateMatrix
(DoubleMatrixData dmd, VolumeUnit displayUnit) Instantiate a new matrix of the class of this matrix.instantiateScalarSI
(double valueSI, VolumeUnit displayUnit) Instantiate a new scalar for the class of this matrix.instantiateVector
(DoubleVectorData dvd, VolumeUnit 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
-
VolumeMatrix
Construct a VolumeMatrix from an internal data object.- Parameters:
data
- DoubleMatrixData; the internal data object for the matrixdisplayUnit
- VolumeUnit; the display unit of the matrix data
-
VolumeMatrix
Construct a VolumeMatrix 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 displayUnitdisplayUnit
- VolumeUnit; the unit of the values in the data array, and display unit when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
Construct a VolumeMatrix 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 matrixdisplayUnit
- VolumeUnit; the unit of the values in the data array, and display unit when printing
-
VolumeMatrix
Construct a VolumeMatrix from a double[][] object with SI-unit values.- Parameters:
data
- double[][]; the data for the matrix, in SI unitsstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
public VolumeMatrix(double[][] data) Construct a VolumeMatrix 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
-
VolumeMatrix
Construct a VolumeMatrix from an array of an array of Volume objects. The Volume 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
- Volume[][]; the data for the matrixdisplayUnit
- VolumeUnit; the display unit of the values when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
Construct a VolumeMatrix from an array of an array of Volume objects. The Volume 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
- Volume[][]; the data for the matrixdisplayUnit
- VolumeUnit; the display unit of the values when printing
-
VolumeMatrix
Construct a VolumeMatrix from an array of an array of Volume objects. The Volume 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
- Volume[][]; the data for the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
Construct a VolumeMatrix from an array of an array of Volume objects. The Volume 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
- Volume[][]; the data for the matrix
-
VolumeMatrix
public VolumeMatrix(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, VolumeUnit displayUnit, int rows, int cols, StorageType storageType) Construct a VolumeMatrix 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 matrixdisplayUnit
- VolumeUnit; the display unit of the matrix data, and the unit of the data pointsrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
public VolumeMatrix(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, VolumeUnit displayUnit, int rows, int cols) Construct a VolumeMatrix 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 matrixdisplayUnit
- VolumeUnit; the display unit of the matrix data, and the unit of the data pointsrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrix
-
VolumeMatrix
public VolumeMatrix(Collection<DoubleSparseValue<VolumeUnit, Volume>> data, int rows, int cols, StorageType storageType) Construct a VolumeMatrix 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 matrixrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
VolumeMatrix
Construct a VolumeMatrix 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 matrixrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrix
-
-
Method Details
-
getScalarClass
Description copied from class:IndexedValue
Return the class of the corresponding scalar.- Specified by:
getScalarClass
in classIndexedValue<VolumeUnit,
Volume, VolumeMatrix, DoubleMatrixData> - Returns:
- Class<S>; the class of the corresponding scalar
-
getVectorClass
Description copied from class:Matrix
Return the class of the corresponding vector.- Specified by:
getVectorClass
in classMatrix<VolumeUnit,
Volume, VolumeVector, DoubleVectorData, VolumeMatrix, DoubleMatrixData> - Returns:
- Class<V>; the class of the corresponding vector
-
instantiateMatrix
Description copied from class:DoubleMatrix
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 classDoubleMatrix<VolumeUnit,
Volume, VolumeVector, VolumeMatrix> - Parameters:
dmd
- DoubleMatrixData; the data used to instantiate the matrixdisplayUnit
- U; the display unit of the matrix- Returns:
- V; a matrix of the correct type
-
instantiateVector
Description copied from class:DoubleMatrix
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 classDoubleMatrix<VolumeUnit,
Volume, VolumeVector, VolumeMatrix> - Parameters:
dvd
- DoubleVectorData; the data used to instantiate the vectordisplayUnit
- U; the display unit of the vector- Returns:
- V; a vector of the correct type
-
instantiateScalarSI
Description copied from class:DoubleMatrix
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 classDoubleMatrix<VolumeUnit,
Volume, VolumeVector, VolumeMatrix> - Parameters:
valueSI
- double; 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
-