org.djunits.value.vdouble.vector

Class MoneyPerEnergyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.DoubleVector.Rel<U>

org.djunits.value.vdouble.vector.TypedDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

org.djunits.value.vdouble.vector.MoneyPerEnergyVector

All Implemented Interfaces:

Serializable, FunctionsRel<MoneyPerEnergyUnit,DoubleVector.Abs<MoneyPerEnergyUnit>,DoubleVector.Rel<MoneyPerEnergyUnit>>, Relative, Value<MoneyPerEnergyUnit>, DoubleVectorInterface<MoneyPerEnergyUnit>

public class MoneyPerEnergyVector
extends TypedDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Immutable Double MoneyPerEnergyVector, a vector of values with a MoneyPerEnergyUnit.

Copyright (c) 2013-2016 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.DoubleVector

DoubleVector.Abs<U extends Unit<U>>, DoubleVector.Rel<U extends Unit<U>>

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MoneyPerEnergy	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutableMoneyPerEnergyVector	instantiateMutableType(DoubleVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected MoneyPerEnergyVector	instantiateType(DoubleVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Immutable DoubleVector of the right type.

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

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector.Rel

divide, minus, plus, plus, times

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

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MoneyPerEnergyVector

public MoneyPerEnergyVector(double[] values,
                            MoneyPerEnergyUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyPerEnergyVector

public MoneyPerEnergyVector(List<Double> values,
                            MoneyPerEnergyUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyPerEnergyVector

public MoneyPerEnergyVector(MoneyPerEnergy[] values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyPerEnergyVector

public MoneyPerEnergyVector(List<MoneyPerEnergy> values,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyPerEnergyVector

public MoneyPerEnergyVector(SortedMap<Integer,MoneyPerEnergy> values,
                            int length,
                            StorageType storageType)
                     throws ValueException

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MoneyPerEnergyVector

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

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MoneyPerEnergyVector

MoneyPerEnergyVector(DoubleVectorData data,
                     MoneyPerEnergyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final MoneyPerEnergyVector instantiateType(DoubleVectorData dvd,
                                                     MoneyPerEnergyUnit unit)

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

Specified by:

instantiateType in class TypedDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableMoneyPerEnergyVector instantiateMutableType(DoubleVectorData dvd,
                                                                   MoneyPerEnergyUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final MoneyPerEnergy get(int index)
                         throws ValueException

Retrieve the value stored at a specified index as a DoubleScalar.

Specified by:

get in interface DoubleVectorInterface<MoneyPerEnergyUnit>

Specified by:

get in class TypedDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

index - int; index of the value to retrieve

Returns:

DoubleScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())