org.djunits.value.vdouble.vector

Class FlowVolumeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<FlowVolumeUnit,FlowVolumeVector,MutableFlowVolumeVector,FlowVolume>

org.djunits.value.vdouble.vector.FlowVolumeVector

All Implemented Interfaces:

Serializable, Iterable<FlowVolume>, Relative, Value<FlowVolumeUnit>, DoubleVectorInterface<FlowVolumeUnit>

public class FlowVolumeVector
extends AbstractDoubleVectorRel<FlowVolumeUnit,FlowVolumeVector,MutableFlowVolumeVector,FlowVolume>

Immutable Double FlowVolumeVector, 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.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableFlowVolumeVector	instantiateMutableType(DoubleVectorData dvd, FlowVolumeUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected FlowVolume	instantiateScalar(double value, FlowVolumeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected FlowVolumeVector	instantiateType(DoubleVectorData dvd, FlowVolumeUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
FlowVolume[]	toArray() Return an array of FlowVolume Scalars from this vector.
FlowVolumeVector	toDense() return a dense version of this vector.
FlowVolumeVector	toSparse() return a sparse version of this vector.

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

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

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

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

FlowVolumeVector

public FlowVolumeVector(double[] values,
                        FlowVolumeUnit unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FlowVolumeVector

public FlowVolumeVector(List<Double> values,
                        FlowVolumeUnit unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FlowVolumeVector

public FlowVolumeVector(FlowVolume[] values,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FlowVolumeVector

public FlowVolumeVector(List<FlowVolume> values,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FlowVolumeVector

public FlowVolumeVector(SortedMap<Integer,FlowVolume> values,
                        int length,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FlowVolumeVector

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

Construct a new Relative Immutable Double FlowVolumeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FlowVolumeVector

FlowVolumeVector(DoubleVectorData data,
                 FlowVolumeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FlowVolumeVector instantiateType(DoubleVectorData dvd,
                                                 FlowVolumeUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<FlowVolumeUnit,FlowVolumeVector,MutableFlowVolumeVector,FlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableFlowVolumeVector instantiateMutableType(DoubleVectorData dvd,
                                                               FlowVolumeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<FlowVolumeUnit,FlowVolumeVector,MutableFlowVolumeVector,FlowVolume>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final FlowVolume instantiateScalar(double value,
                                             FlowVolumeUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<FlowVolumeUnit,FlowVolumeVector,MutableFlowVolumeVector,FlowVolume>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final FlowVolumeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FlowVolumeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FlowVolume[] toArray()

Return an array of FlowVolume Scalars from this vector.

Returns:

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

Throws:

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