org.djunits.value.vfloat.scalar

Class FloatMoneyPerVolume

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<MoneyPerVolumeUnit,FloatMoneyPerVolume>

org.djunits.value.vfloat.scalar.FloatMoneyPerVolume

All Implemented Interfaces:

Serializable, Comparable<FloatMoneyPerVolume>, MathFunctionsAbs<FloatMoneyPerVolume>, MathFunctionsRel<FloatMoneyPerVolume>, Relative, Value<MoneyPerVolumeUnit>, FloatMathFunctions<FloatMoneyPerVolume>, FloatScalarInterface

public class FloatMoneyPerVolume
extends AbstractFloatScalarRel<MoneyPerVolumeUnit,FloatMoneyPerVolume>

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

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

we can now write:

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

$LastChangedDate: 2015-10-16 02:04:00 +0200 (Fri, 16 Oct 2015) $, @version $Revision: 113 $, 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 class org.djunits.value.Scalar

NUMBER_PATTERN

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

Method Summary

Modifier and Type	Method and Description
FloatDimensionless	divideBy(FloatMoneyPerVolume v) Calculate the division of FloatMoneyPerVolume and FloatMoneyPerVolume, which results in a FloatDimensionless scalar.
FloatMoneyPerVolume	instantiateRel(float value, MoneyPerVolumeUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatMoneyPerVolume	interpolate(FloatMoneyPerVolume zero, FloatMoneyPerVolume one, float ratio) Interpolate between two values.
static FloatMoneyPerVolume	max(FloatMoneyPerVolume r1, FloatMoneyPerVolume r2) Return the maximum value of two monetary scalars.
static FloatMoneyPerVolume	max(FloatMoneyPerVolume r1, FloatMoneyPerVolume r2, FloatMoneyPerVolume... rn) Return the maximum value of more than two monetary scalars.
static FloatMoneyPerVolume	min(FloatMoneyPerVolume r1, FloatMoneyPerVolume r2) Return the minimum value of two monetary scalars.
static FloatMoneyPerVolume	min(FloatMoneyPerVolume r1, FloatMoneyPerVolume r2, FloatMoneyPerVolume... rn) Return the minimum value of more than two monetary scalars.
FloatMoney	multiplyBy(FloatVolume v) Calculate the multiplication of FloatMoneyPerVolume and FloatVolume, 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, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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

FloatMoneyPerVolume

public FloatMoneyPerVolume(float value,
                           MoneyPerVolumeUnit unit)

Construct FloatMoneyPerVolume scalar.

Parameters:

value - float value

unit - unit for the float value

FloatMoneyPerVolume

public FloatMoneyPerVolume(FloatMoneyPerVolume value)

Construct FloatMoneyPerVolume scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMoneyPerVolume

public FloatMoneyPerVolume(double value,
                           MoneyPerVolumeUnit unit)

Construct FloatMoneyPerVolume scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatMoneyPerVolume instantiateRel(float value,
                                                MoneyPerVolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<MoneyPerVolumeUnit,FloatMoneyPerVolume>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

interpolate

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

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

Parameters:

v - FloatMoneyPerVolume scalar

Returns:

FloatDimensionless scalar as a division of FloatMoneyPerVolume and FloatMoneyPerVolume

multiplyBy

public final FloatMoney multiplyBy(FloatVolume v)

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

Parameters:

v - FloatMoneyPerVolume scalar

Returns:

FloatMoney scalar as a multiplication of FloatMoneyPerVolume and FloatVolume