org.djunits.value.vdouble.matrix

Class FlowMassMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.matrix.DoubleMatrix<U>

org.djunits.value.vdouble.matrix.DoubleMatrix.Rel<U>

org.djunits.value.vdouble.matrix.TypedDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

org.djunits.value.vdouble.matrix.FlowMassMatrix

All Implemented Interfaces:

Serializable, FunctionsRel<FlowMassUnit,DoubleMatrix.Abs<FlowMassUnit>,DoubleMatrix.Rel<FlowMassUnit>>, Relative, Value<FlowMassUnit>, DoubleMatrixInterface<FlowMassUnit>

public class FlowMassMatrix
extends TypedDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Immutable Double FlowMassMatrix, a matrix of values with a FlowMassUnit.

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.vdouble.matrix.DoubleMatrix

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

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FlowMassMatrix(double[][] values, FlowMassUnit unit, StorageType storageType) Construct a new Relative Immutable Double FlowMassMatrix.
FlowMassMatrix(DoubleMatrixData data, FlowMassUnit unit)
FlowMassMatrix(FlowMass[][] values, StorageType storageType) Construct a new Relative Immutable Double FlowMassMatrix.

Method Summary

Modifier and Type	Method and Description
FlowMass	get(int row, int column) Retrieve the value stored at a specified row and column as a DoubleScalar.
protected MutableFlowMassMatrix	instantiateMutableType(DoubleMatrixData dmd, FlowMassUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected FlowMassMatrix	instantiateType(DoubleMatrixData dmd, FlowMassUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.

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

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

Methods inherited from class org.djunits.value.vdouble.matrix.DoubleMatrix.Rel

divide, minus, plus, plus, times

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

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

FlowMassMatrix

public FlowMassMatrix(double[][] values,
                      FlowMassUnit unit,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FlowMassMatrix

public FlowMassMatrix(FlowMass[][] values,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FlowMassMatrix

FlowMassMatrix(DoubleMatrixData data,
               FlowMassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FlowMassMatrix instantiateType(DoubleMatrixData dmd,
                                               FlowMassUnit unit)

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

Specified by:

instantiateType in class TypedDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected final MutableFlowMassMatrix instantiateMutableType(DoubleMatrixData dmd,
                                                             FlowMassUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

get

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

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

Specified by:

get in interface DoubleMatrixInterface<FlowMassUnit>

Specified by:

get in class TypedDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

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