Package org.djunits.value.vdouble.vector

Class DimensionlessVector

java.lang.Object

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

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

org.djunits.value.vdouble.vector.base.AbstractDoubleVector<U,S,RV>

org.djunits.value.vdouble.vector.base.AbstractDoubleVectorRel<DimensionlessUnit,Dimensionless,DimensionlessVector>

org.djunits.value.vdouble.vector.DimensionlessVector

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Dimensionless>, Vector<DimensionlessUnit,Dimensionless,DimensionlessVector>, Vector.Rel<DimensionlessUnit,Dimensionless,DimensionlessVector>, DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>, ValueFunctions<DimensionlessUnit,DimensionlessVector>, IndexedValue<DimensionlessUnit,Dimensionless,DimensionlessVector>, Relative<DimensionlessUnit,DimensionlessVector>, Value<DimensionlessUnit,DimensionlessVector>, DoubleMathFunctions, DoubleVectorInterface<DimensionlessUnit,Dimensionless,DimensionlessVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class DimensionlessVector
extends AbstractDoubleVectorRel<DimensionlessUnit,Dimensionless,DimensionlessVector>
implements DoubleMathFunctions, DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Double DimensionlessVector, a vector of values with a DimensionlessUnit.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.base.AbstractDoubleVector

AbstractDoubleVector.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.vdouble.vector.base.AbstractDoubleVector

data

Fields inherited from interface org.djunits.value.vdouble.function.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor	Description
DimensionlessVector(DoubleVectorData data, DimensionlessUnit displayUnit)	Construct an DimensionlessVector from an internal data object.

Method Summary

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

Methods inherited from class org.djunits.value.vdouble.vector.base.AbstractDoubleVectorRel

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

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

DimensionlessVector

public DimensionlessVector(DoubleVectorData data,
                           DimensionlessUnit displayUnit)

Construct an DimensionlessVector from an internal data object.

Parameters:

data - DoubleVectorData; the internal data object for the vector data

displayUnit - DimensionlessUnit; the display unit of the vector data

Method Detail

getScalarClass

public Class<Dimensionless> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in interface IndexedValue<DimensionlessUnit,Dimensionless,DimensionlessVector>

Returns:

Class<S>; the class of the corresponding scalar

instantiateVector

public DimensionlessVector instantiateVector(DoubleVectorData dvd,
                                             DimensionlessUnit displayUnit)

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 interface DoubleVectorInterface<DimensionlessUnit,Dimensionless,DimensionlessVector>

Parameters:

dvd - DoubleVectorData; 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 Dimensionless instantiateScalarSI(double valueSI,
                                         DimensionlessUnit displayUnit)

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 interface DoubleVectorInterface<DimensionlessUnit,Dimensionless,DimensionlessVector>

Parameters:

valueSI - double; 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 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.

Specified by:

acos in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

asin

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

Specified by:

asin in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

atan

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

Specified by:

atan in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

cbrt

public final DimensionlessVector cbrt()

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

Specified by:

cbrt in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

cos

public final DimensionlessVector cos()

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

Specified by:

cos in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

cosh

public final DimensionlessVector cosh()

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

Specified by:

cosh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

exp

public final DimensionlessVector 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,DimensionlessVector>

Returns:

T; the modified T

expm1

public 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).

Specified by:

expm1 in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

log

public final DimensionlessVector log()

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

Specified by:

log in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

log10

public final DimensionlessVector log10()

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

Specified by:

log10 in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

log1p

public final DimensionlessVector 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,DimensionlessVector>

Returns:

T; the modified T

pow

public final DimensionlessVector 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,DimensionlessVector>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

signum

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

Specified by:

signum in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

sin

public final DimensionlessVector sin()

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

Specified by:

sin in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

sinh

public final DimensionlessVector sinh()

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

Specified by:

sinh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

sqrt

public final DimensionlessVector sqrt()

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

Specified by:

sqrt in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

tan

public final DimensionlessVector tan()

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

Specified by:

tan in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

tanh

public final DimensionlessVector tanh()

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

Specified by:

tanh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T

inv

public final DimensionlessVector inv()

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

Specified by:

inv in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessVector>

Returns:

T; the modified T