org.djunits.value.vdouble.scalar

Class MoneyPerTime

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>

org.djunits.value.vdouble.scalar.TypedDoubleScalarRel<MoneyPerTimeUnit,MoneyPerTime>

org.djunits.value.vdouble.scalar.MoneyPerTime

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel<MoneyPerTimeUnit>>, MathFunctionsAbs<DoubleScalar.Rel<MoneyPerTimeUnit>>, MathFunctionsRel<DoubleScalar.Rel<MoneyPerTimeUnit>>, Relative, Value<MoneyPerTimeUnit>, DoubleMathFunctions<DoubleScalar<MoneyPerTimeUnit>>

public class MoneyPerTime
extends TypedDoubleScalarRel<MoneyPerTimeUnit,MoneyPerTime>

Easy access methods for the MoneyPerTime DoubleScalar, which is relative by definition. Instead of:

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

we can now write:

 MoneyPerTime value = new MoneyPerTime(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.vdouble.scalar.DoubleScalar

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

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

si

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
MoneyPerTime(double value, MoneyPerTimeUnit unit) Construct MoneyPerTime scalar.
MoneyPerTime(MoneyPerTime value) Construct MoneyPerTime scalar.

Method Summary

Modifier and Type	Method and Description
Money	divideBy(Frequency v) Calculate the division of MoneyPerTime and Frequency, which results in a Money scalar.
Dimensionless	divideBy(MoneyPerTime v) Calculate the division of MoneyPerTime and MoneyPerTime, which results in a Dimensionless scalar.
protected MoneyPerTime	instantiateTypeRel(double value, MoneyPerTimeUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static MoneyPerTime	interpolate(MoneyPerTime zero, MoneyPerTime one, double ratio) Interpolate between two values.
static MoneyPerTime	max(MoneyPerTime r1, MoneyPerTime r2) Return the maximum value of two monetary scalars.
static MoneyPerTime	max(MoneyPerTime r1, MoneyPerTime r2, MoneyPerTime... rn) Return the maximum value of more than two monetary scalars.
static MoneyPerTime	min(MoneyPerTime r1, MoneyPerTime r2) Return the minimum value of two monetary scalars.
static MoneyPerTime	min(MoneyPerTime r1, MoneyPerTime r2, MoneyPerTime... rn) Return the minimum value of more than two monetary scalars.
Money	multiplyBy(Duration v) Calculate the multiplication of MoneyPerTime and Duration, which results in a Money scalar.

Methods inherited from class org.djunits.value.vdouble.scalar.TypedDoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

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

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Constructor Detail

MoneyPerTime

public MoneyPerTime(double value,
                    MoneyPerTimeUnit unit)

Construct MoneyPerTime scalar.

Parameters:

value - double value

unit - unit for the double value

MoneyPerTime

public MoneyPerTime(MoneyPerTime value)

Construct MoneyPerTime scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeRel

protected final MoneyPerTime instantiateTypeRel(double value,
                                                MoneyPerTimeUnit unit)

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

Specified by:

instantiateTypeRel in class TypedDoubleScalarRel<MoneyPerTimeUnit,MoneyPerTime>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

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

max

public static MoneyPerTime max(MoneyPerTime r1,
                               MoneyPerTime 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 MoneyPerTime max(MoneyPerTime r1,
                               MoneyPerTime r2,
                               MoneyPerTime... 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 MoneyPerTime min(MoneyPerTime r1,
                               MoneyPerTime 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 MoneyPerTime min(MoneyPerTime r1,
                               MoneyPerTime r2,
                               MoneyPerTime... 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 Dimensionless divideBy(MoneyPerTime v)

Calculate the division of MoneyPerTime and MoneyPerTime, which results in a Dimensionless scalar.

Parameters:

v - MoneyPerTime scalar

Returns:

Dimensionless scalar as a division of MoneyPerTime and MoneyPerTime

multiplyBy

public final Money multiplyBy(Duration v)

Calculate the multiplication of MoneyPerTime and Duration, which results in a Money scalar.

Parameters:

v - MoneyPerTime scalar

Returns:

Money scalar as a multiplication of MoneyPerTime and Duration

divideBy

public final Money divideBy(Frequency v)

Calculate the division of MoneyPerTime and Frequency, which results in a Money scalar.

Parameters:

v - MoneyPerTime scalar

Returns:

Money scalar as a division of MoneyPerTime and Frequency