MutableDoubleVector.Abs (Open Traffic Sim core classes 0.1 API)

java.lang.Object
- org.opentrafficsim.core.value.AbstractValue
- - org.opentrafficsim.core.value.vdouble.vector.DoubleVector
 - - org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector
 - - org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector.Abs

Type Parameters:
U - Unit

All Implemented Interfaces:

Serializable, Absolute, MathFunctions<MutableDoubleVector>, Value, DoubleMathFunctions<MutableDoubleVector>, ReadOnlyDoubleVectorFunctions, WriteDoubleVectorFunctions

Direct Known Subclasses:

MutableDoubleVector.Abs.Dense, MutableDoubleVector.Abs.Sparse

Enclosing class:

MutableDoubleVector>
```
public abstract static class MutableDoubleVector.Abs>
extends MutableDoubleVector
implements Absolute
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MutableDoubleVector.Abs.Dense>

static class MutableDoubleVector.Abs.Sparse>
- Nested classes/interfaces inherited from class org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector
 MutableDoubleVector.Abs>, MutableDoubleVector.Rel>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MutableDoubleVector.Abs.Dense<U extends Unit<U>>`
`static class`	`MutableDoubleVector.Abs.Sparse<U extends Unit<U>>`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MutableDoubleVector.Abs(U unit)
Construct a new Absolute MutableDoubleVector.

Constructors
Modifier	Constructor and Description
`protected`	`MutableDoubleVector.Abs(U unit)` Construct a new Absolute MutableDoubleVector.

Method Summary

Methods
Modifier and Type	Method and Description
`MutableDoubleVector.Abs<U>`	`abs()` Set the value(s) to their absolute value.
`MutableDoubleVector.Abs<U>`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`MutableDoubleVector.Abs<U>`	`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.
`MutableDoubleVector.Abs<U>`	`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.
`MutableDoubleVector.Abs<U>`	`cbrt()` Set the value(s) to the(ir) cube root.
`MutableDoubleVector.Abs<U>`	`ceil()` Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
`MutableDoubleVector.Abs<U>`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`MutableDoubleVector.Abs<U>`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`MutableDoubleVector.Abs<U>`	`decrementBy(DoubleVector.Rel<U> decrement)` Decrement the value by the supplied value and return the result.
`MutableDoubleVector.Abs<U>`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`MutableDoubleVector.Abs<U>`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`MutableDoubleVector.Abs<U>`	`floor()` Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
`DoubleScalar.Abs<U>`	`get(int index)` Retrieve the value stored at a specified index as a DoubleScalar.
`MutableDoubleVector.Abs<U>`	`incrementBy(DoubleVector.Rel<U> increment)` Increment the value by the supplied value and return the result.
`MutableDoubleVector.Abs<U>`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`MutableDoubleVector.Abs<U>`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`MutableDoubleVector.Abs<U>`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`MutableDoubleVector.Abs<U>`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`MutableDoubleVector.Abs<U>`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`MutableDoubleVector.Abs<U>`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`MutableDoubleVector.Abs<U>`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`MutableDoubleVector.Abs<U>`	`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.
`MutableDoubleVector.Abs<U>`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`MutableDoubleVector.Abs<U>`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`MutableDoubleVector.Abs<U>`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`MutableDoubleVector.Abs<U>`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`MutableDoubleVector.Abs<U>`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`MutableDoubleVector.Abs<U>`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`MutableDoubleVector.Abs<U>`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

Methods inherited from class org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector
assign, checkCopyOnWrite, decrementBy, decrementByImpl, divide, immutable, incrementByImpl, multiply, normalize, scaleValueByValue, scaleValueByValue, set, setInUnit, setSI

Methods inherited from class org.opentrafficsim.core.value.vdouble.vector.DoubleVector
cardinality, checkIndex, checkNonEmpty, checkSize, checkSize, createMatrix1D, deepCopyData, deepCopyOfData, denseToSparse, denseToSparse, equals, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, getVectorSI, hashCode, initialize, initialize, initialize, interpolate, interpolate, interpolate, interpolate, minus, minus, minus, minus, minus, minus, minus, minus, minus, mutable, plus, plus, plus, plus, plus, plus, safeGet, safeSet, size, sparseToDense, sparseToDense, times, times, times, times, times, times, times, times, times, times, toString, toString, toString, toString, zSum

Methods inherited from class org.opentrafficsim.core.value.AbstractValue
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.core.value.Value
copy

- Constructor Detail
 - MutableDoubleVector.Abs
```
protected MutableDoubleVector.Abs(U unit)
```
 Construct a new Absolute MutableDoubleVector.
 
 Parameters:
 unit - U; the unit of the new Absolute MutableDoubleVector
- Method Detail
 - get
```
public final DoubleScalar.Abs get(int index)
 throws ValueException
```
 Retrieve the value stored at a specified index as a DoubleScalar.
 
 Specified by:
 
 get in interface ReadOnlyDoubleVectorFunctions>
 
 Parameters:
 index - int; index of the value to retrieve
 
 Returns:
 DoubleScalar; the strongly typed value of the selected cell
 
 Throws:
 
 ValueException - when index out of range (index < 0 or index >= size())
 - incrementBy
```
public final MutableDoubleVector.Abs incrementBy(DoubleVector.Rel increment)
 throws ValueException
```
 Increment the value by the supplied value and return the result.
 
 Parameters:
 increment - DoubleVector.Rel; amount by which the value is incremented
 
 Returns:
 MutableDoubleVector.Abs
 
 Throws:
 
 ValueException - when the size of increment is not identical to the size of this
 - decrementBy
```
public final MutableDoubleVector.Abs decrementBy(DoubleVector.Rel decrement)
 throws ValueException
```
 Decrement the value by the supplied value and return the result.
 
 Parameters:
 decrement - DoubleVector.Rel; amount by which the value is decremented
 
 Returns:
 MutableDoubleVector.Abs
 
 Throws:
 
 ValueException - when the size of increment is not identical to the size of this
 - abs
```
public final MutableDoubleVector.Abs abs()
```
 Set the value(s) to their absolute value.
 
 Specified by:
 
 abs in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - acos
```
public final MutableDoubleVector.Abs 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 MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - asin
```
public final MutableDoubleVector.Abs 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 MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - atan
```
public final MutableDoubleVector.Abs 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 MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - cbrt
```
public final MutableDoubleVector.Abs cbrt()
```
 Set the value(s) to the(ir) cube root.
 
 Specified by:
 
 cbrt in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - ceil
```
public final MutableDoubleVector.Abs ceil()
```
 Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
 
 Specified by:
 
 ceil in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - cos
```
public final MutableDoubleVector.Abs cos()
```
 Set the value(s) to the trigonometric cosine of the value(s).
 
 Specified by:
 
 cos in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - cosh
```
public final MutableDoubleVector.Abs cosh()
```
 Set the value(s) to the hyperbolic cosine of the value(s).
 
 Specified by:
 
 cosh in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - exp
```
public final MutableDoubleVector.Abs exp()
```
 Set the value(s) to Euler's number e raised to the power of the value(s).
 
 Specified by:
 
 exp in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - expm1
```
public final MutableDoubleVector.Abs 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 MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - floor
```
public final MutableDoubleVector.Abs floor()
```
 Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
 
 Specified by:
 
 floor in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - log
```
public final MutableDoubleVector.Abs log()
```
 Set the value(s) to the natural logarithm (base e) of the value(s).
 
 Specified by:
 
 log in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - log10
```
public final MutableDoubleVector.Abs log10()
```
 Set the value(s) to the base 10 logarithm of the value(s).
 
 Specified by:
 
 log10 in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - log1p
```
public final MutableDoubleVector.Abs log1p()
```
 Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
 
 Specified by:
 
 log1p in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - pow
```
public final MutableDoubleVector.Abs pow(double x)
```
 Set the value(s) to the value(s) raised to the power of the argument.
 
 Specified by:
 
 pow in interface MathFunctions<MutableDoubleVector>>
 
 Parameters:
 x - double; the value to use as the power
 
 Returns:
 T; the modified T
 - rint
```
public final MutableDoubleVector.Abs rint()
```
 Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
 
 Specified by:
 
 rint in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - round
```
public final MutableDoubleVector.Abs round()
```
 Set the value(s) to the closest long to the argument with ties rounding up.
 
 Specified by:
 
 round in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - signum
```
public final MutableDoubleVector.Abs 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 MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - sin
```
public final MutableDoubleVector.Abs sin()
```
 Set the value(s) to the trigonometric sine of the value(s).
 
 Specified by:
 
 sin in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - sinh
```
public final MutableDoubleVector.Abs sinh()
```
 Set the value(s) to the hyperbolic sine of the value(s).
 
 Specified by:
 
 sinh in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - sqrt
```
public final MutableDoubleVector.Abs sqrt()
```
 Set the value(s) to the correctly rounded positive square root of the value(s).
 
 Specified by:
 
 sqrt in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - tan
```
public final MutableDoubleVector.Abs tan()
```
 Set the value(s) to the trigonometric tangent of the value(s).
 
 Specified by:
 
 tan in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - tanh
```
public final MutableDoubleVector.Abs tanh()
```
 Set the value(s) to the hyperbolic tangent of the value(s).
 
 Specified by:
 
 tanh in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - toDegrees
```
public final MutableDoubleVector.Abs toDegrees()
```
 Set the value(s) to approximately equivalent angle(s) measured in degrees.
 
 Specified by:
 
 toDegrees in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - toRadians
```
public final MutableDoubleVector.Abs toRadians()
```
 Set the value(s) to approximately equivalent angle(s) measured in radians.
 
 Specified by:
 
 toRadians in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T
 - inv
```
public final MutableDoubleVector.Abs inv()
```
 Set the value(s) to the complement (1.0/x) of the value(s).
 
 Specified by:
 
 inv in interface MathFunctions<MutableDoubleVector>>
 
 Returns:
 T; the modified T

Class MutableDoubleVector.Abs<U extends Unit<U>>

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.core.value.vdouble.vector.MutableDoubleVector

Methods inherited from class org.opentrafficsim.core.value.vdouble.vector.DoubleVector

Methods inherited from class org.opentrafficsim.core.value.AbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface org.opentrafficsim.core.value.Value

Constructor Detail

MutableDoubleVector.Abs

Method Detail

get

incrementBy

decrementBy

abs

acos

asin

atan

cbrt

ceil

cos

cosh

exp

expm1

floor

log

log10

log1p

pow

rint

round

signum

sin

sinh

sqrt

tan

tanh

toDegrees

toRadians

inv