Package org.djunits.value.vfloat.vector
Class FloatDimensionlessVector
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<U,S,RV>
org.djunits.value.vfloat.vector.base.FloatVectorRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>
org.djunits.value.vfloat.vector.FloatDimensionlessVector
- All Implemented Interfaces:
Serializable,Cloneable,Iterable<FloatDimensionless>,DimensionlessFunctions<DimensionlessUnit,,FloatDimensionlessVector> Relative<DimensionlessUnit,,FloatDimensionlessVector> Value<DimensionlessUnit,FloatDimensionlessVector>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2025-09-06T12:29:15.080196400Z")
public class FloatDimensionlessVector
extends FloatVectorRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>
implements DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>
Immutable Float FloatDimensionlessVector, a vector of values with a DimensionlessUnit.
Copyright (c) 2013-2025 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
ConstructorsConstructorDescriptionFloatDimensionlessVector(float[] data) Construct a FloatDimensionlessVector from a float[] object with SI-unit values.FloatDimensionlessVector(float[] data, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from a float[] object.FloatDimensionlessVector(float[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a float[] object.FloatDimensionlessVector(float[] data, StorageType storageType) Construct a FloatDimensionlessVector from a float[] object with SI-unit values.FloatDimensionlessVector(List<? extends Number> data) Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects.FloatDimensionlessVector(List<? extends Number> data, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects.FloatDimensionlessVector(List<? extends Number> data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects.FloatDimensionlessVector(List<? extends Number> data, StorageType storageType) Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects.FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless objects.FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless objects.FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless objects.FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, StorageType storageType) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless objects.Construct a FloatDimensionlessVector from an array of FloatDimensionless objects.FloatDimensionlessVector(FloatDimensionless[] data, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from an array of FloatDimensionless objects.FloatDimensionlessVector(FloatDimensionless[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from an array of FloatDimensionless objects.FloatDimensionlessVector(FloatDimensionless[] data, StorageType storageType) Construct a FloatDimensionlessVector from an array of FloatDimensionless objects.FloatDimensionlessVector(FloatVectorData data, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from an internal data object. -
Method Summary
Modifier and TypeMethodDescriptionfinal FloatDimensionlessVectoracos()Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.final FloatDimensionlessVectorasin()Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.final FloatDimensionlessVectoratan()Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.final FloatDimensionlessVectorcbrt()Set the value(s) to the(ir) cube root.final FloatDimensionlessVectorcos()Set the value(s) to the trigonometric cosine of the value(s).final FloatDimensionlessVectorcosh()Set the value(s) to the hyperbolic cosine of the value(s).final FloatDimensionlessVectorexp()Set the value(s) to Euler's number e raised to the power of the value(s).final FloatDimensionlessVectorexpm1()Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).Return the class of the corresponding scalar.instantiateScalarSI(float valueSI, DimensionlessUnit displayUnit) Instantiate a new scalar for the class of this vector.instantiateVector(FloatVectorData fvd, DimensionlessUnit displayUnit) Instantiate a new vector of the class of this vector.final FloatDimensionlessVectorinv()Set the value(s) to the complement (1.0/x) of the value(s).final FloatDimensionlessVectorlog()Set the value(s) to the natural logarithm (base e) of the value(s).final FloatDimensionlessVectorlog10()Set the value(s) to the base 10 logarithm of the value(s).final FloatDimensionlessVectorlog1p()Set the value(s) to the natural logarithm of the sum of the value(s) and 1.final FloatDimensionlessVectorpow(double x) Set the value(s) to the value(s) raised to the power of the argument.final FloatDimensionlessVectorsignum()Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.final FloatDimensionlessVectorsin()Set the value(s) to the trigonometric sine of the value(s).final FloatDimensionlessVectorsinh()Set the value(s) to the hyperbolic sine of the value(s).final FloatDimensionlessVectorsqrt()Set the value(s) to the correctly rounded positive square root of the value(s).final FloatDimensionlessVectortan()Set the value(s) to the trigonometric tangent of the value(s).final FloatDimensionlessVectortanh()Set the value(s) to the hyperbolic tangent of the value(s).Methods inherited from class org.djunits.value.vfloat.vector.base.FloatVectorRel
decrementBy, decrementBy, divide, divide, divide, divideBy, divideBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, times, times, times, zSumMethods 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, toStringMethods inherited from class org.djunits.value.IndexedValue
cardinality, checkCopyOnWrite, clone, getDisplayUnit, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setDisplayUnit, setMutableMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.djunits.value.Value
isAbsolute, isRelative
-
Constructor Details
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from an internal data object.- Parameters:
data- the internal data object for the vectordisplayUnit- the display unit of the vector data
-
FloatDimensionlessVector
public FloatDimensionlessVector(float[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a float[] object. The Float values are expressed in the displayUnit, and will be printed using the displayUnit.- Parameters:
data- the data for the vector, expressed in the displayUnitdisplayUnit- the unit of the values in the data array, and display unit when printingstorageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector 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- the data for the vectordisplayUnit- the unit of the values in the data array, and display unit when printing
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from a float[] object with SI-unit values.- Parameters:
data- the data for the vector, in SI unitsstorageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
public FloatDimensionlessVector(float[] data) Construct a FloatDimensionlessVector from a float[] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array.- Parameters:
data- the data for the vector, in SI units
-
FloatDimensionlessVector
public FloatDimensionlessVector(FloatDimensionless[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from an array of FloatDimensionless objects. The FloatDimensionless 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- the data for the vectordisplayUnit- the display unit of the values when printingstorageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from an array of FloatDimensionless objects. The FloatDimensionless 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- the data for the vectordisplayUnit- the display unit of the values when printing
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from an array of FloatDimensionless objects. The FloatDimensionless 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- the data for the vectorstorageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from an array of FloatDimensionless objects. The FloatDimensionless 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- the data for the vector
-
FloatDimensionlessVector
public FloatDimensionlessVector(List<? extends Number> data, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatDimensionless 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 FloatDimensionless objects, each FloatDimensionless 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- the data for the vector as a List<Float> or List<Dimensionless>displayUnit- 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- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or FloatDimensionless 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 FloatDimensionless objects, each FloatDimensionless 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- the data for the vector as a List<Float> or List<Dimensionless>displayUnit- 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
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatDimensionless 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- the data for the vector as a List<Float> or List<Dimensionless>storageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from a list of Number objects or a list of FloatDimensionless objects. When data contains numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatDimensionless 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- the data for the vector as a List<Float> or List<Dimensionless>
-
FloatDimensionlessVector
public FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit, StorageType storageType) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless 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 FloatDimensionless 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 FloatDimensionless objects, each FloatDimensionless 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- the data for the vector as a Map<Integer, Float> or Map<Integer, FloatDimensionless>size- the size off the vector, i.e., the highest indexdisplayUnit- 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- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
public FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless 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 FloatDimensionless 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 FloatDimensionless objects, each FloatDimensionless 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- the data for the vector as a Map<Integer, Float> or Map<Integer, FloatDimensionless>size- the size off the vector, i.e., the highest indexdisplayUnit- 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
-
FloatDimensionlessVector
public FloatDimensionlessVector(Map<Integer, ? extends Number> data, int size, StorageType storageType) Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless 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 FloatDimensionless 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- the data for the vector as a Map<Integer, Float> or Map<Integer, FloatDimensionless>size- the size off the vector, i.e., the highest indexstorageType- the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
FloatDimensionlessVector
Construct a FloatDimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of FloatDimensionless 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 FloatDimensionless 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- the data for the vector as a Map<Integer, Float> or Map<Integer, FloatDimensionless>size- the size off the vector, i.e., the highest index
-
-
Method Details
-
getScalarClass
Description copied from class:IndexedValueReturn the class of the corresponding scalar.- Specified by:
getScalarClassin classIndexedValue<DimensionlessUnit,FloatDimensionless, FloatDimensionlessVector, FloatVectorData> - Returns:
- the class of the corresponding scalar
-
instantiateVector
public FloatDimensionlessVector instantiateVector(FloatVectorData fvd, DimensionlessUnit displayUnit) Description copied from class:FloatVectorInstantiate 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:
instantiateVectorin classFloatVector<DimensionlessUnit,FloatDimensionless, FloatDimensionlessVector> - Parameters:
fvd- the data used to instantiate the vectordisplayUnit- the display unit of the vector- Returns:
- a vector of the correct type
-
instantiateScalarSI
Description copied from class:FloatVectorInstantiate 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:
instantiateScalarSIin classFloatVector<DimensionlessUnit,FloatDimensionless, FloatDimensionlessVector> - Parameters:
valueSI- the SI value of the scalardisplayUnit- the unit in which the value will be displayed- Returns:
- a scalar of the correct type, belonging to the vector type
-
acos
Description copied from interface:DimensionlessFunctionsSet the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.- Specified by:
acosin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
asin
Description copied from interface:DimensionlessFunctionsSet the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.- Specified by:
asinin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
atan
Description copied from interface:DimensionlessFunctionsSet the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.- Specified by:
atanin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
cbrt
Description copied from interface:DimensionlessFunctionsSet the value(s) to the(ir) cube root.- Specified by:
cbrtin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
cos
Description copied from interface:DimensionlessFunctionsSet the value(s) to the trigonometric cosine of the value(s).- Specified by:
cosin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
cosh
Description copied from interface:DimensionlessFunctionsSet the value(s) to the hyperbolic cosine of the value(s).- Specified by:
coshin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
exp
Description copied from interface:DimensionlessFunctionsSet the value(s) to Euler's number e raised to the power of the value(s).- Specified by:
expin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
expm1
Description copied from interface:DimensionlessFunctionsSet the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).- Specified by:
expm1in interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
log
Description copied from interface:DimensionlessFunctionsSet the value(s) to the natural logarithm (base e) of the value(s).- Specified by:
login interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
log10
Description copied from interface:DimensionlessFunctionsSet the value(s) to the base 10 logarithm of the value(s).- Specified by:
log10in interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
log1p
Description copied from interface:DimensionlessFunctionsSet the value(s) to the natural logarithm of the sum of the value(s) and 1.- Specified by:
log1pin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
pow
Description copied from interface:DimensionlessFunctionsSet the value(s) to the value(s) raised to the power of the argument.- Specified by:
powin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Parameters:
x- the value to use as the power- Returns:
- the modified T
-
signum
Description copied from interface:DimensionlessFunctionsSet the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.- Specified by:
signumin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
sin
Description copied from interface:DimensionlessFunctionsSet the value(s) to the trigonometric sine of the value(s).- Specified by:
sinin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
sinh
Description copied from interface:DimensionlessFunctionsSet the value(s) to the hyperbolic sine of the value(s).- Specified by:
sinhin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
sqrt
Description copied from interface:DimensionlessFunctionsSet the value(s) to the correctly rounded positive square root of the value(s).- Specified by:
sqrtin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
tan
Description copied from interface:DimensionlessFunctionsSet the value(s) to the trigonometric tangent of the value(s).- Specified by:
tanin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
tanh
Description copied from interface:DimensionlessFunctionsSet the value(s) to the hyperbolic tangent of the value(s).- Specified by:
tanhin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-
inv
Description copied from interface:DimensionlessFunctionsSet the value(s) to the complement (1.0/x) of the value(s).- Specified by:
invin interfaceDimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector> - Returns:
- the modified T
-