org.djunits.value.vdouble.vector

Class MoneyPerMassVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<MoneyPerMassUnit,MoneyPerMassVector,MutableMoneyPerMassVector,MoneyPerMass>

org.djunits.value.vdouble.vector.MoneyPerMassVector

All Implemented Interfaces:

Serializable, Iterable<MoneyPerMass>, Relative, Value<MoneyPerMassUnit>, DoubleVectorInterface<MoneyPerMassUnit>

public class MoneyPerMassVector
extends AbstractDoubleVectorRel<MoneyPerMassUnit,MoneyPerMassVector,MutableMoneyPerMassVector,MoneyPerMass>

Immutable Double MoneyPerMassVector, a vector of values with a MoneyPerMassUnit.

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.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableMoneyPerMassVector	instantiateMutableType(DoubleVectorData dvd, MoneyPerMassUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected MoneyPerMass	instantiateScalar(double value, MoneyPerMassUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected MoneyPerMassVector	instantiateType(DoubleVectorData dvd, MoneyPerMassUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
MoneyPerMass[]	toArray() Return an array of MoneyPerMass Scalars from this vector.
MoneyPerMassVector	toDense() return a dense version of this vector.
MoneyPerMassVector	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

MoneyPerMassVector

public MoneyPerMassVector(double[] values,
                          MoneyPerMassUnit unit,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyPerMassVector

public MoneyPerMassVector(List<Double> values,
                          MoneyPerMassUnit unit,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MoneyPerMassVector

public MoneyPerMassVector(MoneyPerMass[] values,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyPerMassVector

public MoneyPerMassVector(List<MoneyPerMass> values,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MoneyPerMassVector

public MoneyPerMassVector(SortedMap<Integer,MoneyPerMass> values,
                          int length,
                          StorageType storageType)
                   throws ValueException

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MoneyPerMassVector

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

Construct a new Relative Immutable Double MoneyPerMassVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MoneyPerMassVector

MoneyPerMassVector(DoubleVectorData data,
                   MoneyPerMassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final MoneyPerMassVector instantiateType(DoubleVectorData dvd,
                                                   MoneyPerMassUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<MoneyPerMassUnit,MoneyPerMassVector,MutableMoneyPerMassVector,MoneyPerMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableMoneyPerMassVector instantiateMutableType(DoubleVectorData dvd,
                                                                 MoneyPerMassUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<MoneyPerMassUnit,MoneyPerMassVector,MutableMoneyPerMassVector,MoneyPerMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final MoneyPerMass instantiateScalar(double value,
                                               MoneyPerMassUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<MoneyPerMassUnit,MoneyPerMassVector,MutableMoneyPerMassVector,MoneyPerMass>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MoneyPerMassVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final MoneyPerMassVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public MoneyPerMass[] toArray()

Return an array of MoneyPerMass Scalars from this vector.

Returns:

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

Throws:

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