org.djunits.value.vfloat.scalar

Class FloatMoneyPerTime

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>

org.djunits.value.vfloat.scalar.TypedFloatScalarRel<MoneyPerTimeUnit,FloatMoneyPerTime>

org.djunits.value.vfloat.scalar.FloatMoneyPerTime

All Implemented Interfaces:

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

public class FloatMoneyPerTime
extends TypedFloatScalarRel<MoneyPerTimeUnit,FloatMoneyPerTime>

Easy access methods for the MoneyPerTime FloatScalar, which is relative by definition. An example is Speed. Instead of:

 FloatScalar.Rel<MoneyPerTimeUnit> value = new FloatScalar.Rel<MoneyPerTimeUnit>(100.0, MoneyPerTimeUnit.SI);
 

we can now write:

 FloatMoneyPerTime value = new FloatMoneyPerTime(100.0, MoneyPerTimeUnit.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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version Sep 5, 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

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
FloatMoneyPerTime(double value, MoneyPerTimeUnit unit) Construct FloatMoneyPerTime scalar using a double value.
FloatMoneyPerTime(FloatMoneyPerTime value) Construct FloatMoneyPerTime scalar.
FloatMoneyPerTime(float value, MoneyPerTimeUnit unit) Construct FloatMoneyPerTime scalar.

Method Summary

Modifier and Type	Method and Description
FloatMoney	divideBy(FloatFrequency v) Calculate the division of FloatMoneyPerTime and FloatFrequency, which results in a FloatMoney scalar.
FloatDimensionless	divideBy(FloatMoneyPerTime v) Calculate the division of FloatMoneyPerTime and FloatMoneyPerTime, which results in a FloatDimensionless scalar.
protected FloatMoneyPerTime	instantiateTypeRel(float value, MoneyPerTimeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatMoneyPerTime	interpolate(FloatMoneyPerTime zero, FloatMoneyPerTime one, float ratio) Interpolate between two values.
static FloatMoneyPerTime	max(FloatMoneyPerTime r1, FloatMoneyPerTime r2) Return the maximum value of two monetary scalars.
static FloatMoneyPerTime	max(FloatMoneyPerTime r1, FloatMoneyPerTime r2, FloatMoneyPerTime... rn) Return the maximum value of more than two monetary scalars.
static FloatMoneyPerTime	min(FloatMoneyPerTime r1, FloatMoneyPerTime r2) Return the minimum value of two monetary scalars.
static FloatMoneyPerTime	min(FloatMoneyPerTime r1, FloatMoneyPerTime r2, FloatMoneyPerTime... rn) Return the minimum value of more than two monetary scalars.
FloatMoney	multiplyBy(FloatDuration v) Calculate the multiplication of FloatMoneyPerTime and FloatDuration, which results in a FloatMoney scalar.

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

abs, ceil, divideBy, floor, minus, multiplyBy, plus, rint, round

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

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

DIV, MULT, POW

Constructor Detail

FloatMoneyPerTime

public FloatMoneyPerTime(float value,
                         MoneyPerTimeUnit unit)

Construct FloatMoneyPerTime scalar.

Parameters:

value - float value

unit - unit for the float value

FloatMoneyPerTime

public FloatMoneyPerTime(FloatMoneyPerTime value)

Construct FloatMoneyPerTime scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMoneyPerTime

public FloatMoneyPerTime(double value,
                         MoneyPerTimeUnit unit)

Construct FloatMoneyPerTime scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateTypeRel

protected final FloatMoneyPerTime instantiateTypeRel(float value,
                                                     MoneyPerTimeUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateTypeRel in class TypedFloatScalarRel<MoneyPerTimeUnit,FloatMoneyPerTime>

Parameters:

value - the float value

unit - the unit

Returns:

R a new relative instance of the FloatScalar of the right type

interpolate

public static FloatMoneyPerTime interpolate(FloatMoneyPerTime zero,
                                            FloatMoneyPerTime 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

max

public static FloatMoneyPerTime max(FloatMoneyPerTime r1,
                                    FloatMoneyPerTime r2)

Return the maximum value of two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two monetary scalars

max

public static FloatMoneyPerTime max(FloatMoneyPerTime r1,
                                    FloatMoneyPerTime r2,
                                    FloatMoneyPerTime... rn)

Return the maximum value of more than two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two monetary scalars

min

public static FloatMoneyPerTime min(FloatMoneyPerTime r1,
                                    FloatMoneyPerTime r2)

Return the minimum value of two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two monetary scalars

min

public static FloatMoneyPerTime min(FloatMoneyPerTime r1,
                                    FloatMoneyPerTime r2,
                                    FloatMoneyPerTime... rn)

Return the minimum value of more than two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two monetary scalars

divideBy

public final FloatDimensionless divideBy(FloatMoneyPerTime v)

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

Parameters:

v - FloatMoneyPerTime scalar

Returns:

FloatDimensionless scalar as a division of FloatMoneyPerTime and FloatMoneyPerTime

multiplyBy

public final FloatMoney multiplyBy(FloatDuration v)

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

Parameters:

v - FloatMoneyPerTime scalar

Returns:

FloatMoney scalar as a multiplication of FloatMoneyPerTime and FloatDuration

divideBy

public final FloatMoney divideBy(FloatFrequency v)

Calculate the division of FloatMoneyPerTime and FloatFrequency, which results in a FloatMoney scalar.

Parameters:

v - FloatMoneyPerTime scalar

Returns:

FloatMoney scalar as a division of FloatMoneyPerTime and FloatFrequency