org.djunits.value.vdouble.scalar

Class MoneyPerEnergy

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<MoneyPerEnergyUnit,MoneyPerEnergy>

org.djunits.value.vdouble.scalar.MoneyPerEnergy

All Implemented Interfaces:

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

public class MoneyPerEnergy
extends TypedDoubleScalarRel<MoneyPerEnergyUnit,MoneyPerEnergy>

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

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

we can now write:

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

Method Summary

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

MoneyPerEnergy

public MoneyPerEnergy(double value,
                      MoneyPerEnergyUnit unit)

Construct MoneyPerEnergy scalar.

Parameters:

value - double value

unit - unit for the double value

MoneyPerEnergy

public MoneyPerEnergy(MoneyPerEnergy value)

Construct MoneyPerEnergy scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeRel

protected final MoneyPerEnergy instantiateTypeRel(double value,
                                                  MoneyPerEnergyUnit unit)

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

Specified by:

instantiateTypeRel in class TypedDoubleScalarRel<MoneyPerEnergyUnit,MoneyPerEnergy>

Parameters:

value - the double value

unit - the unit

Returns:

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

interpolate

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

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

Parameters:

v - MoneyPerEnergy scalar

Returns:

Dimensionless scalar as a division of MoneyPerEnergy and MoneyPerEnergy

multiplyBy

public final Money multiplyBy(Energy v)

Calculate the multiplication of MoneyPerEnergy and Energy, which results in a Money scalar.

Parameters:

v - MoneyPerEnergy scalar

Returns:

Money scalar as a multiplication of MoneyPerEnergy and Energy