org.djunits.value.vdouble.vector

Class MutableTimeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

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

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

org.djunits.value.vdouble.vector.MutableTimeVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<TimeUnit,DoubleVector.Abs<TimeUnit>,DoubleVector.Rel<TimeUnit>>, MathFunctionsAbs<MutableDoubleVector.Abs<TimeUnit>>, Value<TimeUnit>, DoubleMathFunctions<MutableDoubleVector.Abs<TimeUnit>>, DoubleVectorInterface<TimeUnit>, MutableDoubleVectorInterface<TimeUnit>

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

Mutable 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.MutableDoubleVector

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

Field Summary

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

data

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

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

Constructor Summary

Constructors

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

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

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

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

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

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

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vdouble.vector.DoubleVectorInterface

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

Constructor Detail

MutableTimeVector

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

Construct a new Absolute Mutable Double TimeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableTimeVector

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

Construct a new Absolute Mutable Double TimeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableTimeVector

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

Construct a new Absolute Mutable Double TimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableTimeVector

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

Construct a new Absolute Mutable Double TimeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableTimeVector

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

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

MutableTimeVector

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

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

MutableTimeVector

MutableTimeVector(DoubleVectorData data,
                  TimeUnit unit)

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