org.opentrafficsim.core.value.vfloat.scalar

Class FloatScalar.Rel<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.FloatScalar.Rel<U>

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<U>>, Relative, Value<U>

Enclosing class:

FloatScalar<U extends Unit<U>>

public static class FloatScalar.Rel<U extends Unit<U>>
extends FloatScalar<U>
implements Relative, Comparable<FloatScalar.Rel<U>>

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
Rel(FloatScalar.Rel<U> value) Construct a new Relative Immutable FloatScalar from an existing Relative Immutable FloatScalar.
Rel(float value, U unit) Construct a new Relative Immutable FloatScalar.
Rel(MutableFloatScalar.Rel<U> value) Construct a new Relative Immutable FloatScalar from an existing Relative MutableFloatScalar.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FloatScalar.Rel<U> o)
FloatScalar.Rel<U>	copy() Create a deep copy of this Value.
boolean	eq(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is equal to a FloatScalar.Rel<U>.
boolean	eq(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is equal to a MutableFloatScalar.Rel<U>.
boolean	ge(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than a FloatScalar.Rel<U>.
boolean	ge(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than a MutableFloatScalar.Rel<U>.
boolean	gt(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than or equal to a FloatScalar.Rel<U>.
boolean	gt(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than or equal to a MutableFloatScalar.Rel<U>.
boolean	le(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is less than or equal to a FloatScalar.Rel<U>.
boolean	le(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is less than or equal to a MutableFloatScalar.Rel<U>.
boolean	lt(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is less than a FloatScalar.Rel<U>.
boolean	lt(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is less than a MutableFloatScalar.Rel<U>.
MutableFloatScalar.Rel<U>	mutable() Create a mutable version of this FloatScalar.
boolean	ne(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is not equal to a FloatScalar.Rel<U>.
boolean	ne(MutableFloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is not equal to a MutableFloatScalar.Rel<U>.

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

Rel

public Rel(float value,
           U unit)

Construct a new Relative Immutable FloatScalar.

Parameters:

value - float; the value of the new Relative Immutable FloatScalar

unit - U; the unit of the new Relative Immutable FloatScalar

Rel

public Rel(FloatScalar.Rel<U> value)

Construct a new Relative Immutable FloatScalar from an existing Relative Immutable FloatScalar.

Parameters:

value - FloatScalar.Rel<U>; the reference

Rel

public Rel(MutableFloatScalar.Rel<U> value)

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

Parameters:

value - MutableFloatScalar.Rel<U>; the reference

Method Detail

mutable

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

compareTo

public final int compareTo(FloatScalar.Rel<U> o)

Specified by:

compareTo in interface Comparable<FloatScalar.Rel<U extends Unit<U>>>

copy

public final FloatScalar.Rel<U> copy()

Create a deep copy of this Value.

Specified by:

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

Returns:

Value<U>

lt

public final boolean lt(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is less than a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

le

public final boolean le(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is less than or equal to a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

gt

public final boolean gt(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is greater than or equal to a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

ge

public final boolean ge(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is greater than a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

eq

public final boolean eq(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is equal to a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

ne

public final boolean ne(FloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is not equal to a FloatScalar.Rel<U>.

Parameters:

o - FloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

lt

public final boolean lt(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is less than a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

le

public final boolean le(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is less than or equal to a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

gt

public final boolean gt(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is greater than or equal to a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

ge

public final boolean ge(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is greater than a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

eq

public final boolean eq(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is equal to a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean

ne

public final boolean ne(MutableFloatScalar.Rel<U> o)

Test if this FloatScalar.Rel<U> is not equal to a MutableFloatScalar.Rel<U>.

Parameters:

o - MutableFloatScalar.Rel<U>; the right hand side operand of the comparison

Returns:

boolean