Package org.djunits.value.vfloat.vector
Class FloatDirectionVector
java.lang.Object
org.djunits.value.IndexedValue<U,S,V,D>
org.djunits.value.base.Vector<U,S,V,FloatVectorData>
org.djunits.value.vfloat.vector.base.FloatVector<AU,A,AV>
org.djunits.value.vfloat.vector.base.FloatVectorAbs<DirectionUnit,FloatDirection,FloatDirectionVector,AngleUnit,FloatAngle,FloatAngleVector>
org.djunits.value.vfloat.vector.FloatDirectionVector
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<FloatDirection>
,Absolute<DirectionUnit,
,FloatDirectionVector, AngleUnit, FloatAngleVector> Value<DirectionUnit,
FloatDirectionVector>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatDirectionVector
extends FloatVectorAbs<DirectionUnit,FloatDirection,FloatDirectionVector,AngleUnit,FloatAngle,FloatAngleVector>
Absolute FloatDirection Vector.
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.vfloat.vector.base.FloatVector
FloatVector.Itr
-
Field Summary
Fields inherited from class org.djunits.value.vfloat.vector.base.FloatVector
data
-
Constructor Summary
ConstructorDescriptionFloatDirectionVector
(float[] data) Construct a FloatDirectionVector from a float[] object with SI-unit values.FloatDirectionVector
(float[] data, DirectionUnit displayUnit) Construct a FloatDirectionVector from a float[] object.FloatDirectionVector
(float[] data, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from a float[] object.FloatDirectionVector
(float[] data, StorageType storageType) Construct a FloatDirectionVector from a float[] object with SI-unit values.FloatDirectionVector
(List<? extends Number> data) Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects.FloatDirectionVector
(List<? extends Number> data, DirectionUnit displayUnit) Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects.FloatDirectionVector
(List<? extends Number> data, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects.FloatDirectionVector
(List<? extends Number> data, StorageType storageType) Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects.FloatDirectionVector
(Map<Integer, ? extends Number> data, int size) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection objects.FloatDirectionVector
(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection objects.FloatDirectionVector
(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection objects.FloatDirectionVector
(Map<Integer, ? extends Number> data, int size, StorageType storageType) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection objects.FloatDirectionVector
(FloatDirection[] data) Construct a FloatDirectionVector from an array of FloatDirection objects.FloatDirectionVector
(FloatDirection[] data, DirectionUnit displayUnit) Construct a FloatDirectionVector from an array of FloatDirection objects.FloatDirectionVector
(FloatDirection[] data, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from an array of FloatDirection objects.FloatDirectionVector
(FloatDirection[] data, StorageType storageType) Construct a FloatDirectionVector from an array of FloatDirection objects.FloatDirectionVector
(FloatVectorData data, DirectionUnit displayUnit) Construct a FloatDirectionVector from an internal data object. -
Method Summary
Modifier and TypeMethodDescriptionReturn the class of the corresponding scalar.instantiateScalarRelSI
(float valueSI, AngleUnit displayUnit) Instantiate a new relative scalar for the class of this absolute vector.instantiateScalarSI
(float valueSI, DirectionUnit displayUnit) Instantiate a new scalar for the class of this vector.instantiateVector
(FloatVectorData fvd, DirectionUnit displayUnit) Instantiate a new vector of the class of this vector.instantiateVectorRel
(FloatVectorData fvd, AngleUnit displayUnit) Instantiate a new relative vector of the class of this absolute vector.Methods inherited from class org.djunits.value.vfloat.vector.base.FloatVectorAbs
decrementBy, decrementBy, minus, minus, plus
Methods inherited from class org.djunits.value.vfloat.vector.base.FloatVector
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
-
FloatDirectionVector
Construct a FloatDirectionVector from an internal data object.- Parameters:
data
- FloatVectorData; the internal data object for the vectordisplayUnit
- DirectionUnit; the display unit of the vector data
-
FloatDirectionVector
Construct a FloatDirectionVector from a float[] object. The Float values are expressed in the displayUnit, and will be printed using the displayUnit.- Parameters:
data
- float[]; 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
-
FloatDirectionVector
Construct a FloatDirectionVector from a float[] object. The Float values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array.- Parameters:
data
- float[]; the data for the vectordisplayUnit
- DirectionUnit; the unit of the values in the data array, and display unit when printing
-
FloatDirectionVector
Construct a FloatDirectionVector from a float[] object with SI-unit values.- Parameters:
data
- float[]; the data for the vector, in SI unitsstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDirectionVector
public FloatDirectionVector(float[] data) Construct a FloatDirectionVector from a float[] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array.- Parameters:
data
- float[]; the data for the vector, in SI units
-
FloatDirectionVector
public FloatDirectionVector(FloatDirection[] data, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from an array of FloatDirection objects. The FloatDirection 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
- FloatDirection[]; 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
-
FloatDirectionVector
Construct a FloatDirectionVector from an array of FloatDirection objects. The FloatDirection 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
- FloatDirection[]; the data for the vectordisplayUnit
- DirectionUnit; the display unit of the values when printing
-
FloatDirectionVector
Construct a FloatDirectionVector from an array of FloatDirection objects. The FloatDirection 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
- FloatDirection[]; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDirectionVector
Construct a FloatDirectionVector from an array of FloatDirection objects. The FloatDirection 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
- FloatDirection[]; the data for the vector
-
FloatDirectionVector
public FloatDirectionVector(List<? extends Number> data, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatDirection 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 FloatDirection objects, each FloatDirection 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<Float> 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<Float> or List<Number> in generalstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDirectionVector
Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatDirection 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 FloatDirection objects, each FloatDirection 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<Float> 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<Float> or List<Number> in general
-
FloatDirectionVector
Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatDirection 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<Float> or List<Direction>; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDirectionVector
Construct a FloatDirectionVector from a list of Number objects or a list of FloatDirection objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatDirection 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<Float> or List<Direction>; the data for the vector
-
FloatDirectionVector
public FloatDirectionVector(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit, StorageType storageType) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection 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., Float objects) or FloatDirection 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 FloatDirection objects, each FloatDirection 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, Float> or Map<Integer, FloatDirection>; 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<Float> or List<Number> in generalstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDirectionVector
public FloatDirectionVector(Map<Integer, ? extends Number> data, int size, DirectionUnit displayUnit) Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection 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., Float objects) or FloatDirection 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 FloatDirection objects, each FloatDirection 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, Float> or Map<Integer, FloatDirection>; 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<Float> or List<Number> in general
-
FloatDirectionVector
Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection 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 Float, assume that they are expressed using SI units. When the data consists of FloatDirection 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, Float> or Map<Integer, FloatDirection>; 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
-
FloatDirectionVector
Construct a FloatDirectionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDirection 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 Float, assume that they are expressed using SI units. When the data consists of FloatDirection 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, Float> or Map<Integer, FloatDirection>; 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,
FloatDirection, FloatDirectionVector, FloatVectorData> - Returns:
- Class<S>; the class of the corresponding scalar
-
instantiateVector
Description copied from class:FloatVector
Instantiate a new vector of the class of this vector. This can be used instead of the FloatVector.instiantiate() methods in case another vector of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the vector is user-defined.- Specified by:
instantiateVector
in classFloatVector<DirectionUnit,
FloatDirection, FloatDirectionVector> - Parameters:
fvd
- FloatVectorData; 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:FloatVector
Instantiate a new scalar for the class of this vector. This can be used instead of the FloatScalar.instiantiate() methods in case a vector of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.- Specified by:
instantiateScalarSI
in classFloatVector<DirectionUnit,
FloatDirection, FloatDirectionVector> - Parameters:
valueSI
- float; 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:FloatVectorAbs
Instantiate a new relative vector of the class of this absolute vector. This can be used instead of the FloatVector.instiantiate() methods in case another vector of this absolute vector class is known. The method is faster than FloatVector.instantiate, and it will also work if the vector is user-defined.- Specified by:
instantiateVectorRel
in classFloatVectorAbs<DirectionUnit,
FloatDirection, FloatDirectionVector, AngleUnit, FloatAngle, FloatAngleVector> - Parameters:
fvd
- FloatVectorData; 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:FloatVectorAbs
Instantiate a new relative scalar for the class of this absolute vector. This can be used instead of the FloatScalar.instiantiate() methods in case a vector of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.- Specified by:
instantiateScalarRelSI
in classFloatVectorAbs<DirectionUnit,
FloatDirection, FloatDirectionVector, AngleUnit, FloatAngle, FloatAngleVector> - Parameters:
valueSI
- float; 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
-