Package org.djunits.value.vdouble.matrix

Class FrequencyMatrix

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<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

org.djunits.value.vdouble.matrix.FrequencyMatrix

All Implemented Interfaces:

Serializable, Cloneable, Matrix<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>, Matrix.Rel<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>, ValueFunctions<FrequencyUnit,FrequencyMatrix>, IndexedValue<FrequencyUnit,Frequency,FrequencyMatrix>, Relative<FrequencyUnit,FrequencyMatrix>, Value<FrequencyUnit,FrequencyMatrix>, DoubleMatrixInterface<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class FrequencyMatrix
extends AbstractDoubleMatrixRel<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

Immutable Double FrequencyMatrix, a matrix of values with a FrequencyUnit.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim 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
FrequencyMatrix(DoubleMatrixData data, FrequencyUnit unit)

Method Summary

Modifier and Type	Method	Description
Class<Frequency>	getScalarClass()	Return the class of the corresponding scalar.
Class<FrequencyVector>	getVectorClass()	Return the class of the corresponding vector.
FrequencyMatrix	instantiateMatrix(DoubleMatrixData dmd, FrequencyUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
Frequency	instantiateScalarSI(double valueSI, FrequencyUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
FrequencyVector	instantiateVector(DoubleVectorData dvd, FrequencyUnit displayUnit)	Instantiate a new vector of the class of this matrix.

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

FrequencyMatrix

public FrequencyMatrix(DoubleMatrixData data,
                       FrequencyUnit unit)

Parameters:

data - DoubleMatrixData; an internal data object

unit - FrequencyUnit; the unit

Method Detail

getScalarClass

public Class<Frequency> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FrequencyVector> getVectorClass()

Return the class of the corresponding vector.

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FrequencyMatrix instantiateMatrix(DoubleMatrixData dmd,
                                         FrequencyUnit 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 FrequencyVector instantiateVector(DoubleVectorData dvd,
                                         FrequencyUnit 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 Frequency instantiateScalarSI(double valueSI,
                                     FrequencyUnit 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