org.djunits.value.vdouble.vector

Class TimeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<AU,A>

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

org.djunits.value.vdouble.vector.TimeVector

All Implemented Interfaces:

Serializable, Iterable<Time>, Absolute, FunctionsAbs<TimeUnit,DurationUnit,TimeVector,DurationVector>, Value<TimeUnit>, DoubleVectorInterface<TimeUnit>

public class TimeVector
extends AbstractDoubleVectorAbs<TimeUnit,DurationUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Immutable Absolute Time Vector.

Copyright (c) 2013-2019 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.AbstractDoubleVectorAbs

AbstractDoubleVectorAbs.Itr

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

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
protected MutableTimeVector	instantiateMutableType(DoubleVectorData dvd, TimeUnit unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected Time	instantiateScalar(double value, TimeUnit unit) Construct a new Absolute Immutable DoubleScalar 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, DurationUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Time[]	toArray() Return an array of Time Scalars from this vector.
TimeVector	toDense() return a dense version of this vector.
TimeVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorAbs

checkUnit, checkUnit, checkUnit, get, iterator, minus, minus, mutable, plus

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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 - TimeUnit; the unit of the new Absolute Immutable Double TimeVector

storageType - 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<Double>; the values of the entries in the new Absolute Immutable Double TimeVector

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

storageType - 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 - Time[]; the values of the entries in the new Absolute Immutable Double TimeVector

storageType - 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<Time>; the values of the entries in the new Absolute Immutable Double TimeVector

storageType - 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 - SortedMap<Integer, Time>; the values of the entries in the new Absolute Sparse Mutable Double TimeVector

length - int; the size of the vector

storageType - 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 - SortedMap<Integer, Double>; the map of indexes to values of the Absolute Sparse Mutable Double TimeVector

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

length - int; the size of the vector

storageType - 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 - DoubleVectorData; an internal data object

unit - TimeUnit; 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 AbstractDoubleVectorAbs<TimeUnit,DurationUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateTypeRel

protected final DurationVector instantiateTypeRel(DoubleVectorData dvd,
                                                  DurationUnit unit)

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

Specified by:

instantiateTypeRel in class AbstractDoubleVectorAbs<TimeUnit,DurationUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - RU; 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 AbstractDoubleVectorAbs<TimeUnit,DurationUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateScalar

protected final Time instantiateScalar(double value,
                                       TimeUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorAbs<TimeUnit,DurationUnit,TimeVector,DurationVector,MutableTimeVector,Time>

Parameters:

value - double; the value

unit - AU; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final TimeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final TimeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Time[] toArray()

Return an array of Time Scalars from this vector.

Returns:

Time[]; an array of Time Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values