org.djunits.value.vfloat.vector

Class FloatMoneyPerMassVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<MoneyPerMassUnit,FloatMoneyPerMassVector,MutableFloatMoneyPerMassVector,FloatMoneyPerMass>

org.djunits.value.vfloat.vector.FloatMoneyPerMassVector

All Implemented Interfaces:

Serializable, Iterable<FloatMoneyPerMass>, Relative, Value<MoneyPerMassUnit>, FloatVectorInterface<MoneyPerMassUnit>

public class FloatMoneyPerMassVector
extends AbstractFloatVectorRel<MoneyPerMassUnit,FloatMoneyPerMassVector,MutableFloatMoneyPerMassVector,FloatMoneyPerMass>

Immutable Float FloatMoneyPerMassVector, 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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

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

FloatMoneyPerMassVector

public FloatMoneyPerMassVector(float[] values,
                               MoneyPerMassUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatMoneyPerMassVector

public FloatMoneyPerMassVector(List<Float> values,
                               MoneyPerMassUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatMoneyPerMassVector

public FloatMoneyPerMassVector(FloatMoneyPerMass[] values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerMassVector

public FloatMoneyPerMassVector(List<FloatMoneyPerMass> values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerMassVector

public FloatMoneyPerMassVector(SortedMap<Integer,FloatMoneyPerMass> values,
                               int length,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerMassVector

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

Construct a new Relative Immutable Float FloatMoneyPerMassVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatMoneyPerMassVector

FloatMoneyPerMassVector(FloatVectorData data,
                        MoneyPerMassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatMoneyPerMassVector instantiateType(FloatVectorData dvd,
                                                        MoneyPerMassUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<MoneyPerMassUnit,FloatMoneyPerMassVector,MutableFloatMoneyPerMassVector,FloatMoneyPerMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatMoneyPerMassVector instantiateMutableType(FloatVectorData dvd,
                                                                      MoneyPerMassUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<MoneyPerMassUnit,FloatMoneyPerMassVector,MutableFloatMoneyPerMassVector,FloatMoneyPerMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatMoneyPerMass instantiateScalar(float value,
                                                    MoneyPerMassUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<MoneyPerMassUnit,FloatMoneyPerMassVector,MutableFloatMoneyPerMassVector,FloatMoneyPerMass>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatMoneyPerMassVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatMoneyPerMassVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatMoneyPerMass[] toArray()

Return an array of FloatMoneyPerMass Scalars from this vector.

Returns:

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

Throws:

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