org.djunits.value.vdouble.vector

Class MoneyPerEnergyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.vector.MoneyPerEnergyVector

All Implemented Interfaces:

Serializable, Iterable<MoneyPerEnergy>, Relative, Value<MoneyPerEnergyUnit>, DoubleVectorInterface<MoneyPerEnergyUnit>

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

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

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
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
protected MutableMoneyPerEnergyVector	instantiateMutableType(DoubleVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected MoneyPerEnergy	instantiateScalar(double value, MoneyPerEnergyUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected MoneyPerEnergyVector	instantiateType(DoubleVectorData dvd, MoneyPerEnergyUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
MoneyPerEnergy[]	toArray() Return an array of MoneyPerEnergy Scalars from this vector.
MoneyPerEnergyVector	toDense() return a dense version of this vector.
MoneyPerEnergyVector	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

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 - MoneyPerEnergyUnit; the unit of the new Relative Immutable Double MoneyPerEnergyVector

storageType - 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<Double>; the values of the entries in the new Relative Immutable Double MoneyPerEnergyVector

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

storageType - 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 - MoneyPerEnergy[]; the values of the entries in the new Relative Immutable Double MoneyPerEnergyVector

storageType - 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<MoneyPerEnergy>; the values of the entries in the new Relative Immutable Double MoneyPerEnergyVector

storageType - 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 - SortedMap<Integer, MoneyPerEnergy>; the values of the entries in the new Relative Sparse Mutable Double MoneyPerEnergyVector

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

MoneyPerEnergyVector

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

Construct a new Relative Immutable Double MoneyPerEnergyVector.

Parameters:

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

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

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

MoneyPerEnergyVector

MoneyPerEnergyVector(DoubleVectorData data,
                     MoneyPerEnergyUnit unit)

Parameters:

data - DoubleVectorData; an internal data object

unit - MoneyPerEnergyUnit; 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 AbstractDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the 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 AbstractDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final MoneyPerEnergy instantiateScalar(double value,
                                                 MoneyPerEnergyUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<MoneyPerEnergyUnit,MoneyPerEnergyVector,MutableMoneyPerEnergyVector,MoneyPerEnergy>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MoneyPerEnergyVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final MoneyPerEnergyVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public MoneyPerEnergy[] toArray()

Return an array of MoneyPerEnergy Scalars from this vector.

Returns:

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

Throws:

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