org.djunits.value.vdouble.vector

Class FlowMassVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.DoubleVector.Rel<U>

org.djunits.value.vdouble.vector.TypedDoubleVectorRel<FlowMassUnit,FlowMassVector,MutableFlowMassVector,FlowMass>

org.djunits.value.vdouble.vector.FlowMassVector

All Implemented Interfaces:

Serializable, FunctionsRel<FlowMassUnit,DoubleVector.Abs<FlowMassUnit>,DoubleVector.Rel<FlowMassUnit>>, Relative, Value<FlowMassUnit>, DoubleVectorInterface<FlowMassUnit>

public class FlowMassVector
extends TypedDoubleVectorRel<FlowMassUnit,FlowMassVector,MutableFlowMassVector,FlowMass>

Immutable Double FlowMassVector, a vector of values with a FlowMassUnit.

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.vdouble.vector.DoubleVector

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

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.DoubleVector

data

Constructor Summary

Constructors

Constructor and Description
FlowMassVector(double[] values, FlowMassUnit unit, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.
FlowMassVector(DoubleVectorData data, FlowMassUnit unit)
FlowMassVector(FlowMass[] values, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.
FlowMassVector(List<Double> values, FlowMassUnit unit, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.
FlowMassVector(List<FlowMass> values, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.
FlowMassVector(SortedMap<Integer,Double> values, FlowMassUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.
FlowMassVector(SortedMap<Integer,FlowMass> values, int length, StorageType storageType) Construct a new Relative Immutable Double FlowMassVector.

Method Summary

Modifier and Type	Method and Description
FlowMass	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutableFlowMassVector	instantiateMutableType(DoubleVectorData dvd, FlowMassUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected FlowMassVector	instantiateType(DoubleVectorData dvd, FlowMassUnit unit) Construct a new Relative Immutable DoubleVector of the right type.

Methods inherited from class org.djunits.value.vdouble.vector.TypedDoubleVectorRel

divide, minus, mutable, plus, times, toDense, toSparse

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector.Rel

divide, minus, plus, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector

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

Constructor Detail

FlowMassVector

public FlowMassVector(double[] values,
                      FlowMassUnit unit,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

values - double[]; the values of the entries in the new Relative Immutable Double FlowMassVector

unit - U; the unit of the new Relative Immutable Double FlowMassVector

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

Throws:

ValueException - when values is null

FlowMassVector

public FlowMassVector(List<Double> values,
                      FlowMassUnit unit,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double FlowMassVector

unit - U; the unit of the new Relative Immutable Double FlowMassVector

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

Throws:

ValueException - when values is null

FlowMassVector

public FlowMassVector(FlowMass[] values,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double FlowMassVector

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

Throws:

ValueException - when values has zero entries

FlowMassVector

public FlowMassVector(List<FlowMass> values,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double FlowMassVector

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

Throws:

ValueException - when values has zero entries

FlowMassVector

public FlowMassVector(SortedMap<Integer,FlowMass> values,
                      int length,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double FlowMassVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FlowMassVector

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

Construct a new Relative Immutable Double FlowMassVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable Double FlowMassVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FlowMassVector

FlowMassVector(DoubleVectorData data,
               FlowMassUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FlowMassVector instantiateType(DoubleVectorData dvd,
                                               FlowMassUnit unit)

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

Specified by:

instantiateType in class TypedDoubleVectorRel<FlowMassUnit,FlowMassVector,MutableFlowMassVector,FlowMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableFlowMassVector instantiateMutableType(DoubleVectorData dvd,
                                                             FlowMassUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorRel<FlowMassUnit,FlowMassVector,MutableFlowMassVector,FlowMass>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final FlowMass get(int index)
                   throws ValueException

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

Specified by:

get in interface DoubleVectorInterface<FlowMassUnit>

Specified by:

get in class TypedDoubleVectorRel<FlowMassUnit,FlowMassVector,MutableFlowMassVector,FlowMass>

Parameters:

index - int; index of the value to retrieve

Returns:

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

Throws:

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