org.djunits.value.vfloat.scalar

Class FloatMoney

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<MoneyUnit,FloatMoney>

org.djunits.value.vfloat.scalar.FloatMoney

All Implemented Interfaces:

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

public class FloatMoney
extends TypedFloatScalarRel<MoneyUnit,FloatMoney>

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

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

we can now write:

 FloatMoney value = new FloatMoney(100.0, MoneyUnit.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
FloatMoney(double value, MoneyUnit unit) Construct FloatMoney scalar using a double value.
FloatMoney(FloatMoney value) Construct FloatMoney scalar.
FloatMoney(float value, MoneyUnit unit) Construct FloatMoney scalar.

Method Summary

Modifier and Type	Method and Description
FloatMoneyPerArea	divideBy(FloatArea v) Calculate the division of FloatMoney and FloatArea, which results in a FloatMoneyPerArea scalar.
FloatMoneyPerTime	divideBy(FloatDuration v) Calculate the division of FloatMoney and FloatDuration, which results in a FloatMoneyPerTime scalar.
FloatMoneyPerEnergy	divideBy(FloatEnergy v) Calculate the division of FloatMoney and FloatEnergy, which results in a FloatMoneyPerEnergy scalar.
FloatMoneyPerLength	divideBy(FloatLength v) Calculate the division of FloatMoney and FloatLength, which results in a FloatMoneyPerLength scalar.
FloatMoneyPerMass	divideBy(FloatMass v) Calculate the division of FloatMoney and FloatMass, which results in a FloatMoneyPerMass scalar.
FloatDimensionless	divideBy(FloatMoney v) Calculate the division of FloatMoney and FloatMoney, which results in a FloatDimensionless scalar.
FloatMoneyPerVolume	divideBy(FloatVolume v) Calculate the division of FloatMoney and FloatVolume, which results in a FloatMoneyPerVolume scalar.
protected FloatMoney	instantiateTypeRel(float value, MoneyUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatMoney	interpolate(FloatMoney zero, FloatMoney one, float ratio) Interpolate between two values.
static FloatMoney	max(FloatMoney r1, FloatMoney r2) Return the maximum value of two monetary scalars.
static FloatMoney	max(FloatMoney r1, FloatMoney r2, FloatMoney... rn) Return the maximum value of more than two monetary scalars.
static FloatMoney	min(FloatMoney r1, FloatMoney r2) Return the minimum value of two monetary scalars.
static FloatMoney	min(FloatMoney r1, FloatMoney r2, FloatMoney... rn) Return the minimum value of more than two monetary scalars.
FloatMoneyPerTime	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatMoney and FloatFrequency, which results in a FloatMoneyPerTime scalar.
FloatMoneyPerLength	multiplyBy(FloatLinearDensity v) Calculate the multiplication of FloatMoney and FloatLinearDensity, which results in a FloatMoneyPerLength 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

FloatMoney

public FloatMoney(float value,
                  MoneyUnit unit)

Construct FloatMoney scalar.

Parameters:

value - float value

unit - unit for the float value

FloatMoney

public FloatMoney(FloatMoney value)

Construct FloatMoney scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMoney

public FloatMoney(double value,
                  MoneyUnit unit)

Construct FloatMoney scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateTypeRel

protected final FloatMoney instantiateTypeRel(float value,
                                              MoneyUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatScalarRel<MoneyUnit,FloatMoney>

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

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

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

Parameters:

v - FloatMoney scalar

Returns:

FloatDimensionless scalar as a division of FloatMoney and FloatMoney

divideBy

public final FloatMoneyPerArea divideBy(FloatArea v)

Calculate the division of FloatMoney and FloatArea, which results in a FloatMoneyPerArea scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerArea scalar as a division of FloatMoney and FloatArea

divideBy

public final FloatMoneyPerEnergy divideBy(FloatEnergy v)

Calculate the division of FloatMoney and FloatEnergy, which results in a FloatMoneyPerEnergy scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerEnergy scalar as a division of FloatMoney and FloatEnergy

divideBy

public final FloatMoneyPerLength divideBy(FloatLength v)

Calculate the division of FloatMoney and FloatLength, which results in a FloatMoneyPerLength scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerLength scalar as a division of FloatMoney and FloatLength

multiplyBy

public final FloatMoneyPerLength multiplyBy(FloatLinearDensity v)

Calculate the multiplication of FloatMoney and FloatLinearDensity, which results in a FloatMoneyPerLength scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerLength scalar as a multiplication of FloatMoney and FloatLinearDensity

divideBy

public final FloatMoneyPerMass divideBy(FloatMass v)

Calculate the division of FloatMoney and FloatMass, which results in a FloatMoneyPerMass scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerMass scalar as a division of FloatMoney and FloatMass

divideBy

public final FloatMoneyPerTime divideBy(FloatDuration v)

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

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerTime scalar as a division of FloatMoney and FloatDuration

multiplyBy

public final FloatMoneyPerTime multiplyBy(FloatFrequency v)

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

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerTime scalar as a multiplication of FloatMoney and FloatFrequency

divideBy

public final FloatMoneyPerVolume divideBy(FloatVolume v)

Calculate the division of FloatMoney and FloatVolume, which results in a FloatMoneyPerVolume scalar.

Parameters:

v - FloatMoney scalar

Returns:

FloatMoneyPerVolume scalar as a division of FloatMoney and FloatVolume