Package org.djunits.value.vdouble.vector

Class PositionVector

java.lang.Object

org.djunits.value.IndexedValue<U,S,V,D>

org.djunits.value.base.Vector<U,S,V,DoubleVectorData>

org.djunits.value.vdouble.vector.base.DoubleVector<AU,A,AV>

org.djunits.value.vdouble.vector.base.DoubleVectorAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

org.djunits.value.vdouble.vector.PositionVector

All Implemented Interfaces:

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

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class PositionVector
extends DoubleVectorAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Double PositionVector, a vector of values with a PositionUnit.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.base.DoubleVector

DoubleVector.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor	Description
PositionVector(double[] data)	Construct an PositionVector from a double[] object with SI-unit values.
PositionVector(double[] data, PositionUnit displayUnit)	Construct an PositionVector from a double[] object.
PositionVector(double[] data, PositionUnit displayUnit, StorageType storageType)	Construct an PositionVector from a double[] object.
PositionVector(double[] data, StorageType storageType)	Construct an PositionVector from a double[] object with SI-unit values.
PositionVector(List<? extends Number> data)	Construct an PositionVector from a list of Number objects or a list of Position objects.
PositionVector(List<? extends Number> data, PositionUnit displayUnit)	Construct an PositionVector from a list of Number objects or a list of Position objects.
PositionVector(List<? extends Number> data, PositionUnit displayUnit, StorageType storageType)	Construct an PositionVector from a list of Number objects or a list of Position objects.
PositionVector(List<? extends Number> data, StorageType storageType)	Construct an PositionVector from a list of Number objects or a list of Position objects.
PositionVector(Map<Integer,? extends Number> data, int size)	Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects.
PositionVector(Map<Integer,? extends Number> data, int size, PositionUnit displayUnit)	Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects.
PositionVector(Map<Integer,? extends Number> data, int size, PositionUnit displayUnit, StorageType storageType)	Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects.
PositionVector(Map<Integer,? extends Number> data, int size, StorageType storageType)	Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects.
PositionVector(Position[] data)	Construct an PositionVector from an array of Position objects.
PositionVector(Position[] data, PositionUnit displayUnit)	Construct an PositionVector from an array of Position objects.
PositionVector(Position[] data, PositionUnit displayUnit, StorageType storageType)	Construct an PositionVector from an array of Position objects.
PositionVector(Position[] data, StorageType storageType)	Construct an PositionVector from an array of Position objects.
PositionVector(DoubleVectorData data, PositionUnit displayUnit)	Construct an PositionVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
Class<Position>	getScalarClass()	Return the class of the corresponding scalar.
Length	instantiateScalarRelSI(double valueSI, LengthUnit displayUnit)	Instantiate a new relative scalar for the class of this absolute vector.
Position	instantiateScalarSI(double valueSI, PositionUnit displayUnit)	Instantiate a new scalar for the class of this vector.
PositionVector	instantiateVector(DoubleVectorData dvd, PositionUnit displayUnit)	Instantiate a new vector of the class of this vector.
LengthVector	instantiateVectorRel(DoubleVectorData dvd, LengthUnit displayUnit)	Instantiate a new relative vector of the class of this absolute vector.

Methods inherited from class org.djunits.value.vdouble.vector.base.DoubleVectorAbs

decrementBy, decrementBy, minus, minus, plus

Methods inherited from class org.djunits.value.vdouble.vector.base.DoubleVector

abs, assign, ceil, checkIndex, checkSize, equals, floor, get, getData, getInUnit, getInUnit, getScalars, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, iterator, neg, rint, set, setData, setInUnit, setInUnit, setSI, size, toDense, toSparse, toString, toString, toString, toString

Methods inherited from class org.djunits.value.IndexedValue

cardinality, checkCopyOnWrite, clone, getDisplayUnit, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setDisplayUnit, setMutable

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Constructor Details

PositionVector

public PositionVector(DoubleVectorData data,
 PositionUnit displayUnit)

Construct an PositionVector from an internal data object.

Parameters:

data - DoubleVectorData; the internal data object for the vector

displayUnit - PositionUnit; the display unit of the vector data

PositionVector

public PositionVector(double[] data,
 PositionUnit displayUnit,
 StorageType storageType)

Construct an PositionVector from a double[] object. The double values are expressed in the displayUnit, and will be printed using the displayUnit.

Parameters:

data - double[]; the data for the vector, expressed in the displayUnit

displayUnit - PositionUnit; the unit of the values in the data array, and display unit when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(double[] data,
 PositionUnit displayUnit)

Construct an PositionVector from a double[] object. The double values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - double[]; the data for the vector

displayUnit - PositionUnit; the unit of the values in the data array, and display unit when printing

PositionVector

public PositionVector(double[] data,
 StorageType storageType)

Construct an PositionVector from a double[] object with SI-unit values.

Parameters:

data - double[]; the data for the vector, in SI units

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(double[] data)

Construct an PositionVector from a double[] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - double[]; the data for the vector, in SI units

PositionVector

public PositionVector(Position[] data,
 PositionUnit displayUnit,
 StorageType storageType)

Construct an PositionVector from an array of Position objects. The Position values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.

Parameters:

data - Position[]; the data for the vector

displayUnit - PositionUnit; the display unit of the values when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(Position[] data,
 PositionUnit displayUnit)

Construct an PositionVector from an array of Position objects. The Position values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - Position[]; the data for the vector

displayUnit - PositionUnit; the display unit of the values when printing

PositionVector

public PositionVector(Position[] data,
 StorageType storageType)

Construct an PositionVector from an array of Position objects. The Position values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer the data as an array.

Parameters:

data - Position[]; the data for the vector

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(Position[] data)

Construct an PositionVector from an array of Position objects. The Position values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array.

Parameters:

data - Position[]; the data for the vector

PositionVector

public PositionVector(List<? extends Number> data,
 PositionUnit displayUnit,
 StorageType storageType)

Construct an PositionVector from a list of Number objects or a list of Position objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Position objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed, as well as the unit in which they will be printed. In case the list contains Position objects, each Position has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - List<Double> or List<Position>; the data for the vector

displayUnit - PositionUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(List<? extends Number> data,
 PositionUnit displayUnit)

Construct an PositionVector from a list of Number objects or a list of Position objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Position objects. In case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed, as well as the unit in which they will be printed. In case the list contains Position objects, each Position has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE since we offer the data as a List.

Parameters:

data - List<Double> or List<Position>; the data for the vector

displayUnit - PositionUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

PositionVector

public PositionVector(List<? extends Number> data,
 StorageType storageType)

Construct an PositionVector from a list of Number objects or a list of Position objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - List<Double> or List<Position>; the data for the vector

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(List<? extends Number> data)

Construct an PositionVector from a list of Number objects or a list of Position objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE since we offer the data as a List.

Parameters:

data - List<Double> or List<Position>; the data for the vector

PositionVector

public PositionVector(Map<Integer,? extends Number> data,
 int size,
 PositionUnit displayUnit,
 StorageType storageType)

Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different meaning depending on whether the map contains Number objects (e.g., Double objects) or Position objects. In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the unit in which they will be printed. In case the map contains Position objects, each Position has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - Map<Integer, Double> or Map<Integer, Position>; the data for the vector

size - int; the size off the vector, i.e., the highest index

displayUnit - PositionUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(Map<Integer,? extends Number> data,
 int size,
 PositionUnit displayUnit)

Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different meaning depending on whether the map contains Number objects (e.g., Double objects) or Position objects. In case the map contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the unit in which they will be printed. In case the map contains Position objects, each Position has its own unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer the data as a Map.

Parameters:

data - Map<Integer, Double> or Map<Integer, Position>; the data for the vector

size - int; the size off the vector, i.e., the highest index

displayUnit - PositionUnit; the display unit of the vector data, and the unit of the data points when the data is expressed as List<Double> or List<Number> in general

PositionVector

public PositionVector(Map<Integer,? extends Number> data,
 int size,
 StorageType storageType)

Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing.

Parameters:

data - Map<Integer, Double> or Map<Integer, Position>; the data for the vector

size - int; the size off the vector, i.e., the highest index

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector

PositionVector

public PositionVector(Map<Integer,? extends Number> data,
 int size)

Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of the vector, since the largest index does not have to be part of the map. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer the data as a Map.

Parameters:

data - Map<Integer, Double> or Map<Integer, Position>; the data for the vector

size - int; the size off the vector, i.e., the highest index

Method Details

getScalarClass

public Class<Position> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<PositionUnit,Position,PositionVector,DoubleVectorData>

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public PositionVector instantiateVector(DoubleVectorData dvd,
 PositionUnit displayUnit)

Instantiate a new vector of the class of this vector. This can be used instead of the DoubleVector.instiantiate() methods in case another vector of this class is known. The method is faster than DoubleVector.instantiate, and it will also work if the vector is user-defined.

Specified by:

instantiateVector in class DoubleVector<PositionUnit,Position,PositionVector>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - U; the display unit of the vector

Returns:

V; a vector of the correct type

instantiateScalarSI

public Position instantiateScalarSI(double valueSI,
 PositionUnit displayUnit)

Instantiate a new scalar for the class of this vector. This can be used instead of the DoubleScalar.instiantiate() methods in case a vector of this class is known. The method is faster than DoubleScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.

Specified by:

instantiateScalarSI in class DoubleVector<PositionUnit,Position,PositionVector>

Parameters:

valueSI - double; the SI value of the scalar

displayUnit - U; the unit in which the value will be displayed

Returns:

S; a scalar of the correct type, belonging to the vector type

instantiateVectorRel

public LengthVector instantiateVectorRel(DoubleVectorData dvd,
 LengthUnit displayUnit)

Instantiate a new relative vector of the class of this absolute vector. This can be used instead of the DoubleVector.instiantiate() methods in case another vector of this absolute vector class is known. The method is faster than DoubleVector.instantiate, and it will also work if the vector is user-defined.

Specified by:

instantiateVectorRel in class DoubleVectorAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Parameters:

dvd - DoubleVectorData; the data used to instantiate the vector

displayUnit - RU; the display unit of the relative vector

Returns:

RV; a relative vector of the correct type, belonging to this absolute vector type

instantiateScalarRelSI

public Length instantiateScalarRelSI(double valueSI,
 LengthUnit displayUnit)

Instantiate a new relative scalar for the class of this absolute vector. This can be used instead of the DoubleScalar.instiantiate() methods in case a vector of this class is known. The method is faster than DoubleScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.

Specified by:

instantiateScalarRelSI in class DoubleVectorAbs<PositionUnit,Position,PositionVector,LengthUnit,Length,LengthVector>

Parameters:

valueSI - double; the SI value of the relative scalar

displayUnit - RU; the unit in which the relative value will be displayed

Returns:

R; a relative scalar of the correct type, belonging to this absolute vector type