Package org.djunits.value.vdouble.matrix

Class LengthMatrix

java.lang.Object

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

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

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

org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrixRel<RU,R,RV,RM>

org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrixRelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>

org.djunits.value.vdouble.matrix.LengthMatrix

All Implemented Interfaces:

Serializable, Cloneable, Matrix<LengthUnit,Length,LengthVector,LengthMatrix>, Matrix.Rel<LengthUnit,Length,LengthVector,LengthMatrix>, Matrix.RelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>, ValueFunctions<LengthUnit,LengthMatrix>, IndexedValue<LengthUnit,Length,LengthMatrix>, Relative<LengthUnit,LengthMatrix>, Value<LengthUnit,LengthMatrix>, DoubleMatrixInterface<LengthUnit,Length,LengthVector,LengthMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class LengthMatrix
extends AbstractDoubleMatrixRelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>

Immutable Length Matrix.

Copyright (c) 2013-2023 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
LengthMatrix(DoubleMatrixData data, LengthUnit unit)

Method Summary

Modifier and Type	Method	Description
Class<Length>	getScalarClass()	Return the class of the corresponding scalar.
Class<LengthVector>	getVectorClass()	Return the class of the corresponding vector.
LengthMatrix	instantiateMatrix(DoubleMatrixData dmd, LengthUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
PositionMatrix	instantiateMatrixAbs(DoubleMatrixData dmd, PositionUnit displayUnit)	Instantiate a new absolute matrix of the class of this relative matrix.
Position	instantiateScalarAbsSI(double valueSI, PositionUnit displayUnit)	Instantiate a new absolute scalar for the class of this relative matrix.
Length	instantiateScalarSI(double valueSI, LengthUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
LengthVector	instantiateVector(DoubleVectorData dvd, LengthUnit displayUnit)	Instantiate a new vector of the class of this matrix.
PositionVector	instantiateVectorAbs(DoubleVectorData dvd, PositionUnit displayUnit)	Instantiate a new absolute vector of the class of this relative matrix.

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

plus

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

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

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.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.base.Matrix.Rel

divideBy, minus, multiplyBy, plus

Methods inherited from interface org.djunits.value.Relative

divide, divide, times, times

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

LengthMatrix

public LengthMatrix(DoubleMatrixData data,
                    LengthUnit unit)

Parameters:

data - DoubleMatrixData; an internal data object

unit - LengthUnit; the unit

Method Detail

getScalarClass

public Class<Length> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<LengthVector> getVectorClass()

Return the class of the corresponding vector.

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public LengthMatrix instantiateMatrix(DoubleMatrixData dmd,
                                      LengthUnit 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 LengthVector instantiateVector(DoubleVectorData dvd,
                                      LengthUnit 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 Length instantiateScalarSI(double valueSI,
                                  LengthUnit 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

instantiateMatrixAbs

public PositionMatrix instantiateMatrixAbs(DoubleMatrixData dmd,
                                           PositionUnit displayUnit)

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

Specified by:

instantiateMatrixAbs in class AbstractDoubleMatrixRelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>

Parameters:

dmd - DoubleMatrixData; the data used to instantiate the matrix

displayUnit - AU; the display unit of the absolute matrix

Returns:

AM; an absolute matrix of the correct type, belonging to this relative matrix type

instantiateVectorAbs

public PositionVector instantiateVectorAbs(DoubleVectorData dvd,
                                           PositionUnit displayUnit)

Instantiate a new absolute vector of the class of this relative matrix. This can be used instead of the DoubleVector.instiantiate() methods in case another matrix of this relative with absolute 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:

instantiateVectorAbs in class AbstractDoubleMatrixRelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - AU; the display unit of the absolute vector

Returns:

AV; an absolute vector of the correct type, belonging to this relative matrix type

instantiateScalarAbsSI

public Position instantiateScalarAbsSI(double valueSI,
                                       PositionUnit displayUnit)

Instantiate a new absolute scalar for the class of this relative 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:

instantiateScalarAbsSI in class AbstractDoubleMatrixRelWithAbs<PositionUnit,Position,PositionVector,PositionMatrix,LengthUnit,Length,LengthVector,LengthMatrix>

Parameters:

valueSI - double; the SI value of the absolute scalar

displayUnit - AU; the unit in which the absolute value will be displayed

Returns:

A; an absolute scalar of the correct type, belonging to this relative matrix type