Package org.djunits.value.vdouble.matrix

Class FrequencyMatrix

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<U,S,RV,RM>

org.djunits.value.vdouble.matrix.base.DoubleMatrixRel<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

org.djunits.value.vdouble.matrix.FrequencyMatrix

All Implemented Interfaces:

Serializable, Cloneable, Relative<FrequencyUnit,FrequencyMatrix>, Value<FrequencyUnit,FrequencyMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FrequencyMatrix
extends DoubleMatrixRel<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

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

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
FrequencyMatrix(double[][] data)	Construct a FrequencyMatrix from a double[][] object with SI-unit values.
FrequencyMatrix(double[][] data, FrequencyUnit displayUnit)	Construct a FrequencyMatrix from a double[][] object.
FrequencyMatrix(double[][] data, FrequencyUnit displayUnit, StorageType storageType)	Construct a FrequencyMatrix from a double[][] object.
FrequencyMatrix(double[][] data, StorageType storageType)	Construct a FrequencyMatrix from a double[][] object with SI-unit values.
FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data, int rows, int cols)	Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue objects.
FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data, int rows, int cols, StorageType storageType)	Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue objects.
FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data, FrequencyUnit displayUnit, int rows, int cols)	Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue objects.
FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data, FrequencyUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue objects.
FrequencyMatrix(DoubleMatrixData data, FrequencyUnit displayUnit)	Construct a FrequencyMatrix from an internal data object.
FrequencyMatrix(Frequency[][] data)	Construct a FrequencyMatrix from an array of an array of Frequency objects.
FrequencyMatrix(Frequency[][] data, FrequencyUnit displayUnit)	Construct a FrequencyMatrix from an array of an array of Frequency objects.
FrequencyMatrix(Frequency[][] data, FrequencyUnit displayUnit, StorageType storageType)	Construct a FrequencyMatrix from an array of an array of Frequency objects.
FrequencyMatrix(Frequency[][] data, StorageType storageType)	Construct a FrequencyMatrix from an array of an array of Frequency objects.

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

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

FrequencyMatrix

public FrequencyMatrix(DoubleMatrixData data,
 FrequencyUnit displayUnit)

Construct a FrequencyMatrix from an internal data object.

Parameters:

data - DoubleMatrixData; the internal data object for the matrix

displayUnit - FrequencyUnit; the display unit of the matrix data

FrequencyMatrix

public FrequencyMatrix(double[][] data,
 FrequencyUnit displayUnit,
 StorageType storageType)

Construct a FrequencyMatrix 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 - FrequencyUnit; 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

FrequencyMatrix

public FrequencyMatrix(double[][] data,
 FrequencyUnit displayUnit)

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

FrequencyMatrix

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

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

FrequencyMatrix

public FrequencyMatrix(double[][] data)

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

FrequencyMatrix

public FrequencyMatrix(Frequency[][] data,
 FrequencyUnit displayUnit,
 StorageType storageType)

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

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

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

FrequencyMatrix

public FrequencyMatrix(Frequency[][] data,
 FrequencyUnit displayUnit)

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

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

FrequencyMatrix

public FrequencyMatrix(Frequency[][] data,
 StorageType storageType)

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

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

FrequencyMatrix

public FrequencyMatrix(Frequency[][] data)

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

FrequencyMatrix

public FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data,
 FrequencyUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a FrequencyMatrix 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 - FrequencyUnit; 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

FrequencyMatrix

public FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data,
 FrequencyUnit displayUnit,
 int rows,
 int cols)

Construct a FrequencyMatrix 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 - FrequencyUnit; 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

FrequencyMatrix

public FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data,
 int rows,
 int cols,
 StorageType storageType)

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

FrequencyMatrix

public FrequencyMatrix(Collection<DoubleSparseValue<FrequencyUnit,Frequency>> data,
 int rows,
 int cols)

Construct a FrequencyMatrix 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<Frequency> getScalarClass()

Description copied from class: IndexedValue

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<FrequencyUnit,Frequency,FrequencyMatrix,DoubleMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FrequencyVector> getVectorClass()

Description copied from class: Matrix

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<FrequencyUnit,Frequency,FrequencyVector,DoubleVectorData,FrequencyMatrix,DoubleMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FrequencyMatrix instantiateMatrix(DoubleMatrixData dmd,
 FrequencyUnit 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<FrequencyUnit,Frequency,FrequencyVector,FrequencyMatrix>

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)

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

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)

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

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