org.djunits.value.vfloat.scalar

Class FloatMoneyPerDuration

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<MoneyPerDurationUnit,FloatMoneyPerDuration>

org.djunits.value.vfloat.scalar.FloatMoneyPerDuration

All Implemented Interfaces:

Serializable, Comparable<FloatMoneyPerDuration>, MathFunctionsAbs<FloatMoneyPerDuration>, MathFunctionsRel<FloatMoneyPerDuration>, Relative, Value<MoneyPerDurationUnit>, FloatMathFunctions<FloatMoneyPerDuration>, FloatScalarInterface

public class FloatMoneyPerDuration
extends AbstractFloatScalarRel<MoneyPerDurationUnit,FloatMoneyPerDuration>

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

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

we can now write:

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

$LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatMoneyPerDuration(double value, MoneyPerDurationUnit unit) Construct FloatMoneyPerDuration scalar using a double value.
FloatMoneyPerDuration(FloatMoneyPerDuration value) Construct FloatMoneyPerDuration scalar.
FloatMoneyPerDuration(float value, MoneyPerDurationUnit unit) Construct FloatMoneyPerDuration scalar.

Method Summary

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

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

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

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

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

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

FloatMoneyPerDuration

public FloatMoneyPerDuration(float value,
                             MoneyPerDurationUnit unit)

Construct FloatMoneyPerDuration scalar.

Parameters:

value - float value

unit - unit for the float value

FloatMoneyPerDuration

public FloatMoneyPerDuration(FloatMoneyPerDuration value)

Construct FloatMoneyPerDuration scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMoneyPerDuration

public FloatMoneyPerDuration(double value,
                             MoneyPerDurationUnit unit)

Construct FloatMoneyPerDuration scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatMoneyPerDuration instantiateRel(float value,
                                                  MoneyPerDurationUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<MoneyPerDurationUnit,FloatMoneyPerDuration>

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatMoneyPerDuration interpolate(FloatMoneyPerDuration zero,
                                                FloatMoneyPerDuration 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 FloatMoneyPerDuration max(FloatMoneyPerDuration r1,
                                        FloatMoneyPerDuration 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 FloatMoneyPerDuration max(FloatMoneyPerDuration r1,
                                        FloatMoneyPerDuration r2,
                                        FloatMoneyPerDuration... 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 FloatMoneyPerDuration min(FloatMoneyPerDuration r1,
                                        FloatMoneyPerDuration 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 FloatMoneyPerDuration min(FloatMoneyPerDuration r1,
                                        FloatMoneyPerDuration r2,
                                        FloatMoneyPerDuration... 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(FloatMoneyPerDuration v)

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

Parameters:

v - FloatMoneyPerDuration scalar

Returns:

FloatDimensionless scalar as a division of FloatMoneyPerDuration and FloatMoneyPerDuration

multiplyBy

public final FloatMoney multiplyBy(FloatDuration v)

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

Parameters:

v - FloatMoneyPerDuration scalar

Returns:

FloatMoney scalar as a multiplication of FloatMoneyPerDuration and FloatDuration

divideBy

public final FloatMoney divideBy(FloatFrequency v)

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

Parameters:

v - FloatMoneyPerDuration scalar

Returns:

FloatMoney scalar as a division of FloatMoneyPerDuration and FloatFrequency