org.djunits.value.vfloat.vector

Class FloatMoneyPerAreaVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<MoneyPerAreaUnit,FloatMoneyPerAreaVector,MutableFloatMoneyPerAreaVector,FloatMoneyPerArea>

org.djunits.value.vfloat.vector.FloatMoneyPerAreaVector

All Implemented Interfaces:

Serializable, Iterable<FloatMoneyPerArea>, Relative, Value<MoneyPerAreaUnit>, FloatVectorInterface<MoneyPerAreaUnit>

public class FloatMoneyPerAreaVector
extends AbstractFloatVectorRel<MoneyPerAreaUnit,FloatMoneyPerAreaVector,MutableFloatMoneyPerAreaVector,FloatMoneyPerArea>

Immutable Float FloatMoneyPerAreaVector, a vector of values with a MoneyPerAreaUnit.

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.vfloat.vector.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

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

FloatMoneyPerAreaVector

public FloatMoneyPerAreaVector(float[] values,
                               MoneyPerAreaUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

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

unit - MoneyPerAreaUnit; the unit of the new Relative Immutable Float FloatMoneyPerAreaVector

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

Throws:

ValueException - when values is null

FloatMoneyPerAreaVector

public FloatMoneyPerAreaVector(List<Float> values,
                               MoneyPerAreaUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

values - List<Float>; the values of the entries in the new Relative Immutable Float FloatMoneyPerAreaVector

unit - MoneyPerAreaUnit; the unit of the new Relative Immutable Float FloatMoneyPerAreaVector

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

Throws:

ValueException - when values is null

FloatMoneyPerAreaVector

public FloatMoneyPerAreaVector(FloatMoneyPerArea[] values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

values - FloatMoneyPerArea[]; the values of the entries in the new Relative Immutable Float FloatMoneyPerAreaVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerAreaVector

public FloatMoneyPerAreaVector(List<FloatMoneyPerArea> values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

values - List<FloatMoneyPerArea>; the values of the entries in the new Relative Immutable Float FloatMoneyPerAreaVector

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

Throws:

ValueException - when values has zero entries

FloatMoneyPerAreaVector

public FloatMoneyPerAreaVector(SortedMap<Integer,FloatMoneyPerArea> values,
                               int length,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

values - SortedMap<Integer, FloatMoneyPerArea>; the values of the entries in the new Relative Sparse Mutable Float FloatMoneyPerAreaVector

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

FloatMoneyPerAreaVector

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

Construct a new Relative Immutable Float FloatMoneyPerAreaVector.

Parameters:

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

unit - MoneyPerAreaUnit; the unit of the new Relative Sparse Mutable Float FloatMoneyPerAreaVector

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

FloatMoneyPerAreaVector

FloatMoneyPerAreaVector(FloatVectorData data,
                        MoneyPerAreaUnit unit)

Parameters:

data - FloatVectorData; an internal data object

unit - MoneyPerAreaUnit; the unit

Method Detail

instantiateType

protected final FloatMoneyPerAreaVector instantiateType(FloatVectorData dvd,
                                                        MoneyPerAreaUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<MoneyPerAreaUnit,FloatMoneyPerAreaVector,MutableFloatMoneyPerAreaVector,FloatMoneyPerArea>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatMoneyPerAreaVector instantiateMutableType(FloatVectorData dvd,
                                                                      MoneyPerAreaUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<MoneyPerAreaUnit,FloatMoneyPerAreaVector,MutableFloatMoneyPerAreaVector,FloatMoneyPerArea>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatMoneyPerArea instantiateScalar(float value,
                                                    MoneyPerAreaUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<MoneyPerAreaUnit,FloatMoneyPerAreaVector,MutableFloatMoneyPerAreaVector,FloatMoneyPerArea>

Parameters:

value - float; the value

unit - U; the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatMoneyPerAreaVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatMoneyPerAreaVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatMoneyPerArea[] toArray()

Return an array of FloatMoneyPerArea Scalars from this vector.

Returns:

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

Throws:

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