org.djunits.value.vfloat.vector

Class FloatDurationVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.vector.TypedFloatVectorRel<TimeUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

org.djunits.value.vfloat.vector.FloatDurationVector

All Implemented Interfaces:

Serializable, FunctionsRel<TimeUnit,FloatVector.Abs<TimeUnit>,FloatVector.Rel<TimeUnit>>, Relative, Value<TimeUnit>, FloatVectorInterface<TimeUnit>

public class FloatDurationVector
extends TypedFloatVectorRel<TimeUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Relative FloatDuration Vector.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.FloatVector

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

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FloatDuration	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatDurationVector	instantiateMutableType(FloatVectorData dvd, TimeUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatDurationVector	instantiateType(FloatVectorData dvd, TimeUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatTimeVector	toAbs() Translate the relative vector into an absolute vector (e.g., before or after a multiplication or division).

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

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

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

divide, minus, plus, plus, times

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

Constructor Detail

FloatDurationVector

public FloatDurationVector(float[] values,
                           TimeUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDurationVector

public FloatDurationVector(List<Float> values,
                           TimeUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDurationVector

public FloatDurationVector(FloatDuration[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDurationVector

public FloatDurationVector(List<FloatDuration> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDurationVector

public FloatDurationVector(SortedMap<Integer,FloatDuration> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatDurationVector

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

Construct a new Relative Immutable FloatDurationVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatDurationVector

FloatDurationVector(FloatVectorData data,
                    TimeUnit unit)

Construct a new Relative Immutable FloatDurationVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatDurationVector instantiateType(FloatVectorData dvd,
                                                    TimeUnit unit)

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

Specified by:

instantiateType in class TypedFloatVectorRel<TimeUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatDurationVector instantiateMutableType(FloatVectorData dvd,
                                                                  TimeUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatVectorRel<TimeUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatDuration get(int index)
                        throws ValueException

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

Specified by:

get in interface FloatVectorInterface<TimeUnit>

Specified by:

get in class TypedFloatVectorRel<TimeUnit,FloatDurationVector,MutableFloatDurationVector,FloatDuration>

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())

toAbs

public final FloatTimeVector toAbs()

Translate the relative vector into an absolute vector (e.g., before or after a multiplication or division).

Returns:

an absolute version of this relative FloatDuration vector.