Package org.djunits.value.vdouble.vector
Class DirectionVector
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<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>
org.djunits.value.vdouble.vector.DirectionVector
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<Direction>
,Absolute<DirectionUnit,
,DirectionVector, AngleUnit, AngleVector> Value<DirectionUnit,
DirectionVector>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class DirectionVector
extends DoubleVectorAbs<DirectionUnit,Direction,DirectionVector,AngleUnit,Angle,AngleVector>
Double DirectionVector, a vector of values with a DirectionUnit.
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:
-
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
ConstructorDescriptionDirectionVector
(double[] data) Construct an DirectionVector from a double[] object with SI-unit values.DirectionVector
(double[] data, DirectionUnit displayUnit) Construct an DirectionVector from a double[] object.DirectionVector
(double[] data, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from a double[] object.DirectionVector
(double[] data, StorageType storageType) Construct an DirectionVector from a double[] object with SI-unit values.DirectionVector
(List<? extends Number> data) Construct an DirectionVector from a list of Number objects or a list of Direction objects.DirectionVector
(List<? extends Number> data, DirectionUnit displayUnit) Construct an DirectionVector from a list of Number objects or a list of Direction objects.DirectionVector
(List<? extends Number> data, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from a list of Number objects or a list of Direction objects.DirectionVector
(List<? extends Number> data, StorageType storageType) Construct an DirectionVector from a list of Number objects or a list of Direction objects.DirectionVector
(Map<Integer, ? extends Number> data, int size) Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction objects.DirectionVector
(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit) Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction objects.DirectionVector
(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction objects.DirectionVector
(Map<Integer, ? extends Number> data, int size, StorageType storageType) Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction objects.DirectionVector
(Direction[] data) Construct an DirectionVector from an array of Direction objects.DirectionVector
(Direction[] data, DirectionUnit displayUnit) Construct an DirectionVector from an array of Direction objects.DirectionVector
(Direction[] data, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from an array of Direction objects.DirectionVector
(Direction[] data, StorageType storageType) Construct an DirectionVector from an array of Direction objects.DirectionVector
(DoubleVectorData data, DirectionUnit displayUnit) Construct an DirectionVector from an internal data object. -
Method Summary
Modifier and TypeMethodDescriptionReturn the class of the corresponding scalar.instantiateScalarRelSI
(double valueSI, AngleUnit displayUnit) Instantiate a new relative scalar for the class of this absolute vector.instantiateScalarSI
(double valueSI, DirectionUnit displayUnit) Instantiate a new scalar for the class of this vector.instantiateVector
(DoubleVectorData dvd, DirectionUnit displayUnit) Instantiate a new vector of the class of this vector.instantiateVectorRel
(DoubleVectorData dvd, AngleUnit 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
-
DirectionVector
Construct an DirectionVector from an internal data object.- Parameters:
data
- DoubleVectorData; the internal data object for the vectordisplayUnit
- DirectionUnit; the display unit of the vector data
-
DirectionVector
Construct an DirectionVector 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 displayUnitdisplayUnit
- DirectionUnit; the unit of the values in the data array, and display unit when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector 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 vectordisplayUnit
- DirectionUnit; the unit of the values in the data array, and display unit when printing
-
DirectionVector
Construct an DirectionVector from a double[] object with SI-unit values.- Parameters:
data
- double[]; the data for the vector, in SI unitsstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
public DirectionVector(double[] data) Construct an DirectionVector 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
-
DirectionVector
Construct an DirectionVector from an array of Direction objects. The Direction 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
- Direction[]; the data for the vectordisplayUnit
- DirectionUnit; the display unit of the values when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from an array of Direction objects. The Direction 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
- Direction[]; the data for the vectordisplayUnit
- DirectionUnit; the display unit of the values when printing
-
DirectionVector
Construct an DirectionVector from an array of Direction objects. The Direction 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
- Direction[]; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from an array of Direction objects. The Direction 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
- Direction[]; the data for the vector
-
DirectionVector
public DirectionVector(List<? extends Number> data, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from a list of Number objects or a list of Direction objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Direction 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 Direction objects, each Direction 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<Direction>; the data for the vectordisplayUnit
- DirectionUnit; 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 generalstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from a list of Number objects or a list of Direction objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Direction 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 Direction objects, each Direction 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<Direction>; the data for the vectordisplayUnit
- DirectionUnit; 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
-
DirectionVector
Construct an DirectionVector from a list of Number objects or a list of Direction objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Direction 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<Direction>; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from a list of Number objects or a list of Direction objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Direction 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<Direction>; the data for the vector
-
DirectionVector
public DirectionVector(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit, StorageType storageType) Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction 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 Direction 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 Direction objects, each Direction 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, Direction>; the data for the vectorsize
- int; the size off the vector, i.e., the highest indexdisplayUnit
- DirectionUnit; 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 generalstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction 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 Direction 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 Direction objects, each Direction 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, Direction>; the data for the vectorsize
- int; the size off the vector, i.e., the highest indexdisplayUnit
- DirectionUnit; 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
-
DirectionVector
Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction 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 Direction 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, Direction>; the data for the vectorsize
- int; the size off the vector, i.e., the highest indexstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DirectionVector
Construct an DirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Direction 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 Direction 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, Direction>; the data for the vectorsize
- int; the size off the vector, i.e., the highest index
-
-
Method Details
-
getScalarClass
Description copied from class:IndexedValue
Return the class of the corresponding scalar.- Specified by:
getScalarClass
in classIndexedValue<DirectionUnit,
Direction, DirectionVector, DoubleVectorData> - Returns:
- Class<S>; the class of the corresponding scalar
-
instantiateVector
Description copied from class:DoubleVector
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 classDoubleVector<DirectionUnit,
Direction, DirectionVector> - Parameters:
dvd
- DoubleVectorData; the data used to instantiate the vectordisplayUnit
- U; the display unit of the vector- Returns:
- V; a vector of the correct type
-
instantiateScalarSI
Description copied from class:DoubleVector
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 classDoubleVector<DirectionUnit,
Direction, DirectionVector> - Parameters:
valueSI
- double; the SI value of the scalardisplayUnit
- U; the unit in which the value will be displayed- Returns:
- S; a scalar of the correct type, belonging to the vector type
-
instantiateVectorRel
Description copied from class:DoubleVectorAbs
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 classDoubleVectorAbs<DirectionUnit,
Direction, DirectionVector, AngleUnit, Angle, AngleVector> - Parameters:
dvd
- DoubleVectorData; the data used to instantiate the vectordisplayUnit
- RU; the display unit of the relative vector- Returns:
- RV; a relative vector of the correct type, belonging to this absolute vector type
-
instantiateScalarRelSI
Description copied from class:DoubleVectorAbs
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 classDoubleVectorAbs<DirectionUnit,
Direction, DirectionVector, AngleUnit, Angle, AngleVector> - Parameters:
valueSI
- double; the SI value of the relative scalardisplayUnit
- 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
-