Package org.djunits.value.vdouble.vector
Class DimensionlessVector
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<U,S,RV>
org.djunits.value.vdouble.vector.base.DoubleVectorRel<DimensionlessUnit,Dimensionless,DimensionlessVector>
org.djunits.value.vdouble.vector.DimensionlessVector
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<Dimensionless>
,DimensionlessFunctions<DimensionlessUnit,
,DimensionlessVector> Relative<DimensionlessUnit,
,DimensionlessVector> Value<DimensionlessUnit,
,DimensionlessVector> DoubleMathFunctions
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class DimensionlessVector
extends DoubleVectorRel<DimensionlessUnit,Dimensionless,DimensionlessVector>
implements DoubleMathFunctions, DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>
Double DimensionlessVector, a vector of values with a DimensionlessUnit.
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
ConstructorDescriptionDimensionlessVector
(double[] data) Construct an DimensionlessVector from a double[] object with SI-unit values.DimensionlessVector
(double[] data, DimensionlessUnit displayUnit) Construct an DimensionlessVector from a double[] object.DimensionlessVector
(double[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from a double[] object.DimensionlessVector
(double[] data, StorageType storageType) Construct an DimensionlessVector from a double[] object with SI-unit values.DimensionlessVector
(List<? extends Number> data) Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects.DimensionlessVector
(List<? extends Number> data, DimensionlessUnit displayUnit) Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects.DimensionlessVector
(List<? extends Number> data, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects.DimensionlessVector
(List<? extends Number> data, StorageType storageType) Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects.DimensionlessVector
(Map<Integer, ? extends Number> data, int size) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless objects.DimensionlessVector
(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless objects.DimensionlessVector
(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless objects.DimensionlessVector
(Map<Integer, ? extends Number> data, int size, StorageType storageType) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless objects.DimensionlessVector
(Dimensionless[] data) Construct an DimensionlessVector from an array of Dimensionless objects.DimensionlessVector
(Dimensionless[] data, DimensionlessUnit displayUnit) Construct an DimensionlessVector from an array of Dimensionless objects.DimensionlessVector
(Dimensionless[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from an array of Dimensionless objects.DimensionlessVector
(Dimensionless[] data, StorageType storageType) Construct an DimensionlessVector from an array of Dimensionless objects.DimensionlessVector
(DoubleVectorData data, DimensionlessUnit displayUnit) Construct an DimensionlessVector from an internal data object. -
Method Summary
Modifier and TypeMethodDescriptionfinal DimensionlessVector
acos()
Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.final DimensionlessVector
asin()
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 DimensionlessVector
atan()
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 DimensionlessVector
cbrt()
Set the value(s) to the(ir) cube root.final DimensionlessVector
cos()
Set the value(s) to the trigonometric cosine of the value(s).final DimensionlessVector
cosh()
Set the value(s) to the hyperbolic cosine of the value(s).final DimensionlessVector
exp()
Set the value(s) to Euler's number e raised to the power of the value(s).final DimensionlessVector
expm1()
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
(double valueSI, DimensionlessUnit displayUnit) Instantiate a new scalar for the class of this vector.instantiateVector
(DoubleVectorData dvd, DimensionlessUnit displayUnit) Instantiate a new vector of the class of this vector.final DimensionlessVector
inv()
Set the value(s) to the complement (1.0/x) of the value(s).final DimensionlessVector
log()
Set the value(s) to the natural logarithm (base e) of the value(s).final DimensionlessVector
log10()
Set the value(s) to the base 10 logarithm of the value(s).final DimensionlessVector
log1p()
Set the value(s) to the natural logarithm of the sum of the value(s) and 1.final DimensionlessVector
pow
(double x) Set the value(s) to the value(s) raised to the power of the argument.final DimensionlessVector
signum()
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 DimensionlessVector
sin()
Set the value(s) to the trigonometric sine of the value(s).final DimensionlessVector
sinh()
Set the value(s) to the hyperbolic sine of the value(s).final DimensionlessVector
sqrt()
Set the value(s) to the correctly rounded positive square root of the value(s).final DimensionlessVector
tan()
Set the value(s) to the trigonometric tangent of the value(s).final DimensionlessVector
tanh()
Set the value(s) to the hyperbolic tangent of the value(s).Methods inherited from class org.djunits.value.vdouble.vector.base.DoubleVectorRel
decrementBy, decrementBy, divide, divide, divide, divideBy, incrementBy, incrementBy, minus, multiplyBy, plus, times, times, times, zSum
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
-
DimensionlessVector
Construct an DimensionlessVector from an internal data object.- Parameters:
data
- DoubleVectorData; the internal data object for the vectordisplayUnit
- DimensionlessUnit; the display unit of the vector data
-
DimensionlessVector
Construct an DimensionlessVector 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
- DimensionlessUnit; 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
-
DimensionlessVector
Construct an DimensionlessVector 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
- DimensionlessUnit; the unit of the values in the data array, and display unit when printing
-
DimensionlessVector
Construct an DimensionlessVector 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
-
DimensionlessVector
public DimensionlessVector(double[] data) Construct an DimensionlessVector 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
-
DimensionlessVector
public DimensionlessVector(Dimensionless[] data, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from an array of Dimensionless objects. The Dimensionless 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
- Dimensionless[]; the data for the vectordisplayUnit
- DimensionlessUnit; the display unit of the values when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DimensionlessVector
Construct an DimensionlessVector from an array of Dimensionless objects. The Dimensionless 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
- Dimensionless[]; the data for the vectordisplayUnit
- DimensionlessUnit; the display unit of the values when printing
-
DimensionlessVector
Construct an DimensionlessVector from an array of Dimensionless objects. The Dimensionless 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
- Dimensionless[]; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DimensionlessVector
Construct an DimensionlessVector from an array of Dimensionless objects. The Dimensionless 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
- Dimensionless[]; the data for the vector
-
DimensionlessVector
public DimensionlessVector(List<? extends Number> data, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Dimensionless 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 Dimensionless objects, each Dimensionless 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<Dimensionless>; the data for the vectordisplayUnit
- DimensionlessUnit; 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
-
DimensionlessVector
Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects. Note that the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or Dimensionless 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 Dimensionless objects, each Dimensionless 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<Dimensionless>; the data for the vectordisplayUnit
- DimensionlessUnit; 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
-
DimensionlessVector
Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Dimensionless 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<Dimensionless>; the data for the vectorstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
-
DimensionlessVector
Construct an DimensionlessVector from a list of Number objects or a list of Dimensionless objects. When data contains numbers such as Double, assume that they are expressed using SI units. When the data consists of Dimensionless 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<Dimensionless>; the data for the vector
-
DimensionlessVector
public DimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit, StorageType storageType) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless 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 Dimensionless 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 Dimensionless objects, each Dimensionless 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, Dimensionless>; the data for the vectorsize
- int; the size off the vector, i.e., the highest indexdisplayUnit
- DimensionlessUnit; 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
-
DimensionlessVector
public DimensionlessVector(Map<Integer, ? extends Number> data, int size, DimensionlessUnit displayUnit) Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless 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 Dimensionless 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 Dimensionless objects, each Dimensionless 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, Dimensionless>; the data for the vectorsize
- int; the size off the vector, i.e., the highest indexdisplayUnit
- DimensionlessUnit; 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
-
DimensionlessVector
Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless 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 Dimensionless 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, Dimensionless>; 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
-
DimensionlessVector
Construct an DimensionlessVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of Dimensionless 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 Dimensionless 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, Dimensionless>; 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<DimensionlessUnit,
Dimensionless, DimensionlessVector, 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<DimensionlessUnit,
Dimensionless, DimensionlessVector> - 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<DimensionlessUnit,
Dimensionless, DimensionlessVector> - 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
-
acos
Description copied from interface:DimensionlessFunctions
Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.- Specified by:
acos
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
asin
Description copied from interface:DimensionlessFunctions
Set 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:
asin
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
atan
Description copied from interface:DimensionlessFunctions
Set 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:
atan
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
cbrt
Description copied from interface:DimensionlessFunctions
Set the value(s) to the(ir) cube root.- Specified by:
cbrt
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
cos
Description copied from interface:DimensionlessFunctions
Set the value(s) to the trigonometric cosine of the value(s).- Specified by:
cos
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
cosh
Description copied from interface:DimensionlessFunctions
Set the value(s) to the hyperbolic cosine of the value(s).- Specified by:
cosh
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
exp
Description copied from interface:DimensionlessFunctions
Set the value(s) to Euler's number e raised to the power of the value(s).- Specified by:
exp
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
expm1
Description copied from interface:DimensionlessFunctions
Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).- Specified by:
expm1
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
log
Description copied from interface:DimensionlessFunctions
Set the value(s) to the natural logarithm (base e) of the value(s).- Specified by:
log
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
log10
Description copied from interface:DimensionlessFunctions
Set the value(s) to the base 10 logarithm of the value(s).- Specified by:
log10
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
log1p
Description copied from interface:DimensionlessFunctions
Set the value(s) to the natural logarithm of the sum of the value(s) and 1.- Specified by:
log1p
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
pow
Description copied from interface:DimensionlessFunctions
Set the value(s) to the value(s) raised to the power of the argument.- Specified by:
pow
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Parameters:
x
- double; the value to use as the power- Returns:
- T; the modified T
-
signum
Description copied from interface:DimensionlessFunctions
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.- Specified by:
signum
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
sin
Description copied from interface:DimensionlessFunctions
Set the value(s) to the trigonometric sine of the value(s).- Specified by:
sin
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
sinh
Description copied from interface:DimensionlessFunctions
Set the value(s) to the hyperbolic sine of the value(s).- Specified by:
sinh
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
sqrt
Description copied from interface:DimensionlessFunctions
Set the value(s) to the correctly rounded positive square root of the value(s).- Specified by:
sqrt
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
tan
Description copied from interface:DimensionlessFunctions
Set the value(s) to the trigonometric tangent of the value(s).- Specified by:
tan
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
tanh
Description copied from interface:DimensionlessFunctions
Set the value(s) to the hyperbolic tangent of the value(s).- Specified by:
tanh
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-
inv
Description copied from interface:DimensionlessFunctions
Set the value(s) to the complement (1.0/x) of the value(s).- Specified by:
inv
in interfaceDimensionlessFunctions<DimensionlessUnit,
DimensionlessVector> - Returns:
- T; the modified T
-