org.opentrafficsim.core.value.vfloat.scalar

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

java.lang.Object

java.lang.Number

org.opentrafficsim.core.value.Scalar<U>

org.opentrafficsim.core.value.vfloat.scalar.FloatScalar<U>

org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar<U>

org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar.Abs<U>

Type Parameters:

U - Unit

All Implemented Interfaces:

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

Enclosing class:

MutableFloatScalar<U extends Unit<U>>

public static class MutableFloatScalar.Abs<U extends Unit<U>>
extends MutableFloatScalar<U>
implements Absolute, Comparable<MutableFloatScalar.Abs<U>>

See Also:

Serialized Form

Nested Class Summary

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

MutableFloatScalar.Abs<U extends Unit<U>>, MutableFloatScalar.Rel<U extends Unit<U>>

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<U> value)

Construct a new Absolute MutableFloatScalar from an existing Absolute Immutable FloatScalar.

Parameters:

value - FloatScalar.Abs<U>; the reference

MutableFloatScalar.Abs

public MutableFloatScalar.Abs(MutableFloatScalar.Abs<U> value)

Construct a new Absolute MutableFloatScalar from an existing Absolute MutableFloatScalar.

Parameters:

value - MutableFloatScalar.Abs<U>; the reference

Method Detail

mutable

public final MutableFloatScalar.Abs<U> 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<U extends Unit<U>>

Returns:

MutableFloatScalar<U>

immutable

public final FloatScalar.Abs<U> 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<U extends Unit<U>>

Returns:

FloatScalar<U>; immutable version of this FloatScalar

compareTo

public final int compareTo(MutableFloatScalar.Abs<U> o)

Specified by:

compareTo in interface Comparable<MutableFloatScalar.Abs<U extends Unit<U>>>

copy

public final MutableFloatScalar.Abs<U> copy()

Create a deep copy of this Value.

Specified by:

copy in interface Value<U extends Unit<U>>

Returns:

Value<U>

incrementBy

public final MutableFloatScalar.Abs<U> incrementBy(FloatScalar.Rel<U> increment)

Increment the value by the supplied value and return the result.

Parameters:

increment - FloatScalar.Rel<U>; amount by which the value is incremented

Returns:

MutableFloatScalar.Abs<U>

decrementBy

public final MutableFloatScalar.Abs<U> decrementBy(FloatScalar.Rel<U> decrement)

Decrement the value by the supplied value and return the result.

Parameters:

decrement - FloatScalar.Rel<U>; amount by which the value is decremented

Returns:

MutableFloatScalar.Abs<U>

abs

public final MutableFloatScalar.Abs<U> abs()

Set the value(s) to their absolute value.

Specified by:

abs in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

acos

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

Specified by:

acos in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

asin

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

Specified by:

asin in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

atan

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

Specified by:

atan in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

cbrt

public final MutableFloatScalar.Abs<U> cbrt()

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

Specified by:

cbrt in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

ceil

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

Specified by:

ceil in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

cos

public final MutableFloatScalar.Abs<U> cos()

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

Specified by:

cos in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

cosh

public final MutableFloatScalar.Abs<U> cosh()

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

Specified by:

cosh in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

exp

public final MutableFloatScalar.Abs<U> 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<U extends Unit<U>>>

Returns:

T; the modified T

expm1

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

Specified by:

expm1 in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

floor

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

Specified by:

floor in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

log

public final MutableFloatScalar.Abs<U> log()

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

Specified by:

log in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

log10

public final MutableFloatScalar.Abs<U> log10()

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

Specified by:

log10 in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

log1p

public final MutableFloatScalar.Abs<U> 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<U extends Unit<U>>>

Returns:

T; the modified T

pow

public final MutableFloatScalar.Abs<U> 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<U extends Unit<U>>>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

rint

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

Specified by:

rint in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

round

public final MutableFloatScalar.Abs<U> round()

Set the value(s) to the closest long to the argument with ties rounding up.

Specified by:

round in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

signum

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

Specified by:

signum in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

sin

public final MutableFloatScalar.Abs<U> sin()

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

Specified by:

sin in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

sinh

public final MutableFloatScalar.Abs<U> sinh()

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

Specified by:

sinh in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

sqrt

public final MutableFloatScalar.Abs<U> sqrt()

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

Specified by:

sqrt in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

tan

public final MutableFloatScalar.Abs<U> tan()

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

Specified by:

tan in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

tanh

public final MutableFloatScalar.Abs<U> tanh()

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

Specified by:

tanh in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

toDegrees

public final MutableFloatScalar.Abs<U> toDegrees()

Set the value(s) to approximately equivalent angle(s) measured in degrees.

Specified by:

toDegrees in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

toRadians

public final MutableFloatScalar.Abs<U> toRadians()

Set the value(s) to approximately equivalent angle(s) measured in radians.

Specified by:

toRadians in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T

inv

public final MutableFloatScalar.Abs<U> inv()

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

Specified by:

inv in interface MathFunctions<FloatScalar<U extends Unit<U>>>

Returns:

T; the modified T