org.djunits.value.vdouble.vector

Class MutableDurationVector

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.Rel<U>

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

org.djunits.value.vdouble.vector.MutableDurationVector

All Implemented Interfaces:

Serializable, FunctionsRel<TimeUnit,DoubleVector.Abs<TimeUnit>,DoubleVector.Rel<TimeUnit>>, MathFunctionsAbs<MutableDoubleVector.Rel<TimeUnit>>, MathFunctionsRel<MutableDoubleVector.Rel<TimeUnit>>, Relative, Value<TimeUnit>, DoubleMathFunctions<MutableDoubleVector.Rel<TimeUnit>>, DoubleVectorInterface<TimeUnit>, MutableDoubleVectorInterface<TimeUnit>

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

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

abs, ceil, copy, divide, divideBy, floor, immutable, minus, multiplyBy, mutable, plus, rint, round, times, toDense, toSparse

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

decrementBy, decrementBy, decrementBy, divide, divideBy, divideBy, incrementBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, plus, times

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

MutableDurationVector

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

Construct a new Relative Mutable Double DurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableDurationVector

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

Construct a new Relative Mutable Double DurationVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableDurationVector

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

Construct a new Relative Mutable Double DurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableDurationVector

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

Construct a new Relative Mutable Double DurationVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableDurationVector

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

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

MutableDurationVector

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

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

MutableDurationVector

MutableDurationVector(DoubleVectorData data,
                      TimeUnit unit)

Construct a new Relative Mutable 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 MutableTypedDoubleVectorRel<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 MutableTypedDoubleVectorRel<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 MutableTypedDoubleVectorRel<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 MutableTimeVector 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.