Package org.djunits.value.vfloat.vector

Class FloatDimensionlessVector

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,V,FloatVectorData>

org.djunits.value.vfloat.vector.base.AbstractFloatVector<U,S,RV>

org.djunits.value.vfloat.vector.base.AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>

org.djunits.value.vfloat.vector.FloatDimensionlessVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FloatDimensionless>, Vector<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>, Vector.Rel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>, DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>, ValueFunctions<DimensionlessUnit,FloatDimensionlessVector>, IndexedValue<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>, Relative<DimensionlessUnit,FloatDimensionlessVector>, Value<DimensionlessUnit,FloatDimensionlessVector>, FloatVectorInterface<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class FloatDimensionlessVector
extends AbstractFloatVectorRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>
implements DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Immutable Float FloatDimensionlessVector, a vector of values with a DimensionlessUnit.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.base.AbstractFloatVector

AbstractFloatVector.Itr

Nested classes/interfaces inherited from interface org.djunits.value.base.Vector

Vector.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>, Vector.Rel<U extends Unit<U>,S extends Scalar<U,S>,RV extends Vector.Rel<U,S,RV>>, Vector.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.base.AbstractFloatVector

data

Constructor Summary

Constructors

Constructor	Description
FloatDimensionlessVector(FloatVectorData data, DimensionlessUnit unit)	Construct an FloatDimensionlessVector from an internal data object.

Method Summary

Modifier and Type	Method	Description
FloatDimensionlessVector	acos()	Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
FloatDimensionlessVector	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.
FloatDimensionlessVector	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.
FloatDimensionlessVector	cbrt()	Set the value(s) to the(ir) cube root.
FloatDimensionlessVector	cos()	Set the value(s) to the trigonometric cosine of the value(s).
FloatDimensionlessVector	cosh()	Set the value(s) to the hyperbolic cosine of the value(s).
FloatDimensionlessVector	exp()	Set the value(s) to Euler's number e raised to the power of the value(s).
FloatDimensionlessVector	expm1()	Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
Class<FloatDimensionless>	getScalarClass()	Return the class of the corresponding scalar.
FloatDimensionless	instantiateScalarSI(float valueSI, DimensionlessUnit displayUnit)	Instantiate a new scalar for the class of this vector.
FloatDimensionlessVector	instantiateVector(FloatVectorData fvd, DimensionlessUnit displayUnit)	Instantiate a new vector of the class of this vector.
FloatDimensionlessVector	inv()	Set the value(s) to the complement (1.0/x) of the value(s).
FloatDimensionlessVector	log()	Set the value(s) to the natural logarithm (base e) of the value(s).
FloatDimensionlessVector	log10()	Set the value(s) to the base 10 logarithm of the value(s).
FloatDimensionlessVector	log1p()	Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
FloatDimensionlessVector	pow(double x)	Set the value(s) to the value(s) raised to the power of the argument.
FloatDimensionlessVector	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.
FloatDimensionlessVector	sin()	Set the value(s) to the trigonometric sine of the value(s).
FloatDimensionlessVector	sinh()	Set the value(s) to the hyperbolic sine of the value(s).
FloatDimensionlessVector	sqrt()	Set the value(s) to the correctly rounded positive square root of the value(s).
FloatDimensionlessVector	tan()	Set the value(s) to the trigonometric tangent of the value(s).
FloatDimensionlessVector	tanh()	Set the value(s) to the hyperbolic tangent of the value(s).

Methods inherited from class org.djunits.value.vfloat.vector.base.AbstractFloatVectorRel

decrementBy, decrementBy, divide, divide, divide, divideBy, incrementBy, incrementBy, minus, multiplyBy, plus, times, times, times, zSum

Methods inherited from class org.djunits.value.vfloat.vector.base.AbstractFloatVector

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.AbstractIndexedValue

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

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getStorageType, immutable, isDense, isMutable, isSparse, mutable, toDense, toSparse

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Methods inherited from interface org.djunits.value.base.Vector

get, getScalars, iterator, size

Constructor Detail

FloatDimensionlessVector

public FloatDimensionlessVector(FloatVectorData data,
                                DimensionlessUnit unit)

Construct an FloatDimensionlessVector from an internal data object.

Parameters:

data - FloatVectorData; an internal data object

unit - DimensionlessUnit; the unit

Method Detail

getScalarClass

public Class<FloatDimensionless> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in interface IndexedValue<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public FloatDimensionlessVector instantiateVector(FloatVectorData fvd,
                                                  DimensionlessUnit displayUnit)

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 interface FloatVectorInterface<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>

Parameters:

fvd - FloatVectorData; the data used to instantiate the vector

displayUnit - U; the display unit of the vector

Returns:

V; a vector of the correct type

instantiateScalarSI

public FloatDimensionless instantiateScalarSI(float valueSI,
                                              DimensionlessUnit displayUnit)

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 interface FloatVectorInterface<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector>

Parameters:

valueSI - float; the SI value of the scalar

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

Returns:

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

acos

public final FloatDimensionlessVector acos()

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 interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

asin

public final FloatDimensionlessVector 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.

Specified by:

asin in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

atan

public final FloatDimensionlessVector 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.

Specified by:

atan in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

cbrt

public final FloatDimensionlessVector cbrt()

Set the value(s) to the(ir) cube root.

Specified by:

cbrt in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

cos

public final FloatDimensionlessVector cos()

Set the value(s) to the trigonometric cosine of the value(s).

Specified by:

cos in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

cosh

public final FloatDimensionlessVector cosh()

Set the value(s) to the hyperbolic cosine of the value(s).

Specified by:

cosh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

exp

public final FloatDimensionlessVector exp()

Set the value(s) to Euler's number e raised to the power of the value(s).

Specified by:

exp in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

expm1

public final FloatDimensionlessVector expm1()

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 interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

log

public final FloatDimensionlessVector log()

Set the value(s) to the natural logarithm (base e) of the value(s).

Specified by:

log in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

log10

public final FloatDimensionlessVector log10()

Set the value(s) to the base 10 logarithm of the value(s).

Specified by:

log10 in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

log1p

public final FloatDimensionlessVector log1p()

Set the value(s) to the natural logarithm of the sum of the value(s) and 1.

Specified by:

log1p in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

pow

public final FloatDimensionlessVector pow(double x)

Set the value(s) to the value(s) raised to the power of the argument.

Specified by:

pow in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

signum

public final FloatDimensionlessVector 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.

Specified by:

signum in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

sin

public final FloatDimensionlessVector sin()

Set the value(s) to the trigonometric sine of the value(s).

Specified by:

sin in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

sinh

public final FloatDimensionlessVector sinh()

Set the value(s) to the hyperbolic sine of the value(s).

Specified by:

sinh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

sqrt

public final FloatDimensionlessVector sqrt()

Set the value(s) to the correctly rounded positive square root of the value(s).

Specified by:

sqrt in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

tan

public final FloatDimensionlessVector tan()

Set the value(s) to the trigonometric tangent of the value(s).

Specified by:

tan in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

tanh

public final FloatDimensionlessVector tanh()

Set the value(s) to the hyperbolic tangent of the value(s).

Specified by:

tanh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T

inv

public final FloatDimensionlessVector inv()

Set the value(s) to the complement (1.0/x) of the value(s).

Specified by:

inv in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessVector>

Returns:

T; the modified T