FloatMoneyPerLength (DJUNITS 3.01.02 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>
    - - org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<MoneyPerLengthUnit,FloatMoneyPerLength>
      - org.djunits.value.vfloat.scalar.FloatMoneyPerLength

All Implemented Interfaces:

Serializable, Comparable<FloatMoneyPerLength>, MathFunctionsAbs<FloatMoneyPerLength>, MathFunctionsRel<FloatMoneyPerLength>, Relative, Value<MoneyPerLengthUnit>, FloatMathFunctions<FloatMoneyPerLength>, FloatScalarInterface
```
public class FloatMoneyPerLength
extends AbstractFloatScalarRel<MoneyPerLengthUnit,FloatMoneyPerLength>
```
Easy access methods for the MoneyPerLength FloatScalar, which is relative by definition. An example is Speed. Instead of:
```
 FloatScalar.Rel<MoneyPerLengthUnit> value = new FloatScalar.Rel<MoneyPerLengthUnit>(100.0, MoneyPerLengthUnit.SI);
 
```
we can now write:
```
 FloatMoneyPerLength value = new FloatMoneyPerLength(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-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.vfloat.scalar.AbstractFloatScalar
  si
- Fields inherited from class org.djunits.value.Scalar
  NUMBER_PATTERN
- Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions
  ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors
Constructor and Description
`FloatMoneyPerLength(double value, MoneyPerLengthUnit unit)` Construct FloatMoneyPerLength scalar using a double value.
`FloatMoneyPerLength(FloatMoneyPerLength value)` Construct FloatMoneyPerLength scalar.
`FloatMoneyPerLength(float value, MoneyPerLengthUnit unit)` Construct FloatMoneyPerLength scalar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FloatMoney`	`divideBy(FloatLinearDensity v)` Calculate the division of FloatMoneyPerLength and FloatLinearDensity, which results in a FloatMoney scalar.
`FloatDimensionless`	`divideBy(FloatMoneyPerLength v)` Calculate the division of FloatMoneyPerLength and FloatMoneyPerLength, which results in a FloatDimensionless scalar.
`FloatMoneyPerLength`	`instantiateRel(float value, MoneyPerLengthUnit unit)` Construct a new Relative Immutable FloatScalar of the right type.
`static FloatMoneyPerLength`	`interpolate(FloatMoneyPerLength zero, FloatMoneyPerLength one, float ratio)` Interpolate between two values.
`static FloatMoneyPerLength`	`max(FloatMoneyPerLength r1, FloatMoneyPerLength r2)` Return the maximum value of two monetary scalars.
`static FloatMoneyPerLength`	`max(FloatMoneyPerLength r1, FloatMoneyPerLength r2, FloatMoneyPerLength... rn)` Return the maximum value of more than two monetary scalars.
`static FloatMoneyPerLength`	`min(FloatMoneyPerLength r1, FloatMoneyPerLength r2)` Return the minimum value of two monetary scalars.
`static FloatMoneyPerLength`	`min(FloatMoneyPerLength r1, FloatMoneyPerLength r2, FloatMoneyPerLength... rn)` Return the minimum value of more than two monetary scalars.
`FloatMoney`	`multiplyBy(FloatLength v)` Calculate the multiplication of FloatMoneyPerLength and FloatLength, which results in a FloatMoney scalar.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel
abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar
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.vfloat.FloatMathFunctions
DIV, MULT, POW

- Constructor Detail
  - FloatMoneyPerLength
```
public FloatMoneyPerLength(float value,
                           MoneyPerLengthUnit unit)
```
    Construct FloatMoneyPerLength scalar.
    
    Parameters:
    
    value - float value
    
    unit - unit for the float value
  - FloatMoneyPerLength
```
public FloatMoneyPerLength(FloatMoneyPerLength value)
```
    Construct FloatMoneyPerLength scalar.
    
    Parameters:
    
    value - Scalar from which to construct this instance
  - FloatMoneyPerLength
```
public FloatMoneyPerLength(double value,
                           MoneyPerLengthUnit unit)
```
    Construct FloatMoneyPerLength scalar using a double value.
    
    Parameters:
    
    value - double value
    
    unit - unit for the resulting float value
- Method Detail
  - instantiateRel
```
public final FloatMoneyPerLength instantiateRel(float value,
                                                MoneyPerLengthUnit unit)
```
    Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
    
    Specified by:
    
    instantiateRel in class AbstractFloatScalarRel<MoneyPerLengthUnit,FloatMoneyPerLength>
    
    Parameters:
    
    value - float; the float value
    
    unit - U; the unit
    
    Returns:
    
    R a new relative instance of the FloatScalar of the right type
  - interpolate
```
public static FloatMoneyPerLength interpolate(FloatMoneyPerLength zero,
                                              FloatMoneyPerLength one,
                                              float 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 FloatMoneyPerLength max(FloatMoneyPerLength r1,
                                      FloatMoneyPerLength 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 FloatMoneyPerLength max(FloatMoneyPerLength r1,
                                      FloatMoneyPerLength r2,
                                      FloatMoneyPerLength... 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 FloatMoneyPerLength min(FloatMoneyPerLength r1,
                                      FloatMoneyPerLength 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 FloatMoneyPerLength min(FloatMoneyPerLength r1,
                                      FloatMoneyPerLength r2,
                                      FloatMoneyPerLength... 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 FloatDimensionless divideBy(FloatMoneyPerLength v)
```
    Calculate the division of FloatMoneyPerLength and FloatMoneyPerLength, which results in a FloatDimensionless scalar.
    
    Parameters:
    
    v - FloatMoneyPerLength scalar
    
    Returns:
    
    FloatDimensionless scalar as a division of FloatMoneyPerLength and FloatMoneyPerLength
  - multiplyBy
```
public final FloatMoney multiplyBy(FloatLength v)
```
    Calculate the multiplication of FloatMoneyPerLength and FloatLength, which results in a FloatMoney scalar.
    
    Parameters:
    
    v - FloatMoneyPerLength scalar
    
    Returns:
    
    FloatMoney scalar as a multiplication of FloatMoneyPerLength and FloatLength
  - divideBy
```
public final FloatMoney divideBy(FloatLinearDensity v)
```
    Calculate the division of FloatMoneyPerLength and FloatLinearDensity, which results in a FloatMoney scalar.
    
    Parameters:
    
    v - FloatMoneyPerLength scalar
    
    Returns:
    
    FloatMoney scalar as a division of FloatMoneyPerLength and FloatLinearDensity

Class FloatMoneyPerLength

Field Summary

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

Fields inherited from class org.djunits.value.Scalar

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarRel

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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.vfloat.FloatMathFunctions

Constructor Detail

FloatMoneyPerLength

FloatMoneyPerLength

FloatMoneyPerLength

Method Detail

instantiateRel

interpolate

max

max

min

min

divideBy

multiplyBy

divideBy