org.djunits.value.vdouble.vector

Class VolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<VolumeUnit,VolumeVector,MutableVolumeVector,Volume>

org.djunits.value.vdouble.vector.VolumeVector

All Implemented Interfaces:

Serializable, Iterable<Volume>, Relative, Value<VolumeUnit>, DoubleVectorInterface<VolumeUnit>

public class VolumeVector
extends AbstractDoubleVectorRel<VolumeUnit,VolumeVector,MutableVolumeVector,Volume>

Immutable Double VolumeVector, a vector 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

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

data

Constructor Summary

Constructors

Constructor and Description
VolumeVector(double[] values, VolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.
VolumeVector(DoubleVectorData data, VolumeUnit unit)
VolumeVector(List<Double> values, VolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.
VolumeVector(List<Volume> values, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.
VolumeVector(SortedMap<Integer,Double> values, VolumeUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.
VolumeVector(SortedMap<Integer,Volume> values, int length, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.
VolumeVector(Volume[] values, StorageType storageType) Construct a new Relative Immutable Double VolumeVector.

Method Summary

Modifier and Type	Method and Description
protected MutableVolumeVector	instantiateMutableType(DoubleVectorData dvd, VolumeUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Volume	instantiateScalar(double value, VolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected VolumeVector	instantiateType(DoubleVectorData dvd, VolumeUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Volume[]	toArray() Return an array of Volume Scalars from this vector.
VolumeVector	toDense() return a dense version of this vector.
VolumeVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, size, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

VolumeVector

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

Construct a new Relative Immutable Double VolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

VolumeVector

public VolumeVector(List<Double> values,
                    VolumeUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double VolumeVector

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

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

Throws:

ValueException - when values is null

VolumeVector

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

Construct a new Relative Immutable Double VolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

VolumeVector

public VolumeVector(List<Volume> values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double VolumeVector

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

Throws:

ValueException - when values has zero entries

VolumeVector

public VolumeVector(SortedMap<Integer,Volume> values,
                    int length,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double VolumeVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

VolumeVector

public VolumeVector(SortedMap<Integer,Double> values,
                    VolumeUnit unit,
                    int length,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double VolumeVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Double VolumeVector

unit - U; the unit of the new Relative Sparse Mutable Double VolumeVector

length - the size of the vector

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

Throws:

ValueException - when values is null

VolumeVector

VolumeVector(DoubleVectorData data,
             VolumeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final VolumeVector instantiateType(DoubleVectorData dvd,
                                             VolumeUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<VolumeUnit,VolumeVector,MutableVolumeVector,Volume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableVolumeVector instantiateMutableType(DoubleVectorData dvd,
                                                           VolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<VolumeUnit,VolumeVector,MutableVolumeVector,Volume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector 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 AbstractDoubleVectorRel<VolumeUnit,VolumeVector,MutableVolumeVector,Volume>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final VolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final VolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Volume[] toArray()

Return an array of Volume Scalars from this vector.

Returns:

Volume[]; an array of Volume Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values