org.djunits.value.vdouble.scalar

Class MoneyPerMass

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<MoneyPerMassUnit,MoneyPerMass>

org.djunits.value.vdouble.scalar.MoneyPerMass

All Implemented Interfaces:

Serializable, Comparable<MoneyPerMass>, MathFunctionsAbs<MoneyPerMass>, MathFunctionsRel<MoneyPerMass>, Relative, Value<MoneyPerMassUnit>, DoubleMathFunctions<MoneyPerMass>, DoubleScalarInterface

public class MoneyPerMass
extends AbstractDoubleScalarRel<MoneyPerMassUnit,MoneyPerMass>

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

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

we can now write:

 MoneyPerMass value = new MoneyPerMass(100.0, MoneyPerMassUnit.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
MoneyPerMass(double value, MoneyPerMassUnit unit) Construct MoneyPerMass scalar.
MoneyPerMass(MoneyPerMass value) Construct MoneyPerMass scalar.

Method Summary

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

MoneyPerMass

public MoneyPerMass(double value,
                    MoneyPerMassUnit unit)

Construct MoneyPerMass scalar.

Parameters:

value - double value

unit - unit for the double value

MoneyPerMass

public MoneyPerMass(MoneyPerMass value)

Construct MoneyPerMass scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final MoneyPerMass instantiateRel(double value,
                                         MoneyPerMassUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<MoneyPerMassUnit,MoneyPerMass>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

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

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

Parameters:

v - MoneyPerMass scalar

Returns:

Dimensionless scalar as a division of MoneyPerMass and MoneyPerMass

multiplyBy

public final Money multiplyBy(Mass v)

Calculate the multiplication of MoneyPerMass and Mass, which results in a Money scalar.

Parameters:

v - MoneyPerMass scalar

Returns:

Money scalar as a multiplication of MoneyPerMass and Mass