org.djunits.value.vfloat.matrix

Class FloatDensityMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.FloatMatrix<U>

org.djunits.value.vfloat.matrix.FloatMatrix.Rel<U>

org.djunits.value.vfloat.matrix.TypedFloatMatrixRel<DensityUnit,FloatDensityMatrix,MutableFloatDensityMatrix,FloatDensity>

org.djunits.value.vfloat.matrix.FloatDensityMatrix

All Implemented Interfaces:

Serializable, FunctionsRel<DensityUnit,FloatMatrix.Abs<DensityUnit>,FloatMatrix.Rel<DensityUnit>>, Relative, Value<DensityUnit>, FloatMatrixInterface<DensityUnit>

public class FloatDensityMatrix
extends TypedFloatMatrixRel<DensityUnit,FloatDensityMatrix,MutableFloatDensityMatrix,FloatDensity>

Immutable FloatDensityMatrix, a matrix of values with a DensityUnit.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

FloatMatrix.Abs<U extends Unit<U>>, FloatMatrix.Rel<U extends Unit<U>>

Field Summary

Fields inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

data

Constructor Summary

Constructors

Constructor and Description
FloatDensityMatrix(float[][] values, DensityUnit unit, StorageType storageType) Construct a new Relative Immutable FloatDensityMatrix.
FloatDensityMatrix(FloatDensity[][] values, StorageType storageType) Construct a new Relative Immutable FloatDensityMatrix.
FloatDensityMatrix(FloatMatrixData data, DensityUnit unit)

Method Summary

Modifier and Type	Method and Description
FloatDensity	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
protected MutableFloatDensityMatrix	instantiateMutableType(FloatMatrixData fmd, DensityUnit unit) Construct a new Relative Mutable FloatMatrix of the right type.
protected FloatDensityMatrix	instantiateType(FloatMatrixData fmd, DensityUnit unit) Construct a new Relative Immutable FloatMatrix of the right type.

Methods inherited from class org.djunits.value.vfloat.matrix.TypedFloatMatrixRel

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vfloat.matrix.FloatMatrix.Rel

divide, minus, plus, plus, times

Methods inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

cardinality, checkIndex, checkSize, checkSize, checkUnit, columns, determinant, divide, ensureRectangularAndNonEmpty, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, minus, minus, minus, plus, plus, rows, times, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatDensityMatrix

public FloatDensityMatrix(float[][] values,
                          DensityUnit unit,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable FloatDensityMatrix.

Parameters:

values - float[][]; the values of the entries in the new Relative Immutable FloatDensityMatrix

unit - U; the unit of the new Relative Immutable FloatDensityMatrix

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

Throws:

ValueException - when values is null

FloatDensityMatrix

public FloatDensityMatrix(FloatDensity[][] values,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable FloatDensityMatrix.

Parameters:

values - FloatScalar.Rel<U>[][]; the values of the entries in the new Relative Immutable Float FloatDensityMatrix

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

Throws:

ValueException - when values has zero entries

FloatDensityMatrix

FloatDensityMatrix(FloatMatrixData data,
                   DensityUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatDensityMatrix instantiateType(FloatMatrixData fmd,
                                                   DensityUnit unit)

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

Specified by:

instantiateType in class TypedFloatMatrixRel<DensityUnit,FloatDensityMatrix,MutableFloatDensityMatrix,FloatDensity>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatDensityMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                 DensityUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatMatrixRel<DensityUnit,FloatDensityMatrix,MutableFloatDensityMatrix,FloatDensity>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

get

public final FloatDensity get(int row,
                              int column)
                       throws ValueException

Retrieve the value stored at a specified row and column as a FloatScalar.

Specified by:

get in interface FloatMatrixInterface<DensityUnit>

Specified by:

get in class TypedFloatMatrixRel<DensityUnit,FloatDensityMatrix,MutableFloatDensityMatrix,FloatDensity>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

FloatScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())