Package org.djunits.value.vdouble.matrix

Class TimeMatrix

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<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

org.djunits.value.vdouble.matrix.TimeMatrix

All Implemented Interfaces:

Serializable, Cloneable, Absolute<TimeUnit,TimeMatrix,DurationUnit,DurationMatrix>, Value<TimeUnit,TimeMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class TimeMatrix
extends DoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

Immutable Time 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:

• Serialized Form

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Class<Time>	getScalarClass()	Return the class of the corresponding scalar.
Class<TimeVector>	getVectorClass()	Return the class of the corresponding vector.
TimeMatrix	instantiateMatrix(DoubleMatrixData dmd, TimeUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
DurationMatrix	instantiateMatrixRel(DoubleMatrixData dmd, DurationUnit displayUnit)	Instantiate a new relative matrix of the class of this absolute matrix.
Duration	instantiateScalarRelSI(double valueSI, DurationUnit displayUnit)	Instantiate a new relative scalar for the class of this absolute matrix.
Time	instantiateScalarSI(double valueSI, TimeUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
TimeVector	instantiateVector(DoubleVectorData dvd, TimeUnit displayUnit)	Instantiate a new vector of the class of this matrix.
DurationVector	instantiateVectorRel(DoubleVectorData dvd, DurationUnit 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

TimeMatrix

public TimeMatrix(DoubleMatrixData data,
 TimeUnit displayUnit)

Construct a TimeMatrix from an internal data object.

Parameters:

data - DoubleMatrixData; the internal data object for the matrix

displayUnit - TimeUnit; the display unit of the matrix data

TimeMatrix

public TimeMatrix(double[][] data,
 TimeUnit displayUnit,
 StorageType storageType)

Construct a TimeMatrix 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 - TimeUnit; 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

TimeMatrix

public TimeMatrix(double[][] data,
 TimeUnit displayUnit)

Construct a TimeMatrix 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 - TimeUnit; the unit of the values in the data array, and display unit when printing

TimeMatrix

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

Construct a TimeMatrix 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

TimeMatrix

public TimeMatrix(double[][] data)

Construct a TimeMatrix 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

TimeMatrix

public TimeMatrix(Time[][] data,
 TimeUnit displayUnit,
 StorageType storageType)

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

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

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

TimeMatrix

public TimeMatrix(Time[][] data,
 TimeUnit displayUnit)

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

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

TimeMatrix

public TimeMatrix(Time[][] data,
 StorageType storageType)

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

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

TimeMatrix

public TimeMatrix(Time[][] data)

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

TimeMatrix

public TimeMatrix(Collection<DoubleSparseValue<TimeUnit,Time>> data,
 TimeUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a TimeMatrix 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 - TimeUnit; 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

TimeMatrix

public TimeMatrix(Collection<DoubleSparseValue<TimeUnit,Time>> data,
 TimeUnit displayUnit,
 int rows,
 int cols)

Construct a TimeMatrix 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 - TimeUnit; 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

TimeMatrix

public TimeMatrix(Collection<DoubleSparseValue<TimeUnit,Time>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a TimeMatrix 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

TimeMatrix

public TimeMatrix(Collection<DoubleSparseValue<TimeUnit,Time>> data,
 int rows,
 int cols)

Construct a TimeMatrix 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<Time> getScalarClass()

Description copied from class: IndexedValue

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<TimeUnit,Time,TimeMatrix,DoubleMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<TimeVector> getVectorClass()

Description copied from class: Matrix

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<TimeUnit,Time,TimeVector,DoubleVectorData,TimeMatrix,DoubleMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public TimeMatrix instantiateMatrix(DoubleMatrixData dmd,
 TimeUnit displayUnit)

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 class DoubleMatrix<TimeUnit,Time,TimeVector,TimeMatrix>

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 TimeVector instantiateVector(DoubleVectorData dvd,
 TimeUnit displayUnit)

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 class DoubleMatrix<TimeUnit,Time,TimeVector,TimeMatrix>

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 Time instantiateScalarSI(double valueSI,
 TimeUnit displayUnit)

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 class DoubleMatrix<TimeUnit,Time,TimeVector,TimeMatrix>

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

instantiateMatrixRel

public DurationMatrix instantiateMatrixRel(DoubleMatrixData dmd,
 DurationUnit displayUnit)

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 class DoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

Parameters:

dmd - DoubleMatrixData; the data used to instantiate the matrix

displayUnit - RU; the display unit of the relative matrix

Returns:

RM; a relative matrix of the correct type, belonging to this absolute matrix type

instantiateVectorRel

public DurationVector instantiateVectorRel(DoubleVectorData dvd,
 DurationUnit displayUnit)

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 class DoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - RU; the display unit of the relative vector

Returns:

RV; a relative vector of the correct type, belonging to this absolute matrix type

instantiateScalarRelSI

public Duration instantiateScalarRelSI(double valueSI,
 DurationUnit displayUnit)

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 class DoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

Parameters:

valueSI - double; the SI value of the relative scalar

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