org.djunits.value.vfloat.vector

Class FloatMoneyPerEnergyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<MoneyPerEnergyUnit,FloatMoneyPerEnergyVector,MutableFloatMoneyPerEnergyVector,FloatMoneyPerEnergy>

org.djunits.value.vfloat.vector.FloatMoneyPerEnergyVector

All Implemented Interfaces:

Serializable, Iterable<FloatMoneyPerEnergy>, Relative, Value<MoneyPerEnergyUnit>, FloatVectorInterface<MoneyPerEnergyUnit>

public class FloatMoneyPerEnergyVector
extends AbstractFloatVectorRel<MoneyPerEnergyUnit,FloatMoneyPerEnergyVector,MutableFloatMoneyPerEnergyVector,FloatMoneyPerEnergy>

Immutable Float FloatMoneyPerEnergyVector, a vector of values with a MoneyPerEnergyUnit.

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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableFloatMoneyPerEnergyVector	instantiateMutableType(FloatVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatMoneyPerEnergy	instantiateScalar(float value, MoneyPerEnergyUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatMoneyPerEnergyVector	instantiateType(FloatVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatMoneyPerEnergy[]	toArray() Return an array of FloatMoneyPerEnergy Scalars from this vector.
FloatMoneyPerEnergyVector	toDense() return a dense version of this vector.
FloatMoneyPerEnergyVector	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

FloatMoneyPerEnergyVector

public FloatMoneyPerEnergyVector(float[] values,
                                 MoneyPerEnergyUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable Float FloatMoneyPerEnergyVector

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

Throws:

ValueException - when values is null

FloatMoneyPerEnergyVector

public FloatMoneyPerEnergyVector(List<Float> values,
                                 MoneyPerEnergyUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatMoneyPerEnergyVector

unit - U; the unit of the new Relative Immutable Float FloatMoneyPerEnergyVector

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

Throws:

ValueException - when values is null

FloatMoneyPerEnergyVector

public FloatMoneyPerEnergyVector(FloatMoneyPerEnergy[] values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Float FloatMoneyPerEnergyVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerEnergyVector

public FloatMoneyPerEnergyVector(List<FloatMoneyPerEnergy> values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatMoneyPerEnergyVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerEnergyVector

public FloatMoneyPerEnergyVector(SortedMap<Integer,FloatMoneyPerEnergy> values,
                                 int length,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Float FloatMoneyPerEnergyVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerEnergyVector

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

Construct a new Relative Immutable Float FloatMoneyPerEnergyVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Float FloatMoneyPerEnergyVector

unit - U; the unit of the new Relative Sparse Mutable Float FloatMoneyPerEnergyVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatMoneyPerEnergyVector

FloatMoneyPerEnergyVector(FloatVectorData data,
                          MoneyPerEnergyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatMoneyPerEnergyVector instantiateType(FloatVectorData dvd,
                                                          MoneyPerEnergyUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<MoneyPerEnergyUnit,FloatMoneyPerEnergyVector,MutableFloatMoneyPerEnergyVector,FloatMoneyPerEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatMoneyPerEnergyVector instantiateMutableType(FloatVectorData dvd,
                                                                        MoneyPerEnergyUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<MoneyPerEnergyUnit,FloatMoneyPerEnergyVector,MutableFloatMoneyPerEnergyVector,FloatMoneyPerEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatMoneyPerEnergy instantiateScalar(float value,
                                                      MoneyPerEnergyUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<MoneyPerEnergyUnit,FloatMoneyPerEnergyVector,MutableFloatMoneyPerEnergyVector,FloatMoneyPerEnergy>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatMoneyPerEnergyVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatMoneyPerEnergyVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatMoneyPerEnergy[] toArray()

Return an array of FloatMoneyPerEnergy Scalars from this vector.

Returns:

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

Throws:

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