org.djunits.value.vdouble.scalar

Class MoneyPerVolume

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<MoneyPerVolumeUnit,MoneyPerVolume>

org.djunits.value.vdouble.scalar.MoneyPerVolume

All Implemented Interfaces:

Serializable, Comparable<MoneyPerVolume>, MathFunctionsAbs<MoneyPerVolume>, MathFunctionsRel<MoneyPerVolume>, Relative, Value<MoneyPerVolumeUnit>, DoubleMathFunctions<MoneyPerVolume>, DoubleScalarInterface

public class MoneyPerVolume
extends AbstractDoubleScalarRel<MoneyPerVolumeUnit,MoneyPerVolume>

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

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

we can now write:

 MoneyPerVolume value = new MoneyPerVolume(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-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.vdouble.scalar.AbstractDoubleScalar

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

Constructor Summary

Constructors

Constructor and Description
MoneyPerVolume(double value, MoneyPerVolumeUnit unit) Construct MoneyPerVolume scalar.
MoneyPerVolume(MoneyPerVolume value) Construct MoneyPerVolume scalar.

Method Summary

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

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

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

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

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

DIV, MULT, POW

Constructor Detail

MoneyPerVolume

public MoneyPerVolume(double value,
                      MoneyPerVolumeUnit unit)

Construct MoneyPerVolume scalar.

Parameters:

value - double value

unit - unit for the double value

MoneyPerVolume

public MoneyPerVolume(MoneyPerVolume value)

Construct MoneyPerVolume scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final MoneyPerVolume instantiateRel(double value,
                                           MoneyPerVolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<MoneyPerVolumeUnit,MoneyPerVolume>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

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

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

Parameters:

v - MoneyPerVolume scalar

Returns:

Dimensionless scalar as a division of MoneyPerVolume and MoneyPerVolume

multiplyBy

public final Money multiplyBy(Volume v)

Calculate the multiplication of MoneyPerVolume and Volume, which results in a Money scalar.

Parameters:

v - MoneyPerVolume scalar

Returns:

Money scalar as a multiplication of MoneyPerVolume and Volume