org.djunits.value.vdouble.scalar

Class MoneyPerLength

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<U>

org.djunits.value.vdouble.scalar.TypedDoubleScalarRel<MoneyPerLengthUnit,MoneyPerLength>

org.djunits.value.vdouble.scalar.MoneyPerLength

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel<MoneyPerLengthUnit>>, MathFunctionsAbs<DoubleScalar.Rel<MoneyPerLengthUnit>>, MathFunctionsRel<DoubleScalar.Rel<MoneyPerLengthUnit>>, Relative, Value<MoneyPerLengthUnit>, DoubleMathFunctions<DoubleScalar<MoneyPerLengthUnit>>

public class MoneyPerLength
extends TypedDoubleScalarRel<MoneyPerLengthUnit,MoneyPerLength>

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

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

we can now write:

 MoneyPerLength value = new MoneyPerLength(100.0, MoneyPerLengthUnit.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.vdouble.scalar.DoubleScalar

DoubleScalar.Abs<U extends Unit<U>>, DoubleScalar.Rel<U extends Unit<U>>

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

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

Constructor Summary

Constructors

Constructor and Description
MoneyPerLength(double value, MoneyPerLengthUnit unit) Construct MoneyPerLength scalar.
MoneyPerLength(MoneyPerLength value) Construct MoneyPerLength scalar.

Method Summary

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

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

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

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

compareTo, eq, ge, getSI, gt, le, lt, minus, ne, plus

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

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

DIV, MULT, POW

Constructor Detail

MoneyPerLength

public MoneyPerLength(double value,
                      MoneyPerLengthUnit unit)

Construct MoneyPerLength scalar.

Parameters:

value - double value

unit - unit for the double value

MoneyPerLength

public MoneyPerLength(MoneyPerLength value)

Construct MoneyPerLength scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeRel

protected final MoneyPerLength instantiateTypeRel(double value,
                                                  MoneyPerLengthUnit unit)

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

Specified by:

instantiateTypeRel in class TypedDoubleScalarRel<MoneyPerLengthUnit,MoneyPerLength>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

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

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

Parameters:

v - MoneyPerLength scalar

Returns:

Dimensionless scalar as a division of MoneyPerLength and MoneyPerLength

multiplyBy

public final Money multiplyBy(Length v)

Calculate the multiplication of MoneyPerLength and Length, which results in a Money scalar.

Parameters:

v - MoneyPerLength scalar

Returns:

Money scalar as a multiplication of MoneyPerLength and Length

divideBy

public final Money divideBy(LinearDensity v)

Calculate the division of MoneyPerLength and LinearDensity, which results in a Money scalar.

Parameters:

v - MoneyPerLength scalar

Returns:

Money scalar as a division of MoneyPerLength and LinearDensity