Package org.djunits.value.vdouble.matrix
Class DirectionMatrix
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<AU,A,AV,AM>
org.djunits.value.vdouble.matrix.base.DoubleMatrixAbs<DirectionUnit,Direction,DirectionVector,DirectionMatrix,AngleUnit,Angle,AngleVector,AngleMatrix>
org.djunits.value.vdouble.matrix.DirectionMatrix
- All Implemented Interfaces:
Serializable
,Cloneable
,Absolute<DirectionUnit,
,DirectionMatrix, AngleUnit, AngleMatrix> Value<DirectionUnit,
DirectionMatrix>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class DirectionMatrix
extends DoubleMatrixAbs<DirectionUnit,Direction,DirectionVector,DirectionMatrix,AngleUnit,Angle,AngleVector,AngleMatrix>
Immutable Direction Matrix.
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
ConstructorDescriptionDirectionMatrix
(double[][] data) Construct a DirectionMatrix from a double[][] object with SI-unit values.DirectionMatrix
(double[][] data, DirectionUnit displayUnit) Construct a DirectionMatrix from a double[][] object.DirectionMatrix
(double[][] data, DirectionUnit displayUnit, StorageType storageType) Construct a DirectionMatrix from a double[][] object.DirectionMatrix
(double[][] data, StorageType storageType) Construct a DirectionMatrix from a double[][] object with SI-unit values.DirectionMatrix
(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, int rows, int cols) Construct a DirectionMatrix from a (sparse) collection of DoubleSparseValue objects.DirectionMatrix
(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, int rows, int cols, StorageType storageType) Construct a DirectionMatrix from a (sparse) collection of DoubleSparseValue objects.DirectionMatrix
(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, DirectionUnit displayUnit, int rows, int cols) Construct a DirectionMatrix from a (sparse) collection of DoubleSparseValue objects.DirectionMatrix
(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, DirectionUnit displayUnit, int rows, int cols, StorageType storageType) Construct a DirectionMatrix from a (sparse) collection of DoubleSparseValue objects.DirectionMatrix
(DoubleMatrixData data, DirectionUnit displayUnit) Construct a DirectionMatrix from an internal data object.DirectionMatrix
(Direction[][] data) Construct a DirectionMatrix from an array of an array of Direction objects.DirectionMatrix
(Direction[][] data, DirectionUnit displayUnit) Construct a DirectionMatrix from an array of an array of Direction objects.DirectionMatrix
(Direction[][] data, DirectionUnit displayUnit, StorageType storageType) Construct a DirectionMatrix from an array of an array of Direction objects.DirectionMatrix
(Direction[][] data, StorageType storageType) Construct a DirectionMatrix from an array of an array of Direction objects. -
Method Summary
Modifier and TypeMethodDescriptionReturn the class of the corresponding scalar.Return the class of the corresponding vector.instantiateMatrix
(DoubleMatrixData dmd, DirectionUnit displayUnit) Instantiate a new matrix of the class of this matrix.instantiateMatrixRel
(DoubleMatrixData dmd, AngleUnit displayUnit) Instantiate a new relative matrix of the class of this absolute matrix.instantiateScalarRelSI
(double valueSI, AngleUnit displayUnit) Instantiate a new relative scalar for the class of this absolute matrix.instantiateScalarSI
(double valueSI, DirectionUnit displayUnit) Instantiate a new scalar for the class of this matrix.instantiateVector
(DoubleVectorData dvd, DirectionUnit displayUnit) Instantiate a new vector of the class of this matrix.instantiateVectorRel
(DoubleVectorData dvd, AngleUnit displayUnit) Instantiate a new relative vector of the class of this absolute matrix.Methods inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrixAbs
decrementBy, decrementBy, minus, minus, plus
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
-
DirectionMatrix
Construct a DirectionMatrix from an internal data object.- Parameters:
data
- DoubleMatrixData; the internal data object for the matrixdisplayUnit
- DirectionUnit; the display unit of the matrix data
-
DirectionMatrix
Construct a DirectionMatrix 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
- DirectionUnit; 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
-
DirectionMatrix
Construct a DirectionMatrix 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
- DirectionUnit; the unit of the values in the data array, and display unit when printing
-
DirectionMatrix
Construct a DirectionMatrix 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
-
DirectionMatrix
public DirectionMatrix(double[][] data) Construct a DirectionMatrix 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
-
DirectionMatrix
Construct a DirectionMatrix from an array of an array of Direction objects. The Direction 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
- Direction[][]; the data for the matrixdisplayUnit
- DirectionUnit; the display unit of the values when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
DirectionMatrix
Construct a DirectionMatrix from an array of an array of Direction objects. The Direction 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
- Direction[][]; the data for the matrixdisplayUnit
- DirectionUnit; the display unit of the values when printing
-
DirectionMatrix
Construct a DirectionMatrix from an array of an array of Direction objects. The Direction 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
- Direction[][]; the data for the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
DirectionMatrix
Construct a DirectionMatrix from an array of an array of Direction objects. The Direction 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
- Direction[][]; the data for the matrix
-
DirectionMatrix
public DirectionMatrix(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, DirectionUnit displayUnit, int rows, int cols, StorageType storageType) Construct a DirectionMatrix 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
- DirectionUnit; 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
-
DirectionMatrix
public DirectionMatrix(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, DirectionUnit displayUnit, int rows, int cols) Construct a DirectionMatrix 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
- DirectionUnit; 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
-
DirectionMatrix
public DirectionMatrix(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, int rows, int cols, StorageType storageType) Construct a DirectionMatrix 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
-
DirectionMatrix
public DirectionMatrix(Collection<DoubleSparseValue<DirectionUnit, Direction>> data, int rows, int cols) Construct a DirectionMatrix 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<DirectionUnit,
Direction, DirectionMatrix, 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<DirectionUnit,
Direction, DirectionVector, DoubleVectorData, DirectionMatrix, 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<DirectionUnit,
Direction, DirectionVector, DirectionMatrix> - 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<DirectionUnit,
Direction, DirectionVector, DirectionMatrix> - 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<DirectionUnit,
Direction, DirectionVector, DirectionMatrix> - 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
-
instantiateMatrixRel
Description copied from class:DoubleMatrixAbs
Instantiate a new relative matrix of the class of this absolute matrix. This can be used instead of the DoubleMatrix.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than DoubleMatrix.instantiate, and it will also work if the matrix is user-defined.- Specified by:
instantiateMatrixRel
in classDoubleMatrixAbs<DirectionUnit,
Direction, DirectionVector, DirectionMatrix, AngleUnit, Angle, AngleVector, AngleMatrix> - Parameters:
dmd
- DoubleMatrixData; the data used to instantiate the matrixdisplayUnit
- RU; the display unit of the relative matrix- Returns:
- RM; a relative matrix of the correct type, belonging to this absolute matrix type
-
instantiateVectorRel
Description copied from class:DoubleMatrixAbs
Instantiate a new relative vector of the class of this absolute matrix. This can be used instead of the DoubleVector.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than DoubleVector.instantiate, and it will also work if the matrix or vector is user-defined.- Specified by:
instantiateVectorRel
in classDoubleMatrixAbs<DirectionUnit,
Direction, DirectionVector, DirectionMatrix, AngleUnit, Angle, AngleVector, AngleMatrix> - Parameters:
dvd
- DoubleVectorData; the data used to instantiate the vectordisplayUnit
- RU; the display unit of the relative vector- Returns:
- RV; a relative vector of the correct type, belonging to this absolute matrix type
-
instantiateScalarRelSI
Description copied from class:DoubleMatrixAbs
Instantiate a new relative scalar for the class of this absolute 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:
instantiateScalarRelSI
in classDoubleMatrixAbs<DirectionUnit,
Direction, DirectionVector, DirectionMatrix, AngleUnit, Angle, AngleVector, AngleMatrix> - Parameters:
valueSI
- double; the SI value of the relative scalardisplayUnit
- RU; the unit in which the relative value will be displayed- Returns:
- R; a relative scalar of the correct type, belonging to this absolute matrix type
-