org.djunits.value.vfloat.vector

Class FloatFlowVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

org.djunits.value.vfloat.vector.FloatFlowVolumeVector

All Implemented Interfaces:

Serializable, Iterable<FloatFlowVolume>, Relative, Value<FlowVolumeUnit>, FloatVectorInterface<FlowVolumeUnit>

public class FloatFlowVolumeVector
extends AbstractFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Immutable Float FloatFlowVolumeVector, a vector of values with a FlowVolumeUnit.

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

Method Summary

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

FloatFlowVolumeVector

public FloatFlowVolumeVector(float[] values,
                             FlowVolumeUnit unit,
                             StorageType storageType)
                      throws ValueException

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFlowVolumeVector

public FloatFlowVolumeVector(List<Float> values,
                             FlowVolumeUnit unit,
                             StorageType storageType)
                      throws ValueException

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFlowVolumeVector

public FloatFlowVolumeVector(FloatFlowVolume[] values,
                             StorageType storageType)
                      throws ValueException

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFlowVolumeVector

public FloatFlowVolumeVector(List<FloatFlowVolume> values,
                             StorageType storageType)
                      throws ValueException

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFlowVolumeVector

public FloatFlowVolumeVector(SortedMap<Integer,FloatFlowVolume> values,
                             int length,
                             StorageType storageType)
                      throws ValueException

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatFlowVolumeVector

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

Construct a new Relative Immutable Float FloatFlowVolumeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatFlowVolumeVector

FloatFlowVolumeVector(FloatVectorData data,
                      FlowVolumeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatFlowVolumeVector instantiateType(FloatVectorData dvd,
                                                      FlowVolumeUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatFlowVolumeVector instantiateMutableType(FloatVectorData dvd,
                                                                    FlowVolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatFlowVolume instantiateScalar(float value,
                                                  FlowVolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatFlowVolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatFlowVolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatFlowVolume[] toArray()

Return an array of FloatFlowVolume Scalars from this vector.

Returns:

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

Throws:

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