org.djunits.value.vdouble.vector

Class MoneyVector

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<MoneyUnit,MoneyVector,MutableMoneyVector,Money>

org.djunits.value.vdouble.vector.MoneyVector

All Implemented Interfaces:

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

public class MoneyVector
extends TypedDoubleVectorRel<MoneyUnit,MoneyVector,MutableMoneyVector,Money>

Immutable Double MoneyVector, a vector of values with a MoneyUnit.

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
MoneyVector(double[] values, MoneyUnit unit, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.
MoneyVector(DoubleVectorData data, MoneyUnit unit)
MoneyVector(List<Double> values, MoneyUnit unit, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.
MoneyVector(List<Money> values, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.
MoneyVector(Money[] values, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.
MoneyVector(SortedMap<Integer,Double> values, MoneyUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.
MoneyVector(SortedMap<Integer,Money> values, int length, StorageType storageType) Construct a new Relative Immutable Double MoneyVector.

Method Summary

Modifier and Type	Method and Description
Money	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutableMoneyVector	instantiateMutableType(DoubleVectorData dvd, MoneyUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected MoneyVector	instantiateType(DoubleVectorData dvd, MoneyUnit 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

MoneyVector

public MoneyVector(double[] values,
                   MoneyUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyVector

public MoneyVector(List<Double> values,
                   MoneyUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyVector

public MoneyVector(Money[] values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyVector

public MoneyVector(List<Money> values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyVector

public MoneyVector(SortedMap<Integer,Money> values,
                   int length,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MoneyVector

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

Construct a new Relative Immutable Double MoneyVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MoneyVector

MoneyVector(DoubleVectorData data,
            MoneyUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final MoneyVector instantiateType(DoubleVectorData dvd,
                                            MoneyUnit unit)

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

Specified by:

instantiateType in class TypedDoubleVectorRel<MoneyUnit,MoneyVector,MutableMoneyVector,Money>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableMoneyVector instantiateMutableType(DoubleVectorData dvd,
                                                          MoneyUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorRel<MoneyUnit,MoneyVector,MutableMoneyVector,Money>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final Money get(int index)
                throws ValueException

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

Specified by:

get in interface DoubleVectorInterface<MoneyUnit>

Specified by:

get in class TypedDoubleVectorRel<MoneyUnit,MoneyVector,MutableMoneyVector,Money>

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())