org.djunits.value.vfloat.matrix

Class FloatEnergyMatrix

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<EnergyUnit,FloatEnergyMatrix,MutableFloatEnergyMatrix,FloatEnergy>

org.djunits.value.vfloat.matrix.FloatEnergyMatrix

All Implemented Interfaces:

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

public class FloatEnergyMatrix
extends TypedFloatMatrixRel<EnergyUnit,FloatEnergyMatrix,MutableFloatEnergyMatrix,FloatEnergy>

Immutable FloatEnergyMatrix, a matrix of values with a EnergyUnit.

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
FloatEnergyMatrix(float[][] values, EnergyUnit unit, StorageType storageType) Construct a new Relative Immutable FloatEnergyMatrix.
FloatEnergyMatrix(FloatEnergy[][] values, StorageType storageType) Construct a new Relative Immutable FloatEnergyMatrix.
FloatEnergyMatrix(FloatMatrixData data, EnergyUnit unit)

Method Summary

Modifier and Type	Method and Description
FloatEnergy	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
protected MutableFloatEnergyMatrix	instantiateMutableType(FloatMatrixData fmd, EnergyUnit unit) Construct a new Relative Mutable FloatMatrix of the right type.
protected FloatEnergyMatrix	instantiateType(FloatMatrixData fmd, EnergyUnit 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

FloatEnergyMatrix

public FloatEnergyMatrix(float[][] values,
                         EnergyUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatEnergyMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatEnergyMatrix

public FloatEnergyMatrix(FloatEnergy[][] values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable FloatEnergyMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatEnergyMatrix

FloatEnergyMatrix(FloatMatrixData data,
                  EnergyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatEnergyMatrix instantiateType(FloatMatrixData fmd,
                                                  EnergyUnit unit)

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

Specified by:

instantiateType in class TypedFloatMatrixRel<EnergyUnit,FloatEnergyMatrix,MutableFloatEnergyMatrix,FloatEnergy>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatEnergyMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                EnergyUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatMatrixRel<EnergyUnit,FloatEnergyMatrix,MutableFloatEnergyMatrix,FloatEnergy>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

get

public final FloatEnergy 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<EnergyUnit>

Specified by:

get in class TypedFloatMatrixRel<EnergyUnit,FloatEnergyMatrix,MutableFloatEnergyMatrix,FloatEnergy>

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())