org.djunits.value.vfloat.vector

Class MutableFloatFlowVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.FloatVector<U>

org.djunits.value.vfloat.vector.MutableFloatVector<U>

org.djunits.value.vfloat.vector.MutableFloatVector.Rel<U>

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

org.djunits.value.vfloat.vector.MutableFloatFlowVolumeVector

All Implemented Interfaces:

Serializable, FunctionsRel<FlowVolumeUnit,FloatVector.Abs<FlowVolumeUnit>,FloatVector.Rel<FlowVolumeUnit>>, MathFunctionsAbs<MutableFloatVector.Rel<FlowVolumeUnit>>, MathFunctionsRel<MutableFloatVector.Rel<FlowVolumeUnit>>, Relative, Value<FlowVolumeUnit>, FloatMathFunctions<MutableFloatVector.Rel<FlowVolumeUnit>>, FloatVectorInterface<FlowVolumeUnit>, MutableFloatVectorInterface<FlowVolumeUnit>

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

Mutable FloatFlowVolumeVector, a vector of values with a FlowVolumeUnit.

Copyright (c) 2013-2016 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.MutableFloatVector

MutableFloatVector.Abs<U extends Unit<U>>, MutableFloatVector.Rel<U extends Unit<U>>

Field Summary

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

data

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FloatFlowVolume	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatFlowVolumeVector	instantiateMutableType(FloatVectorData dvd, FlowVolumeUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatFlowVolumeVector	instantiateType(FloatVectorData dvd, FlowVolumeUnit unit) Construct a new Relative Immutable FloatVector of the right type.

Methods inherited from class org.djunits.value.vfloat.vector.MutableTypedFloatVectorRel

abs, ceil, copy, divide, divideBy, floor, immutable, minus, multiplyBy, mutable, plus, rint, round, times, toDense, toSparse

Methods inherited from class org.djunits.value.vfloat.vector.MutableFloatVector.Rel

decrementBy, decrementBy, decrementBy, divide, divideBy, divideBy, incrementBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, plus, times

Methods inherited from class org.djunits.value.vfloat.vector.MutableFloatVector

assign, checkCopyOnWrite, instantiateMutableAbs, normalize, set, setCopyOnWrite, setInUnit, setSI

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.vfloat.FloatMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

cardinality, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Constructor Detail

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable FloatFlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable FloatFlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable 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

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable FloatFlowVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable 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

MutableFloatFlowVolumeVector

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

Construct a new Relative Immutable FloatFlowVolumeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MutableFloatFlowVolumeVector

MutableFloatFlowVolumeVector(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 MutableTypedFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable 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 MutableTypedFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatFlowVolume get(int index)
                          throws ValueException

Retrieve the value stored at a specified index as a FloatScalar.

Specified by:

get in interface FloatVectorInterface<FlowVolumeUnit>

Specified by:

get in class MutableTypedFloatVectorRel<FlowVolumeUnit,FloatFlowVolumeVector,MutableFloatFlowVolumeVector,FloatFlowVolume>

Parameters:

index - int; index of the value to retrieve

Returns:

FloatScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())