org.djunits.value.vdouble.matrix

Class FrequencyMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.matrix.AbstractDoubleMatrix<U,R>

org.djunits.value.vdouble.matrix.AbstractDoubleMatrixRel<FrequencyUnit,FrequencyMatrix,MutableFrequencyMatrix,Frequency>

org.djunits.value.vdouble.matrix.FrequencyMatrix

All Implemented Interfaces:

Serializable, Relative, Value<FrequencyUnit>, DoubleMatrixInterface<FrequencyUnit>

public class FrequencyMatrix
extends AbstractDoubleMatrixRel<FrequencyUnit,FrequencyMatrix,MutableFrequencyMatrix,Frequency>

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

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 9, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FrequencyMatrix(double[][] values, FrequencyUnit unit, StorageType storageType) Construct a new Relative Immutable Double FrequencyMatrix.
FrequencyMatrix(DoubleMatrixData data, FrequencyUnit unit)
FrequencyMatrix(Frequency[][] values, StorageType storageType) Construct a new Relative Immutable Double FrequencyMatrix.

Method Summary

Modifier and Type	Method and Description
protected MutableFrequencyMatrix	instantiateMutableType(DoubleMatrixData dmd, FrequencyUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected Frequency	instantiateScalar(double value, FrequencyUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected FrequencyMatrix	instantiateType(DoubleMatrixData dmd, FrequencyUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
FrequencyMatrix	toDense() Create a dense version of this DoubleMatrix.
FrequencyMatrix	toSparse() Create a sparse version of this DoubleMatrix.

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

checkUnit, divide, ensureRectangularAndNonEmpty, get, minus, mutable, plus, times

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

cardinality, checkIndex, checkSize, checkSize, columns, determinant, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, rows, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

FrequencyMatrix

public FrequencyMatrix(double[][] values,
                       FrequencyUnit unit,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Double FrequencyMatrix.

Parameters:

values - double[][]; the values of the entries in the new Relative Immutable Double FrequencyMatrix

unit - U; the unit of the new Relative Immutable Double FrequencyMatrix

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

FrequencyMatrix

public FrequencyMatrix(Frequency[][] values,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable Double FrequencyMatrix.

Parameters:

values - DoubleScalar.Rel<U>[][]; the values of the entries in the new Relative Immutable Double FrequencyMatrix

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

FrequencyMatrix

FrequencyMatrix(DoubleMatrixData data,
                FrequencyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

toDense

public final FrequencyMatrix toDense()

Create a dense version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public final FrequencyMatrix toSparse()

Create a sparse version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

instantiateType

protected final FrequencyMatrix instantiateType(DoubleMatrixData dmd,
                                                FrequencyUnit unit)

Construct a new Relative Immutable DoubleMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class AbstractDoubleMatrixRel<FrequencyUnit,FrequencyMatrix,MutableFrequencyMatrix,Frequency>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected final MutableFrequencyMatrix instantiateMutableType(DoubleMatrixData dmd,
                                                              FrequencyUnit unit)

Construct a new Relative Mutable DoubleMatrix of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class AbstractDoubleMatrixRel<FrequencyUnit,FrequencyMatrix,MutableFrequencyMatrix,Frequency>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected final Frequency instantiateScalar(double value,
                                            FrequencyUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateScalar in class AbstractDoubleMatrixRel<FrequencyUnit,FrequencyMatrix,MutableFrequencyMatrix,Frequency>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type