org.djunits.value.vdouble.matrix

Class FlowMassMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.matrix.FlowMassMatrix

All Implemented Interfaces:

Serializable, Relative, Value<FlowMassUnit>, DoubleMatrixInterface<FlowMassUnit>

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

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

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
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
protected MutableFlowMassMatrix	instantiateMutableType(DoubleMatrixData dmd, FlowMassUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected FlowMass	instantiateScalar(double value, FlowMassUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected FlowMassMatrix	instantiateType(DoubleMatrixData dmd, FlowMassUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
FlowMassMatrix	toDense() Create a dense version of this DoubleMatrix.
FlowMassMatrix	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

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

toDense

public final FlowMassMatrix toDense()

Create a dense version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public final FlowMassMatrix toSparse()

Create a sparse version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

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 AbstractDoubleMatrixRel<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 AbstractDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected final FlowMass instantiateScalar(double value,
                                           FlowMassUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleMatrixRel<FlowMassUnit,FlowMassMatrix,MutableFlowMassMatrix,FlowMass>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type