org.djunits.value.vdouble.vector

Class MoneyPerVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<MoneyPerVolumeUnit,MoneyPerVolumeVector,MutableMoneyPerVolumeVector,MoneyPerVolume>

org.djunits.value.vdouble.vector.MoneyPerVolumeVector

All Implemented Interfaces:

Serializable, Iterable<MoneyPerVolume>, Relative, Value<MoneyPerVolumeUnit>, DoubleVectorInterface<MoneyPerVolumeUnit>

public class MoneyPerVolumeVector
extends AbstractDoubleVectorRel<MoneyPerVolumeUnit,MoneyPerVolumeVector,MutableMoneyPerVolumeVector,MoneyPerVolume>

Immutable Double MoneyPerVolumeVector, a vector of values with a MoneyPerVolumeUnit.

Copyright (c) 2013-2019 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
MoneyPerVolumeVector(double[] values, MoneyPerVolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.
MoneyPerVolumeVector(DoubleVectorData data, MoneyPerVolumeUnit unit)
MoneyPerVolumeVector(List<Double> values, MoneyPerVolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.
MoneyPerVolumeVector(List<MoneyPerVolume> values, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.
MoneyPerVolumeVector(MoneyPerVolume[] values, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.
MoneyPerVolumeVector(SortedMap<Integer,Double> values, MoneyPerVolumeUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.
MoneyPerVolumeVector(SortedMap<Integer,MoneyPerVolume> values, int length, StorageType storageType) Construct a new Relative Immutable Double MoneyPerVolumeVector.

Method Summary

Modifier and Type	Method and Description
protected MutableMoneyPerVolumeVector	instantiateMutableType(DoubleVectorData dvd, MoneyPerVolumeUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected MoneyPerVolume	instantiateScalar(double value, MoneyPerVolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected MoneyPerVolumeVector	instantiateType(DoubleVectorData dvd, MoneyPerVolumeUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
MoneyPerVolume[]	toArray() Return an array of MoneyPerVolume Scalars from this vector.
MoneyPerVolumeVector	toDense() return a dense version of this vector.
MoneyPerVolumeVector	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

MoneyPerVolumeVector

public MoneyPerVolumeVector(double[] values,
                            MoneyPerVolumeUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

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

unit - MoneyPerVolumeUnit; the unit of the new Relative Immutable Double MoneyPerVolumeVector

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

Throws:

ValueException - when values is null

MoneyPerVolumeVector

public MoneyPerVolumeVector(List<Double> values,
                            MoneyPerVolumeUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

values - List<Double>; the values of the entries in the new Relative Immutable Double MoneyPerVolumeVector

unit - MoneyPerVolumeUnit; the unit of the new Relative Immutable Double MoneyPerVolumeVector

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

Throws:

ValueException - when values is null

MoneyPerVolumeVector

public MoneyPerVolumeVector(MoneyPerVolume[] values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

values - MoneyPerVolume[]; the values of the entries in the new Relative Immutable Double MoneyPerVolumeVector

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

Throws:

ValueException - when values has zero entries

MoneyPerVolumeVector

public MoneyPerVolumeVector(List<MoneyPerVolume> values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

values - List<MoneyPerVolume>; the values of the entries in the new Relative Immutable Double MoneyPerVolumeVector

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

Throws:

ValueException - when values has zero entries

MoneyPerVolumeVector

public MoneyPerVolumeVector(SortedMap<Integer,MoneyPerVolume> values,
                            int length,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

values - SortedMap<Integer, MoneyPerVolume>; the values of the entries in the new Relative Sparse Mutable Double MoneyPerVolumeVector

length - int; the size of the vector

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

Throws:

ValueException - when values has zero entries

MoneyPerVolumeVector

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

Construct a new Relative Immutable Double MoneyPerVolumeVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable Double MoneyPerVolumeVector

unit - MoneyPerVolumeUnit; the unit of the new Relative Sparse Mutable Double MoneyPerVolumeVector

length - int; the size of the vector

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

Throws:

ValueException - when values is null

MoneyPerVolumeVector

MoneyPerVolumeVector(DoubleVectorData data,
                     MoneyPerVolumeUnit unit)

Parameters:

data - DoubleVectorData; an internal data object

unit - MoneyPerVolumeUnit; the unit

Method Detail

instantiateType

protected final MoneyPerVolumeVector instantiateType(DoubleVectorData dvd,
                                                     MoneyPerVolumeUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<MoneyPerVolumeUnit,MoneyPerVolumeVector,MutableMoneyPerVolumeVector,MoneyPerVolume>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableMoneyPerVolumeVector instantiateMutableType(DoubleVectorData dvd,
                                                                   MoneyPerVolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<MoneyPerVolumeUnit,MoneyPerVolumeVector,MutableMoneyPerVolumeVector,MoneyPerVolume>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final MoneyPerVolume instantiateScalar(double value,
                                                 MoneyPerVolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<MoneyPerVolumeUnit,MoneyPerVolumeVector,MutableMoneyPerVolumeVector,MoneyPerVolume>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MoneyPerVolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final MoneyPerVolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public MoneyPerVolume[] toArray()

Return an array of MoneyPerVolume Scalars from this vector.

Returns:

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

Throws:

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