org.djunits.value.vfloat.vector

Class FloatVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<VolumeUnit,FloatVolumeVector,MutableFloatVolumeVector,FloatVolume>

org.djunits.value.vfloat.vector.FloatVolumeVector

All Implemented Interfaces:

Serializable, Iterable<FloatVolume>, Relative, Value<VolumeUnit>, FloatVectorInterface<VolumeUnit>

public class FloatVolumeVector
extends AbstractFloatVectorRel<VolumeUnit,FloatVolumeVector,MutableFloatVolumeVector,FloatVolume>

Immutable Float FloatVolumeVector, a vector of values with a VolumeUnit.

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
FloatVolumeVector(float[] values, VolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.
FloatVolumeVector(FloatVectorData data, VolumeUnit unit)
FloatVolumeVector(FloatVolume[] values, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.
FloatVolumeVector(List<Float> values, VolumeUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.
FloatVolumeVector(List<FloatVolume> values, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.
FloatVolumeVector(SortedMap<Integer,Float> values, VolumeUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.
FloatVolumeVector(SortedMap<Integer,FloatVolume> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatVolumeVector.

Method Summary

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

FloatVolumeVector

public FloatVolumeVector(float[] values,
                         VolumeUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatVolumeVector

public FloatVolumeVector(List<Float> values,
                         VolumeUnit unit,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatVolumeVector

public FloatVolumeVector(FloatVolume[] values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatVolumeVector

public FloatVolumeVector(List<FloatVolume> values,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatVolumeVector

public FloatVolumeVector(SortedMap<Integer,FloatVolume> values,
                         int length,
                         StorageType storageType)
                  throws ValueException

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatVolumeVector

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

Construct a new Relative Immutable Float FloatVolumeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatVolumeVector

FloatVolumeVector(FloatVectorData data,
                  VolumeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatVolumeVector instantiateType(FloatVectorData dvd,
                                                  VolumeUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<VolumeUnit,FloatVolumeVector,MutableFloatVolumeVector,FloatVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatVolumeVector instantiateMutableType(FloatVectorData dvd,
                                                                VolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<VolumeUnit,FloatVolumeVector,MutableFloatVolumeVector,FloatVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatVolume instantiateScalar(float value,
                                              VolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<VolumeUnit,FloatVolumeVector,MutableFloatVolumeVector,FloatVolume>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatVolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatVolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatVolume[] toArray()

Return an array of FloatVolume Scalars from this vector.

Returns:

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

Throws:

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