org.djunits.value.vdouble.vector

Class TimeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.vector.TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

org.djunits.value.vdouble.vector.TimeVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<TimeUnit,DoubleVector.Abs<TimeUnit>,DoubleVector.Rel<TimeUnit>>, Value<TimeUnit>, DoubleVectorInterface<TimeUnit>

public class TimeVector
extends TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Immutable Absolute Time 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.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
TimeVector(double[] values, TimeUnit unit, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.
TimeVector(DoubleVectorData data, TimeUnit unit) Construct a new Absolute Immutable Double TimeVector.
TimeVector(List<Double> values, TimeUnit unit, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.
TimeVector(List<Time> values, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.
TimeVector(SortedMap<Integer,Double> values, TimeUnit unit, int length, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.
TimeVector(SortedMap<Integer,Time> values, int length, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.
TimeVector(Time[] values, StorageType storageType) Construct a new Absolute Immutable Double TimeVector.

Method Summary

Modifier and Type	Method and Description
Time	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutableTimeVector	instantiateMutableType(DoubleVectorData dvd, TimeUnit unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected TimeVector	instantiateTypeAbs(DoubleVectorData dvd, TimeUnit unit) Construct a new Absolute Immutable DoubleVector of the right type.
protected DurationVector	instantiateTypeRel(DoubleVectorData dvd, TimeUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
DurationVector	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.vdouble.vector.TypedDoubleVectorAbs

minus, minus, mutable, plus, toDense, toSparse

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

minus, minus, plus

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

TimeVector

public TimeVector(double[] values,
                  TimeUnit unit,
                  StorageType storageType)
           throws ValueException

Construct a new Absolute Immutable Double TimeVector.

Parameters:

values - double[]; the values of the entries in the new Absolute Immutable Double TimeVector

unit - U; the unit of the new Absolute Immutable Double TimeVector

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

Throws:

ValueException - when values is null

TimeVector

public TimeVector(List<Double> values,
                  TimeUnit unit,
                  StorageType storageType)
           throws ValueException

Construct a new Absolute Immutable Double TimeVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable Double TimeVector

unit - U; the unit of the new Absolute Immutable Double TimeVector

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

Throws:

ValueException - when values is null

TimeVector

public TimeVector(Time[] values,
                  StorageType storageType)
           throws ValueException

Construct a new Absolute Immutable Double TimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

TimeVector

public TimeVector(List<Time> values,
                  StorageType storageType)
           throws ValueException

Construct a new Absolute Immutable Double TimeVector.

Parameters:

values - List; the values of the entries in the new Absolute Immutable Double TimeVector

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

Throws:

ValueException - when values has zero entries

TimeVector

public TimeVector(SortedMap<Integer,Time> values,
                  int length,
                  StorageType storageType)
           throws ValueException

Construct a new Absolute Immutable Double TimeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

TimeVector

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

Construct a new Absolute Immutable Double TimeVector.

Parameters:

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

unit - U; the unit of the new Absolute Sparse Mutable Double TimeVector

length - the size of the vector

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

Throws:

ValueException - when values is null

TimeVector

TimeVector(DoubleVectorData data,
           TimeUnit unit)

Construct a new Absolute Immutable Double TimeVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final TimeVector instantiateTypeAbs(DoubleVectorData dvd,
                                              TimeUnit unit)

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

Specified by:

instantiateTypeAbs in class TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateTypeRel

protected final DurationVector instantiateTypeRel(DoubleVectorData dvd,
                                                  TimeUnit unit)

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

Specified by:

instantiateTypeRel in class TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableTimeVector instantiateMutableType(DoubleVectorData dvd,
                                                         TimeUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final Time get(int index)
               throws ValueException

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

Specified by:

get in interface DoubleVectorInterface<TimeUnit>

Specified by:

get in class TypedDoubleVectorAbs<TimeUnit,TimeVector,DurationVector,MutableTimeVector,Time>

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

toRel

public final DurationVector 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 Time vector.