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

java.lang.Object
- java.lang.Number
- - org.opentrafficsim.core.value.Scalar
 - - org.opentrafficsim.core.value.vfloat.scalar.FloatScalar
 - - org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar
 - org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar.Abs

Type Parameters:
U - Unit

All Implemented Interfaces:

Serializable, Comparable<MutableFloatScalar.Abs>, Absolute, MathFunctions<FloatScalar>, Value, FloatMathFunctions<FloatScalar>

Enclosing class:

MutableFloatScalar>
```
public static class MutableFloatScalar.Abs>
extends MutableFloatScalar
implements Absolute, Comparable<MutableFloatScalar.Abs>
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar
 MutableFloatScalar.Abs>, MutableFloatScalar.Rel>

Constructor Summary

Constructors
Constructor and Description
`MutableFloatScalar.Abs(FloatScalar.Abs<U> value)` Construct a new Absolute MutableFloatScalar from an existing Absolute Immutable FloatScalar.
`MutableFloatScalar.Abs(float value, U unit)` Construct a new Absolute MutableFloatScalar.
`MutableFloatScalar.Abs(MutableFloatScalar.Abs<U> value)` Construct a new Absolute MutableFloatScalar from an existing Absolute MutableFloatScalar.

Method Summary

Methods
Modifier and Type	Method and Description
`MutableFloatScalar.Abs<U>`	`abs()` Set the value(s) to their absolute value.
`MutableFloatScalar.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.
`MutableFloatScalar.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.
`MutableFloatScalar.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.
`MutableFloatScalar.Abs<U>`	`cbrt()` Set the value(s) to the(ir) cube root.
`MutableFloatScalar.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.
`int`	`compareTo(MutableFloatScalar.Abs<U> o)`
`MutableFloatScalar.Abs<U>`	`copy()` Create a deep copy of this Value.
`MutableFloatScalar.Abs<U>`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`MutableFloatScalar.Abs<U>`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`MutableFloatScalar.Abs<U>`	`decrementBy(FloatScalar.Rel<U> decrement)` Decrement the value by the supplied value and return the result.
`MutableFloatScalar.Abs<U>`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`MutableFloatScalar.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).
`MutableFloatScalar.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.
`FloatScalar.Abs<U>`	`immutable()` Make (immutable) FloatScalar equivalent for any type of MutableFloatScalar.
`MutableFloatScalar.Abs<U>`	`incrementBy(FloatScalar.Rel<U> increment)` Increment the value by the supplied value and return the result.
`MutableFloatScalar.Abs<U>`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`MutableFloatScalar.Abs<U>`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`MutableFloatScalar.Abs<U>`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`MutableFloatScalar.Abs<U>`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`MutableFloatScalar.Abs<U>`	`mutable()` Create a mutable version of this FloatScalar.
`MutableFloatScalar.Abs<U>`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`MutableFloatScalar.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.
`MutableFloatScalar.Abs<U>`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`MutableFloatScalar.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.
`MutableFloatScalar.Abs<U>`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`MutableFloatScalar.Abs<U>`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`MutableFloatScalar.Abs<U>`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`MutableFloatScalar.Abs<U>`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`MutableFloatScalar.Abs<U>`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`MutableFloatScalar.Abs<U>`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`MutableFloatScalar.Abs<U>`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

Methods inherited from class org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar
decrementBy, decrementByImpl, divide, incrementBy, incrementByImpl, multiply

Methods inherited from class org.opentrafficsim.core.value.vfloat.scalar.FloatScalar
divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, getSI, hashCode, initialize, initialize, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, setValueSI, toString, toString, toString, toString

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

Methods inherited from class java.lang.Number
byteValue, shortValue

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

- Constructor Detail
 - MutableFloatScalar.Abs
```
public MutableFloatScalar.Abs(float value,
 U unit)
```
 Construct a new Absolute MutableFloatScalar.
 
 Parameters:
 value - float; the value of the new Absolute MutableFloatScalar
 unit - U; the unit of the new Absolute MutableFloatScalar
 - MutableFloatScalar.Abs
```
public MutableFloatScalar.Abs(FloatScalar.Abs value)
```
 Construct a new Absolute MutableFloatScalar from an existing Absolute Immutable FloatScalar.
 
 Parameters:
 value - FloatScalar.Abs; the reference
 - MutableFloatScalar.Abs
```
public MutableFloatScalar.Abs(MutableFloatScalar.Abs value)
```
 Construct a new Absolute MutableFloatScalar from an existing Absolute MutableFloatScalar.
 
 Parameters:
 value - MutableFloatScalar.Abs; the reference
- Method Detail
 - mutable
```
public final MutableFloatScalar.Abs mutable()
```
 Create a mutable version of this FloatScalar.
 The mutable version is created as a deep copy of this. Delayed copying is not worthwhile for a Scalar.
 
 Specified by:
 
 mutable in class FloatScalar>
 
 Returns:
 MutableFloatScalar
 - immutable
```
public final FloatScalar.Abs immutable()
```
 Make (immutable) FloatScalar equivalent for any type of MutableFloatScalar.
 The immutable version is created as a deep copy of this. Delayed copying is not worthwhile for a Scalar.
 
 Specified by:
 
 immutable in class MutableFloatScalar>
 
 Returns:
 FloatScalar; immutable version of this FloatScalar
 - compareTo
```
public final int compareTo(MutableFloatScalar.Abs o)
```
 Specified by:
 
 compareTo in interface Comparable<MutableFloatScalar.Abs>>
 - copy
```
public final MutableFloatScalar.Abs copy()
```
 Create a deep copy of this Value.
 
 Specified by:
 
 copy in interface Value>
 
 Returns:
 Value
 - incrementBy
```
public final MutableFloatScalar.Abs incrementBy(FloatScalar.Rel increment)
```
 Increment the value by the supplied value and return the result.
 
 Parameters:
 increment - FloatScalar.Rel; amount by which the value is incremented
 
 Returns:
 MutableFloatScalar.Abs
 - decrementBy
```
public final MutableFloatScalar.Abs decrementBy(FloatScalar.Rel decrement)
```
 Decrement the value by the supplied value and return the result.
 
 Parameters:
 decrement - FloatScalar.Rel; amount by which the value is decremented
 
 Returns:
 MutableFloatScalar.Abs
 - abs
```
public final MutableFloatScalar.Abs abs()
```
 Set the value(s) to their absolute value.
 
 Specified by:
 
 abs in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - acos
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - asin
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - atan
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - cbrt
```
public final MutableFloatScalar.Abs cbrt()
```
 Set the value(s) to the(ir) cube root.
 
 Specified by:
 
 cbrt in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - ceil
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - cos
```
public final MutableFloatScalar.Abs cos()
```
 Set the value(s) to the trigonometric cosine of the value(s).
 
 Specified by:
 
 cos in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - cosh
```
public final MutableFloatScalar.Abs cosh()
```
 Set the value(s) to the hyperbolic cosine of the value(s).
 
 Specified by:
 
 cosh in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - exp
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - expm1
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - floor
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - log
```
public final MutableFloatScalar.Abs log()
```
 Set the value(s) to the natural logarithm (base e) of the value(s).
 
 Specified by:
 
 log in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - log10
```
public final MutableFloatScalar.Abs log10()
```
 Set the value(s) to the base 10 logarithm of the value(s).
 
 Specified by:
 
 log10 in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - log1p
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - pow
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Parameters:
 x - double; the value to use as the power
 
 Returns:
 T; the modified T
 - rint
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - round
```
public final MutableFloatScalar.Abs round()
```
 Set the value(s) to the closest long to the argument with ties rounding up.
 
 Specified by:
 
 round in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - signum
```
public final MutableFloatScalar.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<FloatScalar>>
 
 Returns:
 T; the modified T
 - sin
```
public final MutableFloatScalar.Abs sin()
```
 Set the value(s) to the trigonometric sine of the value(s).
 
 Specified by:
 
 sin in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - sinh
```
public final MutableFloatScalar.Abs sinh()
```
 Set the value(s) to the hyperbolic sine of the value(s).
 
 Specified by:
 
 sinh in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - sqrt
```
public final MutableFloatScalar.Abs sqrt()
```
 Set the value(s) to the correctly rounded positive square root of the value(s).
 
 Specified by:
 
 sqrt in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - tan
```
public final MutableFloatScalar.Abs tan()
```
 Set the value(s) to the trigonometric tangent of the value(s).
 
 Specified by:
 
 tan in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - tanh
```
public final MutableFloatScalar.Abs tanh()
```
 Set the value(s) to the hyperbolic tangent of the value(s).
 
 Specified by:
 
 tanh in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - toDegrees
```
public final MutableFloatScalar.Abs toDegrees()
```
 Set the value(s) to approximately equivalent angle(s) measured in degrees.
 
 Specified by:
 
 toDegrees in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - toRadians
```
public final MutableFloatScalar.Abs toRadians()
```
 Set the value(s) to approximately equivalent angle(s) measured in radians.
 
 Specified by:
 
 toRadians in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T
 - inv
```
public final MutableFloatScalar.Abs inv()
```
 Set the value(s) to the complement (1.0/x) of the value(s).
 
 Specified by:
 
 inv in interface MathFunctions<FloatScalar>>
 
 Returns:
 T; the modified T

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

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar

Methods inherited from class org.opentrafficsim.core.value.vfloat.scalar.FloatScalar

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

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

MutableFloatScalar.Abs

MutableFloatScalar.Abs

MutableFloatScalar.Abs

Method Detail

mutable

immutable

compareTo

copy

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