org.djunits.value.vfloat.vector

Class FloatTimeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.vector.TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

org.djunits.value.vfloat.vector.FloatTimeVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<TimeUnit,FloatVector.Abs<TimeUnit>,FloatVector.Rel<TimeUnit>>, Value<TimeUnit>, FloatVectorInterface<TimeUnit>

public class FloatTimeVector
extends TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

Absolute FloatTime 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
FloatTimeVector(float[] values, TimeUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(FloatTime[] values, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(FloatVectorData data, TimeUnit unit) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(List<Float> values, TimeUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(List<FloatTime> values, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(SortedMap<Integer,Float> values, TimeUnit unit, int length, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.
FloatTimeVector(SortedMap<Integer,FloatTime> values, int length, StorageType storageType) Construct a new Absolute Immutable FloatTimeVector.

Method Summary

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

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

minus, minus, mutable, plus, toDense, toSparse

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

minus, minus, plus

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

FloatTimeVector

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

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

values - float[]; the values of the entries in the new Absolute Immutable FloatTimeVector

unit - U; the unit of the new Absolute Immutable FloatTimeVector

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

Throws:

ValueException - when values is null

FloatTimeVector

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

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable FloatTimeVector

unit - U; the unit of the new Absolute Immutable FloatTimeVector

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

Throws:

ValueException - when values is null

FloatTimeVector

public FloatTimeVector(FloatTime[] values,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatTimeVector

public FloatTimeVector(List<FloatTime> values,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable FloatTimeVector

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

Throws:

ValueException - when values has zero entries

FloatTimeVector

public FloatTimeVector(SortedMap<Integer,FloatTime> values,
                       int length,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatTimeVector

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

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

values - Map; the map of indexes to values of the Absolute Sparse Mutable FloatTimeVector

unit - U; the unit of the new Absolute Sparse Mutable FloatTimeVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatTimeVector

FloatTimeVector(FloatVectorData data,
                TimeUnit unit)

Construct a new Absolute Immutable FloatTimeVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final FloatTimeVector instantiateTypeAbs(FloatVectorData dvd,
                                                   TimeUnit unit)

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

Specified by:

instantiateTypeAbs in class TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateTypeRel

protected final FloatDurationVector instantiateTypeRel(FloatVectorData dvd,
                                                       TimeUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatTimeVector instantiateMutableType(FloatVectorData dvd,
                                                              TimeUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatTime 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 TypedFloatVectorAbs<TimeUnit,FloatTimeVector,FloatDurationVector,MutableFloatTimeVector,FloatTime>

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

toRel

public final FloatDurationVector toRel()

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

Returns:

a relative version of this absolute FloatTime vector.