org.djunits.value.vdouble.matrix

Class VolumeMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.matrix.AbstractDoubleMatrixRel<VolumeUnit,VolumeMatrix,MutableVolumeMatrix,Volume>

org.djunits.value.vdouble.matrix.VolumeMatrix

All Implemented Interfaces:

Serializable, Relative, Value<VolumeUnit>, DoubleMatrixInterface<VolumeUnit>

public class VolumeMatrix
extends AbstractDoubleMatrixRel<VolumeUnit,VolumeMatrix,MutableVolumeMatrix,Volume>

Immutable Double VolumeMatrix, a matrix of values with a VolumeUnit.

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
VolumeMatrix(double[][] values, VolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Double VolumeMatrix.
VolumeMatrix(DoubleMatrixData data, VolumeUnit unit)
VolumeMatrix(Volume[][] values, StorageType storageType) Construct a new Relative Immutable Double VolumeMatrix.

Method Summary

Modifier and Type	Method and Description
protected MutableVolumeMatrix	instantiateMutableType(DoubleMatrixData dmd, VolumeUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected Volume	instantiateScalar(double value, VolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected VolumeMatrix	instantiateType(DoubleMatrixData dmd, VolumeUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
VolumeMatrix	toDense() Create a dense version of this DoubleMatrix.
VolumeMatrix	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

VolumeMatrix

public VolumeMatrix(double[][] values,
                    VolumeUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

VolumeMatrix

public VolumeMatrix(Volume[][] values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

VolumeMatrix

VolumeMatrix(DoubleMatrixData data,
             VolumeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

toDense

public final VolumeMatrix toDense()

Create a dense version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public final VolumeMatrix toSparse()

Create a sparse version of this DoubleMatrix.

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

instantiateType

protected final VolumeMatrix instantiateType(DoubleMatrixData dmd,
                                             VolumeUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleMatrixRel<VolumeUnit,VolumeMatrix,MutableVolumeMatrix,Volume>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected final MutableVolumeMatrix instantiateMutableType(DoubleMatrixData dmd,
                                                           VolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleMatrixRel<VolumeUnit,VolumeMatrix,MutableVolumeMatrix,Volume>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected final Volume instantiateScalar(double value,
                                         VolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleMatrixRel<VolumeUnit,VolumeMatrix,MutableVolumeMatrix,Volume>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type