org.djunits.value.vdouble.vector

Class MutablePositionVector

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<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

org.djunits.value.vdouble.vector.MutablePositionVector

All Implemented Interfaces:

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

public class MutablePositionVector
extends MutableTypedDoubleVectorAbs<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Mutable Absolute Position 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
MutablePositionVector(double[] values, LengthUnit unit, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(DoubleVectorData data, LengthUnit unit) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(List<Double> values, LengthUnit unit, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(List<Position> values, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(Position[] values, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(SortedMap<Integer,Double> values, LengthUnit unit, int length, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.
MutablePositionVector(SortedMap<Integer,Position> values, int length, StorageType storageType) Construct a new Absolute Mutable Double PositionVector.

Method Summary

Modifier and Type	Method and Description
Position	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
protected MutablePositionVector	instantiateMutableType(DoubleVectorData dvd, LengthUnit unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected PositionVector	instantiateTypeAbs(DoubleVectorData dvd, LengthUnit unit) Construct a new Absolute Immutable DoubleVector of the right type.
protected LengthVector	instantiateTypeRel(DoubleVectorData dvd, LengthUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
MutableLengthVector	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

MutablePositionVector

public MutablePositionVector(double[] values,
                             LengthUnit unit,
                             StorageType storageType)
                      throws ValueException

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutablePositionVector

public MutablePositionVector(List<Double> values,
                             LengthUnit unit,
                             StorageType storageType)
                      throws ValueException

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutablePositionVector

public MutablePositionVector(Position[] values,
                             StorageType storageType)
                      throws ValueException

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutablePositionVector

public MutablePositionVector(List<Position> values,
                             StorageType storageType)
                      throws ValueException

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutablePositionVector

public MutablePositionVector(SortedMap<Integer,Position> values,
                             int length,
                             StorageType storageType)
                      throws ValueException

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MutablePositionVector

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

Construct a new Absolute Mutable Double PositionVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MutablePositionVector

MutablePositionVector(DoubleVectorData data,
                      LengthUnit unit)

Construct a new Absolute Mutable Double PositionVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final PositionVector instantiateTypeAbs(DoubleVectorData dvd,
                                                  LengthUnit unit)

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

Specified by:

instantiateTypeAbs in class MutableTypedDoubleVectorAbs<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateTypeRel

protected final LengthVector instantiateTypeRel(DoubleVectorData dvd,
                                                LengthUnit unit)

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

Specified by:

instantiateTypeRel in class MutableTypedDoubleVectorAbs<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutablePositionVector instantiateMutableType(DoubleVectorData dvd,
                                                             LengthUnit unit)

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

Specified by:

instantiateMutableType in class MutableTypedDoubleVectorAbs<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable DoubleVector of the right type

get

public final Position get(int index)
                   throws ValueException

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

Specified by:

get in interface DoubleVectorInterface<LengthUnit>

Specified by:

get in class MutableTypedDoubleVectorAbs<LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

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 MutableLengthVector 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 Position vector.