Package org.djunits.value.vdouble.matrix

Class TimeMatrix

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,M,DoubleMatrixData>

org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrix<AU,A,AV,AM>

org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

org.djunits.value.vdouble.matrix.TimeMatrix

All Implemented Interfaces:

Serializable, Cloneable, Absolute, Matrix<TimeUnit,Time,TimeVector,TimeMatrix>, Matrix.Abs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>, ValueFunctions<TimeUnit,TimeMatrix>, IndexedValue<TimeUnit,Time,TimeMatrix>, Value<TimeUnit,TimeMatrix>, DoubleMatrixInterface<TimeUnit,Time,TimeVector,TimeMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class TimeMatrix
extends AbstractDoubleMatrixAbs<TimeUnit,Time,TimeVector,TimeMatrix,DurationUnit,Duration,DurationVector,DurationMatrix>

Immutable Time Matrix.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.base.Matrix

Matrix.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>, Matrix.Rel<U extends Unit<U>,S extends Scalar<U,S>,V extends Vector<U,S,V>,RM extends Matrix.Rel<U,S,V,RM>>, Matrix.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>

Field Summary

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

data

Constructor Summary

Constructors

Constructor	Description
TimeMatrix(DoubleMatrixData data, TimeUnit unit)

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

decrementBy, decrementBy, minus, minus, plus

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

abs, assign, ceil, checkColumnIndex, checkIndex, checkRowIndex, checkSquare, cols, determinant, 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.AbstractIndexedValue

cardinality, checkCopyOnWrite, clone, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setMutable

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getStorageType, immutable, isDense, isMutable, isSparse, mutable, toDense, toSparse

Methods inherited from interface org.djunits.value.base.Matrix

cols, get, getColumn, getColumnScalars, getDiagonal, getDiagonalScalars, getRow, getRowScalars, getScalars, rows

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Constructor Detail

TimeMatrix

public TimeMatrix(DoubleMatrixData data,
                  TimeUnit unit)

Parameters:

data - DoubleMatrixData; an internal data object

unit - TimeUnit; the unit

Method Detail

getScalarClass

public Class<Time> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<TimeVector> getVectorClass()

Return the class of the corresponding vector.

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public TimeMatrix instantiateMatrix(DoubleMatrixData dmd,
                                    TimeUnit 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.

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)

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.

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)

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.

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)

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 AbstractDoubleMatrixAbs<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)

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 AbstractDoubleMatrixAbs<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)

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