org.djunits.value.vdouble.vector

Class DurationVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.vector.TypedDoubleVectorRel<TimeUnit,DurationVector,MutableDurationVector,Duration>

org.djunits.value.vdouble.vector.DurationVector

All Implemented Interfaces:

Serializable, FunctionsRel<TimeUnit,DoubleVector.Abs<TimeUnit>,DoubleVector.Rel<TimeUnit>>, Relative, Value<TimeUnit>, DoubleVectorInterface<TimeUnit>

public class DurationVector
extends TypedDoubleVectorRel<TimeUnit,DurationVector,MutableDurationVector,Duration>

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

Method Summary

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

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

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

divide, minus, plus, plus, times

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

DurationVector

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

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

DurationVector

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

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

DurationVector

public DurationVector(Duration[] values,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

DurationVector

public DurationVector(List<Duration> values,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

DurationVector

public DurationVector(SortedMap<Integer,Duration> values,
                      int length,
                      StorageType storageType)
               throws ValueException

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

DurationVector

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

Construct a new Relative Immutable Double DurationVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

DurationVector

DurationVector(DoubleVectorData data,
               TimeUnit unit)

Construct a new Relative Immutable Double DurationVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final DurationVector instantiateType(DoubleVectorData dvd,
                                               TimeUnit unit)

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

Specified by:

instantiateType in class TypedDoubleVectorRel<TimeUnit,DurationVector,MutableDurationVector,Duration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutableDurationVector instantiateMutableType(DoubleVectorData dvd,
                                                             TimeUnit unit)

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

Specified by:

instantiateMutableType in class TypedDoubleVectorRel<TimeUnit,DurationVector,MutableDurationVector,Duration>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final Duration 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 TypedDoubleVectorRel<TimeUnit,DurationVector,MutableDurationVector,Duration>

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

toAbs

public final TimeVector 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 Duration vector.