Money (DJUNITS 1.02.01 API)

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<MoneyUnit>
      - org.djunits.value.vdouble.scalar.Money

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel<MoneyUnit>>, MathFunctions<DoubleScalar<MoneyUnit>>, Relative, Value<MoneyUnit>, DoubleMathFunctions<DoubleScalar<MoneyUnit>>
```
public class Money
extends DoubleScalar.Rel<MoneyUnit>
implements Relative
```
Easy access methods for the Money DoubleScalar, which is relative by definition. An example is Money. Instead of
DoubleScalar.Rel<MoneyUnit> price = new DoubleScalar.Rel<MoneyUnit>(100.0, MoneyUnit.EUR);
we can now write
Money price = new Money(100.0, MoneyUnit.EUR);
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-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-10-07 11:49:36 +0200 (Wed, 07 Oct 2015) $, @version $Revision: 92 $, 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

Constructor Summary

Constructors
Constructor and Description

Money(double value, MoneyUnit unit)
Construct Money scalar.

Money(DoubleScalar.Rel<MoneyUnit> value)
Construct Money scalar.

Constructors
Constructor and Description
`Money(double value, MoneyUnit unit)` Construct Money scalar.
`Money(DoubleScalar.Rel<MoneyUnit> value)` Construct Money scalar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Money`	`abs()` Set the value(s) to their absolute value.
`Money`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`Money`	`asin()` Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`Money`	`atan()` Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`Money`	`cbrt()` Set the value(s) to the(ir) cube root.
`Money`	`ceil()` Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
`Money`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`Money`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`MoneyPerArea`	`divideBy(Area v)` Calculate the division of Money and Area, which results in a MoneyPerArea scalar.
`Money`	`divideBy(double divisor)` Scale the value(s) by the inverse of a factor; i.e.
`MoneyPerEnergy`	`divideBy(Energy v)` Calculate the division of Money and Energy, which results in a MoneyPerEnergy scalar.
`MoneyPerLength`	`divideBy(Length.Rel v)` Calculate the division of Money and Length, which results in a MoneyPerLength scalar.
`MoneyPerMass`	`divideBy(Mass v)` Calculate the division of Money and Mass, which results in a MoneyPerMass scalar.
`Dimensionless.Rel`	`divideBy(Money v)` Calculate the division of Money and Money, which results in a Dimensionless scalar.
`MoneyPerTime`	`divideBy(Time.Rel v)` Calculate the division of Money and Time, which results in a MoneyPerTime scalar.
`MoneyPerVolume`	`divideBy(Volume v)` Calculate the division of Money and Volume, which results in a MoneyPerVolume scalar.
`Money`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`Money`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`Money`	`floor()` Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
`static Money`	`interpolate(Money zero, Money one, double ratio)` Interpolate between two values.
`Money`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`Money`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`Money`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`Money`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`Money`	`minus(Money v)` Relative scalar minus Relative scalar = Relative scalar.
`Money`	`multiplyBy(double factor)` Scale the value(s) by a factor.
`MoneyPerTime`	`multiplyBy(Frequency v)` Calculate the multiplication of Money and Frequency, which results in a MoneyPerTime scalar.
`MoneyPerLength`	`multiplyBy(LinearDensity v)` Calculate the multiplication of Money and LinearDensity, which results in a MoneyPerLength scalar.
`Money`	`plus(Money v)` Relative scalar plus Relative scalar = Relative scalar.
`Money`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`Money`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`Money`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`Money`	`signum()` Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
`Money`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`Money`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`Money`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`Money`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`Money`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`Money`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`Money`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

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

- Constructor Detail
  - Money
```
public Money(double value,
             MoneyUnit unit)
```
    Construct Money scalar.
    
    Parameters:
    
    value - double value
    
    unit - unit for the double value
  - Money
```
public Money(DoubleScalar.Rel<MoneyUnit> value)
```
    Construct Money scalar.
    
    Parameters:
    
    value - Scalar from which to construct this instance
- Method Detail
  - interpolate
```
public static Money interpolate(Money zero,
                                Money 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
  - abs
```
public final Money abs()
```
    Set the value(s) to their absolute value.
    
    Specified by:
    
    abs in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    abs in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - acos
```
public final Money acos()
```
    Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
    
    Specified by:
    
    acos in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    acos in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - asin
```
public final Money asin()
```
    Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
    
    Specified by:
    
    asin in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    asin in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - atan
```
public final Money atan()
```
    Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
    
    Specified by:
    
    atan in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    atan in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - cbrt
```
public final Money cbrt()
```
    Set the value(s) to the(ir) cube root.
    
    Specified by:
    
    cbrt in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    cbrt in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - ceil
```
public final Money ceil()
```
    Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
    
    Specified by:
    
    ceil in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    ceil in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - cos
```
public final Money cos()
```
    Set the value(s) to the trigonometric cosine of the value(s).
    
    Specified by:
    
    cos in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    cos in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - cosh
```
public final Money cosh()
```
    Set the value(s) to the hyperbolic cosine of the value(s).
    
    Specified by:
    
    cosh in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    cosh in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - exp
```
public final Money exp()
```
    Set the value(s) to Euler's number e raised to the power of the value(s).
    
    Specified by:
    
    exp in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    exp in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - expm1
```
public final Money expm1()
```
    Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
    
    Specified by:
    
    expm1 in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    expm1 in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - floor
```
public final Money floor()
```
    Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
    
    Specified by:
    
    floor in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    floor in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - log
```
public final Money log()
```
    Set the value(s) to the natural logarithm (base e) of the value(s).
    
    Specified by:
    
    log in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    log in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - log10
```
public final Money log10()
```
    Set the value(s) to the base 10 logarithm of the value(s).
    
    Specified by:
    
    log10 in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    log10 in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - log1p
```
public final Money log1p()
```
    Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
    
    Specified by:
    
    log1p in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    log1p in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - rint
```
public final Money rint()
```
    Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
    
    Specified by:
    
    rint in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    rint in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - round
```
public final Money round()
```
    Set the value(s) to the closest long to the argument with ties rounding up.
    
    Specified by:
    
    round in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    round in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - signum
```
public final Money signum()
```
    Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
    
    Specified by:
    
    signum in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    signum in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - sin
```
public final Money sin()
```
    Set the value(s) to the trigonometric sine of the value(s).
    
    Specified by:
    
    sin in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    sin in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - sinh
```
public final Money sinh()
```
    Set the value(s) to the hyperbolic sine of the value(s).
    
    Specified by:
    
    sinh in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    sinh in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - sqrt
```
public final Money sqrt()
```
    Set the value(s) to the correctly rounded positive square root of the value(s).
    
    Specified by:
    
    sqrt in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    sqrt in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - tan
```
public final Money tan()
```
    Set the value(s) to the trigonometric tangent of the value(s).
    
    Specified by:
    
    tan in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    tan in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - tanh
```
public final Money tanh()
```
    Set the value(s) to the hyperbolic tangent of the value(s).
    
    Specified by:
    
    tanh in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    tanh in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - inv
```
public final Money inv()
```
    Set the value(s) to the complement (1.0/x) of the value(s).
    
    Specified by:
    
    inv in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    inv in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - toDegrees
```
public final Money toDegrees()
```
    Set the value(s) to approximately equivalent angle(s) measured in degrees.
    
    Specified by:
    
    toDegrees in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    toDegrees in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - toRadians
```
public final Money toRadians()
```
    Set the value(s) to approximately equivalent angle(s) measured in radians.
    
    Specified by:
    
    toRadians in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    toRadians in class DoubleScalar.Rel<MoneyUnit>
    
    Returns:
    
    T; the modified T
  - pow
```
public final Money pow(double x)
```
    Set the value(s) to the value(s) raised to the power of the argument.
    
    Specified by:
    
    pow in interface MathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    pow in class DoubleScalar.Rel<MoneyUnit>
    
    Parameters:
    
    x - double; the value to use as the power
    
    Returns:
    
    T; the modified T
  - multiplyBy
```
public final Money multiplyBy(double factor)
```
    Scale the value(s) by a factor.
    
    Specified by:
    
    multiplyBy in interface DoubleMathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    multiplyBy in class DoubleScalar.Rel<MoneyUnit>
    
    Parameters:
    
    factor - double; the multiplier
    
    Returns:
    
    T; the modified T
  - divideBy
```
public final Money divideBy(double divisor)
```
    Scale the value(s) by the inverse of a factor; i.e. a divisor.
    
    Specified by:
    
    divideBy in interface DoubleMathFunctions<DoubleScalar<MoneyUnit>>
    
    Overrides:
    
    divideBy in class DoubleScalar.Rel<MoneyUnit>
    
    Parameters:
    
    divisor - double; the divisor
    
    Returns:
    
    T; the modified T
  - plus
```
public final Money plus(Money v)
```
    Relative scalar plus Relative scalar = Relative scalar.
    
    Parameters:
    
    v - the value to add
    
    Returns:
    
    sum of this value and v as a new object
  - minus
```
public final Money minus(Money v)
```
    Relative scalar minus Relative scalar = Relative scalar.
    
    Parameters:
    
    v - the value to subtract
    
    Returns:
    
    difference of this value and v as a new object
  - divideBy
```
public final Dimensionless.Rel divideBy(Money v)
```
    Calculate the division of Money and Money, which results in a Dimensionless scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    Dimensionless scalar as a division of Money and Money
  - divideBy
```
public final MoneyPerArea divideBy(Area v)
```
    Calculate the division of Money and Area, which results in a MoneyPerArea scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerArea scalar as a division of Money and Area
  - divideBy
```
public final MoneyPerEnergy divideBy(Energy v)
```
    Calculate the division of Money and Energy, which results in a MoneyPerEnergy scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerEnergy scalar as a division of Money and Energy
  - divideBy
```
public final MoneyPerLength divideBy(Length.Rel v)
```
    Calculate the division of Money and Length, which results in a MoneyPerLength scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerLength scalar as a division of Money and Length
  - multiplyBy
```
public final MoneyPerLength multiplyBy(LinearDensity v)
```
    Calculate the multiplication of Money and LinearDensity, which results in a MoneyPerLength scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerLength scalar as a multiplication of Money and LinearDensity
  - divideBy
```
public final MoneyPerMass divideBy(Mass v)
```
    Calculate the division of Money and Mass, which results in a MoneyPerMass scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerMass scalar as a division of Money and Mass
  - divideBy
```
public final MoneyPerTime divideBy(Time.Rel v)
```
    Calculate the division of Money and Time, which results in a MoneyPerTime scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerTime scalar as a division of Money and Time
  - multiplyBy
```
public final MoneyPerTime multiplyBy(Frequency v)
```
    Calculate the multiplication of Money and Frequency, which results in a MoneyPerTime scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerTime scalar as a multiplication of Money and Frequency
  - divideBy
```
public final MoneyPerVolume divideBy(Volume v)
```
    Calculate the division of Money and Volume, which results in a MoneyPerVolume scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerVolume scalar as a division of Money and Volume

Class Money

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

Money

Money

Method Detail

interpolate

abs

acos

asin

atan

cbrt

ceil

cos

cosh

exp

expm1

floor

log

log10

log1p

rint

round

signum

sin

sinh

sqrt

tan

tanh

inv

toDegrees

toRadians

pow

multiplyBy

divideBy

plus

minus

divideBy

divideBy

divideBy

divideBy

multiplyBy

divideBy

divideBy

multiplyBy

divideBy