Money (DJUNITS 3.01.02 API)

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

All Implemented Interfaces:

Serializable, Comparable<Money>, MathFunctionsAbs<Money>, MathFunctionsRel<Money>, Relative, Value<MoneyUnit>, DoubleMathFunctions<Money>, DoubleScalarInterface
```
public class Money
extends AbstractDoubleScalarRel<MoneyUnit,Money>
```
Easy access methods for the Money DoubleScalar, which is relative by definition. Instead of:
```
 DoubleScalar.Rel<MoneyUnit> value = new DoubleScalar.Rel<MoneyUnit>(100.0, MoneyUnit.SI);
 
```
we can now write:
```
 Money value = new Money(100.0, MoneyUnit.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-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-10-16 02:04:00 +0200 (Fri, 16 Oct 2015) $, @version $Revision: 113 $, 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 class org.djunits.value.Scalar
  NUMBER_PATTERN
- 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

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

Money(Money value)
Construct Money scalar.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MoneyPerArea`	`divideBy(Area v)` Calculate the division of Money and Area, which results in a MoneyPerArea scalar.
`MoneyPerDuration`	`divideBy(Duration v)` Calculate the division of Money and Duration, which results in a MoneyPerDuration scalar.
`MoneyPerEnergy`	`divideBy(Energy v)` Calculate the division of Money and Energy, which results in a MoneyPerEnergy scalar.
`MoneyPerLength`	`divideBy(Length 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`	`divideBy(Money v)` Calculate the division of Money and Money, which results in a Dimensionless scalar.
`MoneyPerVolume`	`divideBy(Volume v)` Calculate the division of Money and Volume, which results in a MoneyPerVolume scalar.
`Money`	`instantiateRel(double value, MoneyUnit unit)` Construct a new Relative Immutable DoubleScalar of the right type.
`static Money`	`interpolate(Money zero, Money one, double ratio)` Interpolate between two values.
`static Money`	`max(Money r1, Money r2)` Return the maximum value of two monetary scalars.
`static Money`	`max(Money r1, Money r2, Money... rn)` Return the maximum value of more than two monetary scalars.
`static Money`	`min(Money r1, Money r2)` Return the minimum value of two monetary scalars.
`static Money`	`min(Money r1, Money r2, Money... rn)` Return the minimum value of more than two monetary scalars.
`MoneyPerDuration`	`multiplyBy(Frequency v)` Calculate the multiplication of Money and Frequency, which results in a MoneyPerDuration scalar.
`MoneyPerLength`	`multiplyBy(LinearDensity v)` Calculate the multiplication of Money and LinearDensity, which results in a MoneyPerLength 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, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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
  - Money
```
public Money(double value,
             MoneyUnit unit)
```
    Construct Money scalar.
    
    Parameters:
    
    value - double value
    
    unit - unit for the double value
  - Money
```
public Money(Money value)
```
    Construct Money scalar.
    
    Parameters:
    
    value - Scalar from which to construct this instance
- Method Detail
  - instantiateRel
```
public final Money instantiateRel(double value,
                                  MoneyUnit unit)
```
    Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
    
    Specified by:
    
    instantiateRel in class AbstractDoubleScalarRel<MoneyUnit,Money>
    
    Parameters:
    
    value - double; the double value
    
    unit - U; the unit
    
    Returns:
    
    R a new relative instance of the DoubleScalar of the right type
  - 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
  - max
```
public static Money max(Money r1,
                        Money 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 Money max(Money r1,
                        Money r2,
                        Money... 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 Money min(Money r1,
                        Money 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 Money min(Money r1,
                        Money r2,
                        Money... 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(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 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 MoneyPerDuration divideBy(Duration v)
```
    Calculate the division of Money and Duration, which results in a MoneyPerDuration scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerDuration scalar as a division of Money and Duration
  - multiplyBy
```
public final MoneyPerDuration multiplyBy(Frequency v)
```
    Calculate the multiplication of Money and Frequency, which results in a MoneyPerDuration scalar.
    
    Parameters:
    
    v - Money scalar
    
    Returns:
    
    MoneyPerDuration 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

Field Summary

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

Fields inherited from class org.djunits.value.Scalar

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

Constructor Summary

Method Summary

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

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

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

Constructor Detail

Money

Money

Method Detail

instantiateRel

interpolate

max

max

min

min

divideBy

divideBy

divideBy

divideBy

multiplyBy

divideBy

divideBy

multiplyBy

divideBy