FloatMass (DJUNITS 3.00.08 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<MassUnit,FloatMass>
      - org.djunits.value.vfloat.scalar.FloatMass

All Implemented Interfaces:

Serializable, Comparable<FloatMass>, MathFunctionsAbs<FloatMass>, MathFunctionsRel<FloatMass>, Relative, Value<MassUnit>, FloatMathFunctions<FloatMass>, FloatScalarInterface
```
public class FloatMass
extends AbstractFloatScalarRel<MassUnit,FloatMass>
```
Easy access methods for the Mass FloatScalar, which is relative by definition. An example is Speed. Instead of:
```
 FloatScalar.Rel<MassUnit> value = new FloatScalar.Rel<MassUnit>(100.0, MassUnit.SI);
 
```
we can now write:
```
 FloatMass value = new FloatMass(100.0, MassUnit.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: 2019-01-18 00:35:01 +0100 (Fri, 18 Jan 2019) $, @version $Revision: 324 $, by $Author: averbraeck $, initial version Sep 5, 2015
Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static FloatMass`	`NaN` constant with value NaN.
`static FloatMass`	`NEG_MAXVALUE` constant with value -MAX_VALUE.
`static FloatMass`	`NEGATIVE_INFINITY` constant with value NEGATIVE_INFINITY.
`static FloatMass`	`POS_MAXVALUE` constant with value MAX_VALUE.
`static FloatMass`	`POSITIVE_INFINITY` constant with value POSITIVE_INFINITY.
`static FloatMass`	`ZERO` constant with value zero.

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

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
`FloatMass(double value, MassUnit unit)` Construct FloatMass scalar using a double value.
`FloatMass(FloatMass value)` Construct FloatMass scalar.
`FloatMass(float value, MassUnit unit)` Construct FloatMass scalar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FloatMass`	`createSI(float value)` Construct FloatMass scalar.
`FloatVolume`	`divideBy(FloatDensity v)` Calculate the division of FloatMass and FloatDensity, which results in a FloatVolume scalar.
`FloatFlowMass`	`divideBy(FloatDuration v)` Calculate the division of FloatMass and FloatDuration, which results in a FloatFlowMass scalar.
`FloatDuration`	`divideBy(FloatFlowMass v)` Calculate the division of FloatMass and FloatFlowMass, which results in a FloatDuration scalar.
`FloatDimensionless`	`divideBy(FloatMass v)` Calculate the division of FloatMass and FloatMass, which results in a FloatDimensionless scalar.
`FloatDensity`	`divideBy(FloatVolume v)` Calculate the division of FloatMass and FloatVolume, which results in a FloatDensity scalar.
`FloatMass`	`instantiateRel(float value, MassUnit unit)` Construct a new Relative Immutable FloatScalar of the right type.
`static FloatMass`	`interpolate(FloatMass zero, FloatMass one, float ratio)` Interpolate between two values.
`static FloatMass`	`max(FloatMass r1, FloatMass r2)` Return the maximum value of two relative scalars.
`static FloatMass`	`max(FloatMass r1, FloatMass r2, FloatMass... rn)` Return the maximum value of more than two relative scalars.
`static FloatMass`	`min(FloatMass r1, FloatMass r2)` Return the minimum value of two relative scalars.
`static FloatMass`	`min(FloatMass r1, FloatMass r2, FloatMass... rn)` Return the minimum value of more than two relative scalars.
`FloatForce`	`multiplyBy(FloatAcceleration v)` Calculate the multiplication of FloatMass and FloatAcceleration, which results in a FloatForce scalar.
`FloatFlowMass`	`multiplyBy(FloatFrequency v)` Calculate the multiplication of FloatMass and FloatFrequency, which results in a FloatFlowMass scalar.
`FloatMoney`	`multiplyBy(FloatMoneyPerMass v)` Calculate the multiplication of FloatMass and FloatMoneyPerMass, 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

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

- Field Detail
  - ZERO
```
public static final FloatMass ZERO
```
    constant with value zero.
  - NaN
```
public static final FloatMass NaN
```
    constant with value NaN.
  - POSITIVE_INFINITY
```
public static final FloatMass POSITIVE_INFINITY
```
    constant with value POSITIVE_INFINITY.
  - NEGATIVE_INFINITY
```
public static final FloatMass NEGATIVE_INFINITY
```
    constant with value NEGATIVE_INFINITY.
  - POS_MAXVALUE
```
public static final FloatMass POS_MAXVALUE
```
    constant with value MAX_VALUE.
  - NEG_MAXVALUE
```
public static final FloatMass NEG_MAXVALUE
```
    constant with value -MAX_VALUE.
- Constructor Detail
  - FloatMass
```
public FloatMass(float value,
                 MassUnit unit)
```
    Construct FloatMass scalar.
    
    Parameters:
    
    value - float; float value
    
    unit - MassUnit; unit for the float value
  - FloatMass
```
public FloatMass(FloatMass value)
```
    Construct FloatMass scalar.
    
    Parameters:
    
    value - FloatMass; Scalar from which to construct this instance
  - FloatMass
```
public FloatMass(double value,
                 MassUnit unit)
```
    Construct FloatMass scalar using a double value.
    
    Parameters:
    
    value - double; double value
    
    unit - MassUnit; unit for the resulting float value
- Method Detail
  - instantiateRel
```
public final FloatMass instantiateRel(float value,
                                      MassUnit unit)
```
    Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
    
    Specified by:
    
    instantiateRel in class AbstractFloatScalarRel<MassUnit,FloatMass>
    
    Parameters:
    
    value - float; the float value
    
    unit - U; the unit
    
    Returns:
    
    R a new relative instance of the FloatScalar of the right type
  - createSI
```
public static final FloatMass createSI(float value)
```
    Construct FloatMass scalar.
    
    Parameters:
    
    value - float; float value in SI units
    
    Returns:
    
    the new scalar with the SI value
  - interpolate
```
public static FloatMass interpolate(FloatMass zero,
                                    FloatMass one,
                                    float ratio)
```
    Interpolate between two values.
    
    Parameters:
    
    zero - FloatMass; the low value
    
    one - FloatMass; the high value
    
    ratio - float; the ratio between 0 and 1, inclusive
    
    Returns:
    
    a Scalar at the ratio between
  - max
```
public static FloatMass max(FloatMass r1,
                            FloatMass r2)
```
    Return the maximum value of two relative scalars.
    
    Parameters:
    
    r1 - FloatMass; the first scalar
    
    r2 - FloatMass; the second scalar
    
    Returns:
    
    the maximum value of two relative scalars
  - max
```
public static FloatMass max(FloatMass r1,
                            FloatMass r2,
                            FloatMass... rn)
```
    Return the maximum value of more than two relative scalars.
    
    Parameters:
    
    r1 - FloatMass; the first scalar
    
    r2 - FloatMass; the second scalar
    
    rn - FloatMass...; the other scalars
    
    Returns:
    
    the maximum value of more than two relative scalars
  - min
```
public static FloatMass min(FloatMass r1,
                            FloatMass r2)
```
    Return the minimum value of two relative scalars.
    
    Parameters:
    
    r1 - FloatMass; the first scalar
    
    r2 - FloatMass; the second scalar
    
    Returns:
    
    the minimum value of two relative scalars
  - min
```
public static FloatMass min(FloatMass r1,
                            FloatMass r2,
                            FloatMass... rn)
```
    Return the minimum value of more than two relative scalars.
    
    Parameters:
    
    r1 - FloatMass; the first scalar
    
    r2 - FloatMass; the second scalar
    
    rn - FloatMass...; the other scalars
    
    Returns:
    
    the minimum value of more than two relative scalars
  - divideBy
```
public final FloatDimensionless divideBy(FloatMass v)
```
    Calculate the division of FloatMass and FloatMass, which results in a FloatDimensionless scalar.
    
    Parameters:
    
    v - FloatMass; FloatMass scalar
    
    Returns:
    
    FloatDimensionless scalar as a division of FloatMass and FloatMass
  - divideBy
```
public final FloatDuration divideBy(FloatFlowMass v)
```
    Calculate the division of FloatMass and FloatFlowMass, which results in a FloatDuration scalar.
    
    Parameters:
    
    v - FloatFlowMass; FloatMass scalar
    
    Returns:
    
    FloatDuration scalar as a division of FloatMass and FloatFlowMass
  - divideBy
```
public final FloatFlowMass divideBy(FloatDuration v)
```
    Calculate the division of FloatMass and FloatDuration, which results in a FloatFlowMass scalar.
    
    Parameters:
    
    v - FloatDuration; FloatMass scalar
    
    Returns:
    
    FloatFlowMass scalar as a division of FloatMass and FloatDuration
  - multiplyBy
```
public final FloatForce multiplyBy(FloatAcceleration v)
```
    Calculate the multiplication of FloatMass and FloatAcceleration, which results in a FloatForce scalar.
    
    Parameters:
    
    v - FloatAcceleration; FloatMass scalar
    
    Returns:
    
    FloatForce scalar as a multiplication of FloatMass and FloatAcceleration
  - multiplyBy
```
public final FloatFlowMass multiplyBy(FloatFrequency v)
```
    Calculate the multiplication of FloatMass and FloatFrequency, which results in a FloatFlowMass scalar.
    
    Parameters:
    
    v - FloatFrequency; FloatMass scalar
    
    Returns:
    
    FloatFlowMass scalar as a multiplication of FloatMass and FloatFrequency
  - divideBy
```
public final FloatVolume divideBy(FloatDensity v)
```
    Calculate the division of FloatMass and FloatDensity, which results in a FloatVolume scalar.
    
    Parameters:
    
    v - FloatDensity; FloatMass scalar
    
    Returns:
    
    FloatVolume scalar as a division of FloatMass and FloatDensity
  - divideBy
```
public final FloatDensity divideBy(FloatVolume v)
```
    Calculate the division of FloatMass and FloatVolume, which results in a FloatDensity scalar.
    
    Parameters:
    
    v - FloatVolume; FloatMass scalar
    
    Returns:
    
    FloatDensity scalar as a division of FloatMass and FloatVolume
  - multiplyBy
```
public final FloatMoney multiplyBy(FloatMoneyPerMass v)
```
    Calculate the multiplication of FloatMass and FloatMoneyPerMass, which results in a FloatMoney scalar.
    
    Parameters:
    
    v - FloatMoneyPerMass; FloatMass scalar
    
    Returns:
    
    FloatMoney scalar as a multiplication of FloatMass and FloatMoneyPerMass

Class FloatMass

Field Summary

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

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

Field Detail

ZERO

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

POS_MAXVALUE

NEG_MAXVALUE

Constructor Detail

FloatMass

FloatMass

FloatMass

Method Detail

instantiateRel

createSI

interpolate

max

max

min

min

divideBy

divideBy

divideBy

multiplyBy

multiplyBy

divideBy

divideBy

multiplyBy