org.djunits.value.vfloat.vector

Class MutableFloatTimeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

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

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

org.djunits.value.vfloat.vector.MutableFloatTimeVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<TimeUnit,FloatVector.Abs<TimeUnit>,FloatVector.Rel<TimeUnit>>, MathFunctionsAbs<MutableFloatVector.Abs<TimeUnit>>, Value<TimeUnit>, FloatMathFunctions<MutableFloatVector.Abs<TimeUnit>>, FloatVectorInterface<TimeUnit>, MutableFloatVectorInterface<TimeUnit>

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

Mutable Absolute FloatTime Vector a vector of values with a TimeUnit.

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.MutableFloatVector

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

Field Summary

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

data

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

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

ceil, copy, divideBy, floor, immutable, multiplyBy, mutable, rint, round, toDense, toSparse

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

decrementBy, decrementBy, decrementBy, divideBy, divideBy, incrementBy, incrementBy, incrementBy, minus, minus, multiplyBy, multiplyBy, plus

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

assign, checkCopyOnWrite, instantiateMutableAbs, normalize, set, setCopyOnWrite, setInUnit, setSI

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

Methods inherited from interface org.djunits.value.vfloat.FloatMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

cardinality, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Constructor Detail

MutableFloatTimeVector

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

Construct a new Absolute Mutable FloatTimeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableFloatTimeVector

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

Construct a new Absolute Mutable FloatTimeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableFloatTimeVector

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

Construct a new Absolute Mutable FloatTimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableFloatTimeVector

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

Construct a new Absolute Mutable FloatTimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableFloatTimeVector

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

Construct a new Absolute Mutable 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

MutableFloatTimeVector

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

Construct a new Absolute Mutable 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

MutableFloatTimeVector

MutableFloatTimeVector(FloatVectorData data,
                       TimeUnit unit)

Construct a new Absolute Mutable 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 MutableTypedFloatVectorAbs<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 MutableTypedFloatVectorAbs<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 MutableTypedFloatVectorAbs<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 MutableTypedFloatVectorAbs<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 MutableFloatDurationVector 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.