org.djunits.value.vdouble.vector

Class PositionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

org.djunits.value.vdouble.vector.PositionVector

All Implemented Interfaces:

Serializable, Iterable<Position>, Absolute, FunctionsAbs<PositionUnit,LengthUnit,PositionVector,LengthVector>, Value<PositionUnit>, DoubleVectorInterface<PositionUnit>

public class PositionVector
extends AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

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

Method Summary

Modifier and Type	Method and Description
protected MutablePositionVector	instantiateMutableType(DoubleVectorData dvd, PositionUnit unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected Position	instantiateScalar(double value, PositionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
protected PositionVector	instantiateTypeAbs(DoubleVectorData dvd, PositionUnit 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.
Position[]	toArray() Return an array of Position Scalars from this vector.
PositionVector	toDense() return a dense version of this vector.
PositionVector	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

PositionVector

public PositionVector(double[] values,
                      PositionUnit unit,
                      StorageType storageType)
               throws ValueException

Construct a new Absolute Immutable Double PositionVector.

Parameters:

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

unit - PositionUnit; the unit of the new Absolute Immutable Double PositionVector

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

Throws:

ValueException - when values is null

PositionVector

public PositionVector(List<Double> values,
                      PositionUnit unit,
                      StorageType storageType)
               throws ValueException

Construct a new Absolute Immutable Double PositionVector.

Parameters:

values - List<Double>; the values of the entries in the new Absolute Immutable Double PositionVector

unit - PositionUnit; the unit of the new Absolute Immutable Double PositionVector

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

Throws:

ValueException - when values is null

PositionVector

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

Construct a new Absolute Immutable Double PositionVector.

Parameters:

values - Position[]; the values of the entries in the new Absolute Immutable Double PositionVector

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

Throws:

ValueException - when values has zero entries

PositionVector

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

Construct a new Absolute Immutable Double PositionVector.

Parameters:

values - List<Position>; the values of the entries in the new Absolute Immutable Double PositionVector

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

Throws:

ValueException - when values has zero entries

PositionVector

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

Construct a new Absolute Immutable Double PositionVector.

Parameters:

values - SortedMap<Integer, Position>; the values of the entries in the new Absolute Sparse Mutable Double PositionVector

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

PositionVector

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

Construct a new Absolute Immutable Double PositionVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Absolute Sparse Mutable Double PositionVector

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

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

PositionVector

PositionVector(DoubleVectorData data,
               PositionUnit unit)

Construct a new Absolute Immutable Double PositionVector.

Parameters:

data - DoubleVectorData; an internal data object

unit - PositionUnit; the unit

Method Detail

instantiateTypeAbs

protected final PositionVector instantiateTypeAbs(DoubleVectorData dvd,
                                                  PositionUnit unit)

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

Specified by:

instantiateTypeAbs in class AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; 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 AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - RU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected final MutablePositionVector instantiateMutableType(DoubleVectorData dvd,
                                                             PositionUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateScalar

protected final Position instantiateScalar(double value,
                                           PositionUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorAbs<PositionUnit,LengthUnit,PositionVector,LengthVector,MutablePositionVector,Position>

Parameters:

value - double; the value

unit - AU; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final PositionVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final PositionVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Position[] toArray()

Return an array of Position Scalars from this vector.

Returns:

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

Throws:

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