org.djunits.value.vfloat.scalar

Class FloatTime.Rel

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<TimeUnit>

org.djunits.value.vfloat.scalar.FloatTime.Rel

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<TimeUnit>>, MathFunctions<FloatScalar<TimeUnit>>, Relative, Value<TimeUnit>, FloatMathFunctions<FloatScalar<TimeUnit>>

Enclosing interface:

FloatTime

public static class FloatTime.Rel
extends FloatScalar.Rel<TimeUnit>

Easy access methods for the Time FloatScalar. Instead of
FloatScalar.Rel<TimeUnit> value = new FloatScalar.Rel<TimeUnit>(100.0, TimeUnit.SI);
we can now write
FloatTime.Rel value = new FloatTime.Rel(100.0, TimeUnit.SI);
The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-10-04 20:47:10 +0200 (Sun, 04 Oct 2015) $, @version $Revision: 86 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

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 inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

si

Constructor Summary

Constructors

Constructor and Description
Rel(double value, TimeUnit unit) Construct FloatTime.Rel scalar using a double value.
Rel(FloatScalar.Rel<TimeUnit> value) Construct FloatTime.Rel scalar.
Rel(float value, TimeUnit unit) Construct FloatTime.Rel scalar.

Method Summary

Modifier and Type	Method and Description
FloatTime.Rel	abs() Set the value(s) to their absolute value.
FloatTime.Rel	acos() Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
FloatTime.Rel	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.
FloatTime.Rel	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.
FloatTime.Rel	cbrt() Set the value(s) to the(ir) cube root.
FloatTime.Rel	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.
FloatTime.Rel	cos() Set the value(s) to the trigonometric cosine of the value(s).
FloatTime.Rel	cosh() Set the value(s) to the hyperbolic cosine of the value(s).
FloatTime.Rel	divideBy(double factor) Divide scalar by a double factor.
FloatTime.Rel	divideBy(float divisor) Scale the value(s) by the inverse of a factor; i.e.
FloatDimensionless.Rel	divideBy(FloatTime.Rel v) Calculate the division of FloatTime and FloatTime, which results in a FloatDimensionless scalar.
FloatTime.Rel	exp() Set the value(s) to Euler's number e raised to the power of the value(s).
FloatTime.Rel	expm1() Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
FloatTime.Rel	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.
static FloatTime.Rel	interpolate(FloatTime.Rel zero, FloatTime.Rel one, double ratio) Interpolate between two values.
static FloatTime.Rel	interpolate(FloatTime.Rel zero, FloatTime.Rel one, float ratio) Interpolate between two values.
FloatTime.Rel	inv() Set the value(s) to the complement (1.0/x) of the value(s).
FloatTime.Rel	log() Set the value(s) to the natural logarithm (base e) of the value(s).
FloatTime.Rel	log10() Set the value(s) to the base 10 logarithm of the value(s).
FloatTime.Rel	log1p() Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
FloatTime.Rel	minus(FloatTime.Rel v) Relative scalar minus Relative scalar = Relative scalar.
FloatTime.Rel	multiplyBy(double factor) Multiply scalar with a double factor.
FloatTime.Rel	multiplyBy(float factor) Scale the value(s) by a factor.
FloatSpeed	multiplyBy(FloatAcceleration v) Calculate the multiplication of FloatTime and FloatAcceleration, which results in a FloatSpeed scalar.
FloatElectricalCharge	multiplyBy(FloatElectricalCurrent v) Calculate the multiplication of FloatTime and FloatElectricalCurrent, which results in a FloatElectricalCharge scalar.
FloatMass	multiplyBy(FloatFlowMass v) Calculate the multiplication of FloatTime and FloatFlowMass, which results in a FloatMass scalar.
FloatVolume	multiplyBy(FloatFlowVolume v) Calculate the multiplication of FloatTime and FloatFlowVolume, which results in a FloatVolume scalar.
FloatDimensionless.Rel	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatTime and FloatFrequency, which results in a FloatDimensionless scalar.
FloatMoney	multiplyBy(FloatMoneyPerTime v) Calculate the multiplication of FloatTime and FloatMoneyPerTime, which results in a FloatMoney scalar.
FloatEnergy	multiplyBy(FloatPower v) Calculate the multiplication of FloatTime and FloatPower, which results in a FloatEnergy scalar.
FloatLength.Rel	multiplyBy(FloatSpeed v) Calculate the multiplication of FloatTime and FloatSpeed, which results in a FloatLength scalar.
FloatTime.Abs	plus(FloatTime.Abs v) Relative scalar plus Absolute scalar = Absolute scalar.
FloatTime.Rel	plus(FloatTime.Rel v) Relative scalar plus Relative scalar = Relative scalar.
FloatTime.Rel	pow(double x) Set the value(s) to the value(s) raised to the power of the argument.
FloatTime.Rel	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
FloatTime.Rel	round() Set the value(s) to the closest long to the argument with ties rounding up.
FloatTime.Rel	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.
FloatTime.Rel	sin() Set the value(s) to the trigonometric sine of the value(s).
FloatTime.Rel	sinh() Set the value(s) to the hyperbolic sine of the value(s).
FloatTime.Rel	sqrt() Set the value(s) to the correctly rounded positive square root of the value(s).
FloatTime.Rel	tan() Set the value(s) to the trigonometric tangent of the value(s).
FloatTime.Rel	tanh() Set the value(s) to the hyperbolic tangent of the value(s).
FloatTime.Abs	toAbs() Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).
FloatTime.Rel	toDegrees() Set the value(s) to approximately equivalent angle(s) measured in degrees.
FloatTime.Rel	toRadians() Set the value(s) to approximately equivalent angle(s) measured in radians.

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

compareTo, eq, ge, getSI, gt, le, lt, minus, ne, plus

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

Constructor Detail

Rel

public Rel(float value,
           TimeUnit unit)

Construct FloatTime.Rel scalar.

Parameters:

value - float value

unit - unit for the float value

Rel

public Rel(double value,
           TimeUnit unit)

Construct FloatTime.Rel scalar using a double value.

Parameters:

value - float value

unit - unit for the float value

Rel

public Rel(FloatScalar.Rel<TimeUnit> value)

Construct FloatTime.Rel scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

interpolate

public static FloatTime.Rel interpolate(FloatTime.Rel zero,
                                        FloatTime.Rel one,
                                        float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

interpolate

public static FloatTime.Rel interpolate(FloatTime.Rel zero,
                                        FloatTime.Rel one,
                                        double ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

abs

public final FloatTime.Rel abs()

Set the value(s) to their absolute value.

Specified by:

abs in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

abs in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

acos

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

Overrides:

acos in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

asin

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

Overrides:

asin in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

atan

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

Overrides:

atan in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

cbrt

public final FloatTime.Rel cbrt()

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

Specified by:

cbrt in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

cbrt in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

ceil

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

Overrides:

ceil in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

cos

public final FloatTime.Rel cos()

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

Specified by:

cos in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

cos in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

cosh

public final FloatTime.Rel cosh()

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

Specified by:

cosh in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

cosh in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

exp

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

Overrides:

exp in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

expm1

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

Overrides:

expm1 in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

floor

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

Overrides:

floor in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

log

public final FloatTime.Rel log()

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

Specified by:

log in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

log in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

log10

public final FloatTime.Rel log10()

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

Specified by:

log10 in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

log10 in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

log1p

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

Overrides:

log1p in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

rint

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

Overrides:

rint in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

round

public final FloatTime.Rel round()

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

Specified by:

round in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

round in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

signum

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

Overrides:

signum in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

sin

public final FloatTime.Rel sin()

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

Specified by:

sin in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

sin in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

sinh

public final FloatTime.Rel sinh()

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

Specified by:

sinh in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

sinh in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

sqrt

public final FloatTime.Rel sqrt()

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

Specified by:

sqrt in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

sqrt in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

tan

public final FloatTime.Rel tan()

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

Specified by:

tan in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

tan in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

tanh

public final FloatTime.Rel tanh()

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

Specified by:

tanh in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

tanh in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

inv

public final FloatTime.Rel inv()

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

Specified by:

inv in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

inv in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

toDegrees

public final FloatTime.Rel toDegrees()

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

Specified by:

toDegrees in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

toDegrees in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

toRadians

public final FloatTime.Rel toRadians()

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

Specified by:

toRadians in interface MathFunctions<FloatScalar<TimeUnit>>

Overrides:

toRadians in class FloatScalar.Rel<TimeUnit>

Returns:

T; the modified T

pow

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

Overrides:

pow in class FloatScalar.Rel<TimeUnit>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

multiplyBy

public final FloatTime.Rel multiplyBy(float factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface FloatMathFunctions<FloatScalar<TimeUnit>>

Overrides:

multiplyBy in class FloatScalar.Rel<TimeUnit>

Parameters:

factor - float; the multiplier

Returns:

T; the modified T

multiplyBy

public final FloatTime.Rel multiplyBy(double factor)

Multiply scalar with a double factor.

Parameters:

factor - the factor to multiply with

Returns:

new instance of a relative time

divideBy

public final FloatTime.Rel divideBy(float divisor)

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

Specified by:

divideBy in interface FloatMathFunctions<FloatScalar<TimeUnit>>

Overrides:

divideBy in class FloatScalar.Rel<TimeUnit>

Parameters:

divisor - float; the divisor

Returns:

T; the modified T

divideBy

public final FloatTime.Rel divideBy(double factor)

Divide scalar by a double factor.

Parameters:

factor - the factor to divide by

Returns:

new instance of a relative time

plus

public final FloatTime.Rel plus(FloatTime.Rel v)

Relative scalar plus Relative scalar = Relative scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

minus

public final FloatTime.Rel minus(FloatTime.Rel v)

Relative scalar minus Relative scalar = Relative scalar.

Parameters:

v - the value to subtract

Returns:

difference of this value and v as a new object

plus

public final FloatTime.Abs plus(FloatTime.Abs v)

Relative scalar plus Absolute scalar = Absolute scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

toAbs

public final FloatTime.Abs toAbs()

Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).

Returns:

an absolute version of this relative time scalar.

divideBy

public final FloatDimensionless.Rel divideBy(FloatTime.Rel v)

Calculate the division of FloatTime and FloatTime, which results in a FloatDimensionless scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatDimensionless scalar as a division of FloatTime and FloatTime

multiplyBy

public final FloatDimensionless.Rel multiplyBy(FloatFrequency v)

Calculate the multiplication of FloatTime and FloatFrequency, which results in a FloatDimensionless scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatDimensionless scalar as a multiplication of FloatTime and FloatFrequency

multiplyBy

public final FloatElectricalCharge multiplyBy(FloatElectricalCurrent v)

Calculate the multiplication of FloatTime and FloatElectricalCurrent, which results in a FloatElectricalCharge scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatElectricalCharge scalar as a multiplication of FloatTime and FloatElectricalCurrent

multiplyBy

public final FloatMass multiplyBy(FloatFlowMass v)

Calculate the multiplication of FloatTime and FloatFlowMass, which results in a FloatMass scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatMass scalar as a multiplication of FloatTime and FloatFlowMass

multiplyBy

public final FloatVolume multiplyBy(FloatFlowVolume v)

Calculate the multiplication of FloatTime and FloatFlowVolume, which results in a FloatVolume scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatVolume scalar as a multiplication of FloatTime and FloatFlowVolume

multiplyBy

public final FloatSpeed multiplyBy(FloatAcceleration v)

Calculate the multiplication of FloatTime and FloatAcceleration, which results in a FloatSpeed scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatSpeed scalar as a multiplication of FloatTime and FloatAcceleration

multiplyBy

public final FloatEnergy multiplyBy(FloatPower v)

Calculate the multiplication of FloatTime and FloatPower, which results in a FloatEnergy scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatEnergy scalar as a multiplication of FloatTime and FloatPower

multiplyBy

public final FloatLength.Rel multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatTime and FloatSpeed, which results in a FloatLength scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatLength scalar as a multiplication of FloatTime and FloatSpeed

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerTime v)

Calculate the multiplication of FloatTime and FloatMoneyPerTime, which results in a FloatMoney scalar.

Parameters:

v - FloatTime scalar

Returns:

FloatMoney scalar as a multiplication of FloatTime and FloatMoneyPerTime