org.djunits.value.vfloat.scalar

Class FloatScalar.Rel<U extends Unit<U>>

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.FloatScalar<U>

org.djunits.value.vfloat.scalar.FloatScalar.Rel<U>

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<U>>, MathFunctionsAbs<FloatScalar.Rel<U>>, MathFunctionsRel<FloatScalar.Rel<U>>, Relative, Value<U>, FloatMathFunctions<FloatScalar<U>>

Direct Known Subclasses:

TypedFloatScalarRel

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

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
float	si The value, stored in the standard SI unit.

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

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.

Method Summary

Modifier and Type	Method and Description
FloatScalar.Rel<U>	abs() Set the value(s) to their absolute value.
FloatScalar.Rel<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(FloatScalar.Rel<U> o)
FloatScalar.Rel<U>	divideBy(float constant) Scale the value(s) by the inverse of a factor; i.e.
boolean	eq(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is equal to a FloatScalar.Rel<U>.
FloatScalar.Rel<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.
boolean	ge(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than a FloatScalar.Rel<U>.
float	getSI() Retrieve the value in the underlying SI unit.
boolean	gt(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is greater than or equal to a FloatScalar.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	lt(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is less than a FloatScalar.Rel<U>.
FloatScalar.Rel<U>	minus(FloatScalar.Rel<U> decrement) Decrement the value by the supplied value and return the result.
FloatScalar.Rel<U>	multiplyBy(float constant) Scale the value(s) by a factor.
boolean	ne(FloatScalar.Rel<U> o) Test if this FloatScalar.Rel<U> is not equal to a FloatScalar.Rel<U>.
FloatScalar.Rel<U>	plus(FloatScalar.Rel<U> increment) Increment the value by the supplied value and return the result.
FloatScalar.Rel<U>	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
FloatScalar.Rel<U>	round() Set the value(s) to the closest long to the argument with ties rounding up.

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar

divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.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

Methods inherited from interface org.djunits.value.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

si

public final float si

The value, stored in the standard SI unit.

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

Method Detail

compareTo

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

Specified by:

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

getSI

public final float getSI()

Retrieve the value in the underlying SI unit.

Specified by:

getSI in class FloatScalar<U extends Unit<U>>

Returns:

float

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

plus

public final FloatScalar.Rel<U> plus(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:

FloatScalar.Abs<U>

minus

public final FloatScalar.Rel<U> minus(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:

FloatScalar.Rel<U>

abs

public FloatScalar.Rel<U> abs()

Set the value(s) to their absolute value.

Specified by:

abs in interface MathFunctionsRel<FloatScalar.Rel<U extends Unit<U>>>

Returns:

T; the modified T

ceil

public FloatScalar.Rel<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 MathFunctionsAbs<FloatScalar.Rel<U extends Unit<U>>>

Returns:

T; the modified T

floor

public FloatScalar.Rel<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 MathFunctionsAbs<FloatScalar.Rel<U extends Unit<U>>>

Returns:

T; the modified T

rint

public FloatScalar.Rel<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 MathFunctionsAbs<FloatScalar.Rel<U extends Unit<U>>>

Returns:

T; the modified T

round

public FloatScalar.Rel<U> round()

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

Specified by:

round in interface MathFunctionsAbs<FloatScalar.Rel<U extends Unit<U>>>

Returns:

T; the modified T

multiplyBy

public FloatScalar.Rel<U> multiplyBy(float constant)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface FloatMathFunctions<FloatScalar<U extends Unit<U>>>

Parameters:

constant - float; the multiplier

Returns:

T; the modified T

divideBy

public FloatScalar.Rel<U> divideBy(float constant)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divideBy in interface FloatMathFunctions<FloatScalar<U extends Unit<U>>>

Parameters:

constant - float; the divisor

Returns:

T; the modified T