org.djunits.value.vfloat.vector

Class FloatFlowMassVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<FlowMassUnit,FloatFlowMassVector,MutableFloatFlowMassVector,FloatFlowMass>

org.djunits.value.vfloat.vector.FloatFlowMassVector

All Implemented Interfaces:

Serializable, Iterable<FloatFlowMass>, Relative, Value<FlowMassUnit>, FloatVectorInterface<FlowMassUnit>

public class FloatFlowMassVector
extends AbstractFloatVectorRel<FlowMassUnit,FloatFlowMassVector,MutableFloatFlowMassVector,FloatFlowMass>

Immutable Float FloatFlowMassVector, a vector of values with a FlowMassUnit.

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

Method Summary

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

FloatFlowMassVector

public FloatFlowMassVector(float[] values,
                           FlowMassUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFlowMassVector

public FloatFlowMassVector(List<Float> values,
                           FlowMassUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatFlowMassVector

public FloatFlowMassVector(FloatFlowMass[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFlowMassVector

public FloatFlowMassVector(List<FloatFlowMass> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatFlowMassVector

public FloatFlowMassVector(SortedMap<Integer,FloatFlowMass> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatFlowMassVector

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

Construct a new Relative Immutable Float FloatFlowMassVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatFlowMassVector

FloatFlowMassVector(FloatVectorData data,
                    FlowMassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatFlowMassVector instantiateType(FloatVectorData dvd,
                                                    FlowMassUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<FlowMassUnit,FloatFlowMassVector,MutableFloatFlowMassVector,FloatFlowMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatFlowMassVector instantiateMutableType(FloatVectorData dvd,
                                                                  FlowMassUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<FlowMassUnit,FloatFlowMassVector,MutableFloatFlowMassVector,FloatFlowMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatFlowMass instantiateScalar(float value,
                                                FlowMassUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<FlowMassUnit,FloatFlowMassVector,MutableFloatFlowMassVector,FloatFlowMass>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatFlowMassVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatFlowMassVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatFlowMass[] toArray()

Return an array of FloatFlowMass Scalars from this vector.

Returns:

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

Throws:

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