org.djunits.value.vfloat.vector

Class FloatMoneyPerVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<MoneyPerVolumeUnit,FloatMoneyPerVolumeVector,MutableFloatMoneyPerVolumeVector,FloatMoneyPerVolume>

org.djunits.value.vfloat.vector.FloatMoneyPerVolumeVector

All Implemented Interfaces:

Serializable, Iterable<FloatMoneyPerVolume>, Relative, Value<MoneyPerVolumeUnit>, FloatVectorInterface<MoneyPerVolumeUnit>

public class FloatMoneyPerVolumeVector
extends AbstractFloatVectorRel<MoneyPerVolumeUnit,FloatMoneyPerVolumeVector,MutableFloatMoneyPerVolumeVector,FloatMoneyPerVolume>

Immutable Float FloatMoneyPerVolumeVector, 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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

data

Constructor Summary

Constructors

Constructor and Description
FloatMoneyPerVolumeVector(float[] values, MoneyPerVolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.
FloatMoneyPerVolumeVector(FloatMoneyPerVolume[] values, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.
FloatMoneyPerVolumeVector(FloatVectorData data, MoneyPerVolumeUnit unit)
FloatMoneyPerVolumeVector(List<Float> values, MoneyPerVolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.
FloatMoneyPerVolumeVector(List<FloatMoneyPerVolume> values, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.
FloatMoneyPerVolumeVector(SortedMap<Integer,Float> values, MoneyPerVolumeUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.
FloatMoneyPerVolumeVector(SortedMap<Integer,FloatMoneyPerVolume> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatMoneyPerVolumeVector	instantiateMutableType(FloatVectorData dvd, MoneyPerVolumeUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatMoneyPerVolume	instantiateScalar(float value, MoneyPerVolumeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatMoneyPerVolumeVector	instantiateType(FloatVectorData dvd, MoneyPerVolumeUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatMoneyPerVolume[]	toArray() Return an array of FloatMoneyPerVolume Scalars from this vector.
FloatMoneyPerVolumeVector	toDense() return a dense version of this vector.
FloatMoneyPerVolumeVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVectorRel

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

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

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

FloatMoneyPerVolumeVector

public FloatMoneyPerVolumeVector(float[] values,
                                 MoneyPerVolumeUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

values - float[]; the values of the entries in the new Relative Immutable Float FloatMoneyPerVolumeVector

unit - MoneyPerVolumeUnit; the unit of the new Relative Immutable Float FloatMoneyPerVolumeVector

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

Throws:

ValueException - when values is null

FloatMoneyPerVolumeVector

public FloatMoneyPerVolumeVector(List<Float> values,
                                 MoneyPerVolumeUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

values - List<Float>; the values of the entries in the new Relative Immutable Float FloatMoneyPerVolumeVector

unit - MoneyPerVolumeUnit; the unit of the new Relative Immutable Float FloatMoneyPerVolumeVector

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

Throws:

ValueException - when values is null

FloatMoneyPerVolumeVector

public FloatMoneyPerVolumeVector(FloatMoneyPerVolume[] values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

values - FloatMoneyPerVolume[]; the values of the entries in the new Relative Immutable Float FloatMoneyPerVolumeVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerVolumeVector

public FloatMoneyPerVolumeVector(List<FloatMoneyPerVolume> values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

values - List<FloatMoneyPerVolume>; the values of the entries in the new Relative Immutable Float FloatMoneyPerVolumeVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerVolumeVector

public FloatMoneyPerVolumeVector(SortedMap<Integer,FloatMoneyPerVolume> values,
                                 int length,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

values - SortedMap<Integer, FloatMoneyPerVolume>; the values of the entries in the new Relative Sparse Mutable Float FloatMoneyPerVolumeVector

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

FloatMoneyPerVolumeVector

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

Construct a new Relative Immutable Float FloatMoneyPerVolumeVector.

Parameters:

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

unit - MoneyPerVolumeUnit; the unit of the new Relative Sparse Mutable Float FloatMoneyPerVolumeVector

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

FloatMoneyPerVolumeVector

FloatMoneyPerVolumeVector(FloatVectorData data,
                          MoneyPerVolumeUnit unit)

Parameters:

data - FloatVectorData; an internal data object

unit - MoneyPerVolumeUnit; the unit

Method Detail

instantiateType

protected final FloatMoneyPerVolumeVector instantiateType(FloatVectorData dvd,
                                                          MoneyPerVolumeUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<MoneyPerVolumeUnit,FloatMoneyPerVolumeVector,MutableFloatMoneyPerVolumeVector,FloatMoneyPerVolume>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatMoneyPerVolumeVector instantiateMutableType(FloatVectorData dvd,
                                                                        MoneyPerVolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<MoneyPerVolumeUnit,FloatMoneyPerVolumeVector,MutableFloatMoneyPerVolumeVector,FloatMoneyPerVolume>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatMoneyPerVolume instantiateScalar(float value,
                                                      MoneyPerVolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<MoneyPerVolumeUnit,FloatMoneyPerVolumeVector,MutableFloatMoneyPerVolumeVector,FloatMoneyPerVolume>

Parameters:

value - float; the value

unit - U; the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatMoneyPerVolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatMoneyPerVolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatMoneyPerVolume[] toArray()

Return an array of FloatMoneyPerVolume Scalars from this vector.

Returns:

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

Throws:

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