MutableDecimal9f (decimal4j API 1.0.7-SNAPSHOT)

java.lang.Object
- java.lang.Number
- - org.decimal4j.base.AbstractDecimal<S,D>
  - - org.decimal4j.base.AbstractMutableDecimal<Scale9f,MutableDecimal9f>
    - - org.decimal4j.mutable.MutableDecimal9f

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Decimal<Scale9f>>, Decimal<Scale9f>, MutableDecimal<Scale9f>
```
public final class MutableDecimal9f
extends AbstractMutableDecimal<Scale9f,MutableDecimal9f>
implements Cloneable
```
MutableDecimal9f represents a mutable decimal number with a fixed number of 9 digits to the right of the decimal point.
All methods for this class throw NullPointerException when passed a null object reference for any input parameter.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`MutableDecimal9f()` Constructs a new `MutableDecimal9f` with value zero.
`MutableDecimal9f(BigDecimal value)` Constructs a `MutableDecimal9f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 9 using `HALF_UP` rounding.
`MutableDecimal9f(BigInteger value)` Constructs a `MutableDecimal9f` whose value is numerically equal to that of the specified `BigInteger` value.
`MutableDecimal9f(Decimal<?> value)` Constructs a `MutableDecimal9f` whose value is calculated by rounding the specified `Decimal` argument to scale 9 using `HALF_UP` rounding.
`MutableDecimal9f(Decimal9f value)` Constructs a `MutableDecimal9f` whose value is numerically equal to that of the specified `Decimal9f` value.
`MutableDecimal9f(double value)` Constructs a `MutableDecimal9f` whose value is calculated by rounding the specified `double` argument to scale 9 using `HALF_UP` rounding.
`MutableDecimal9f(long value)` Constructs a `MutableDecimal9f` whose value is numerically equal to that of the specified `long` value.
`MutableDecimal9f(String value)` Translates the string representation of a `Decimal` into a `MutableDecimal9f`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MutableDecimal9f`	`billion()` Returns a new `MutableDecimal9f` whose value is equal to one billion.
`static MutableDecimal9f`	`billionth()` Returns a new `MutableDecimal9f` whose value is equal to one billionth.
`MutableDecimal9f`	`clone()` Returns a clone of this mutable Decimal numerically identical to this value.
`protected MutableDecimal9f`	`create(long unscaled)` Returns a new `Decimal` whose value is `(unscaled × 10^-scale)`.
`protected MutableDecimal9f[]`	`createArray(int length)` Returns a new `Decimal` array of the specified `length`.
`static MutableDecimal9f`	`eight()` Returns a new `MutableDecimal9f` whose value is equal to eight.
`static MutableDecimal9f`	`five()` Returns a new `MutableDecimal9f` whose value is equal to five.
`static MutableDecimal9f`	`four()` Returns a new `MutableDecimal9f` whose value is equal to four.
`protected DecimalArithmetic`	`getDefaultArithmetic()` Returns the default arithmetic performing unchecked operations with rounding mode `HALF_UP`.
`protected DecimalArithmetic`	`getDefaultCheckedArithmetic()` Returns the default arithmetic performing checked operations with rounding mode `HALF_UP`.
`Factory9f`	`getFactory()` Returns the factory that can be used to create other Decimal values of the same scale as `this` Decimal.
`protected DecimalArithmetic`	`getRoundingDownArithmetic()` Returns the arithmetic performing unchecked operations with rounding mode `DOWN`.
`protected DecimalArithmetic`	`getRoundingFloorArithmetic()` Returns the arithmetic performing unchecked operations with rounding mode `FLOOR`.
`protected DecimalArithmetic`	`getRoundingHalfEvenArithmetic()` Returns the arithmetic performing unchecked operations with rounding mode `HALF_EVEN`.
`protected DecimalArithmetic`	`getRoundingUnnecessaryArithmetic()` Returns the arithmetic performing unchecked operations with rounding mode `UNNECESSARY`.
`int`	`getScale()` Returns the scale associated with this Decimal.
`Scale9f`	`getScaleMetrics()` Returns the metrics associated with the scale of this Decimal.
`static MutableDecimal9f`	`half()` Returns a new `MutableDecimal9f` whose value is equal to one half.
`static MutableDecimal9f`	`hundred()` Returns a new `MutableDecimal9f` whose value is equal to one hundred.
`static MutableDecimal9f`	`hundredth()` Returns a new `MutableDecimal9f` whose value is equal to one hundredth.
`static MutableDecimal9f`	`million()` Returns a new `MutableDecimal9f` whose value is equal to one million.
`static MutableDecimal9f`	`millionth()` Returns a new `MutableDecimal9f` whose value is equal to one millionth.
`static MutableDecimal9f`	`minusOne()` Returns a new `MutableDecimal9f` whose value is equal to minus one.
`Multipliable9f`	`multiplyExact()` Returns this `Decimal` as a multipliable factor for exact typed exact multiplication.
`static MutableDecimal9f`	`nine()` Returns a new `MutableDecimal9f` whose value is equal to nine.
`static MutableDecimal9f`	`one()` Returns a new `MutableDecimal9f` whose value is equal to one.
`protected MutableDecimal9f`	`self()` Returns `this` decimal value as concrete implementation subtype.
`static MutableDecimal9f`	`seven()` Returns a new `MutableDecimal9f` whose value is equal to seven.
`static MutableDecimal9f`	`six()` Returns a new `MutableDecimal9f` whose value is equal to six.
`static MutableDecimal9f`	`ten()` Returns a new `MutableDecimal9f` whose value is equal to ten.
`static MutableDecimal9f`	`tenth()` Returns a new `MutableDecimal9f` whose value is equal to one tenth.
`static MutableDecimal9f`	`thousand()` Returns a new `MutableDecimal9f` whose value is equal to one thousand.
`static MutableDecimal9f`	`thousandth()` Returns a new `MutableDecimal9f` whose value is equal to one thousandth.
`static MutableDecimal9f`	`three()` Returns a new `MutableDecimal9f` whose value is equal to three.
`Decimal9f`	`toImmutableDecimal()` If this `Decimal` value is already an `ImmutableDecimal` it is simply returned.
`MutableDecimal9f`	`toMutableDecimal()` If this `Decimal` value is already a `MutableDecimal` it is simply returned.
`static MutableDecimal9f`	`two()` Returns a new `MutableDecimal9f` whose value is equal to two.
`static MutableDecimal9f`	`ulp()` Returns a new `MutableDecimal9f` whose value is equal to one ULP.
`static MutableDecimal9f`	`unscaled(long unscaledValue)` Returns a new `MutableDecimal9f` whose value is equal to `unscaledValue * 10^-9`.
`static MutableDecimal9f`	`zero()` Returns a new `MutableDecimal9f` whose value is equal to zero.

Methods inherited from class org.decimal4j.base.AbstractMutableDecimal
createOrAssign, max, min, multiplyExact, scale, scale, scale, scale, set, set, set, set, set, set, set, set, set, set, set, set, setMinusOne, setOne, setUlp, setUnscaled, setUnscaled, setUnscaled, setZero, unscaledValue

Methods inherited from class org.decimal4j.base.AbstractDecimal
abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, byteValueExact, compareTo, compareToNumerically, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideToLongValue, divideToLongValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, doubleValue, doubleValue, equals, floatValue, floatValue, fractionalPart, getArithmeticFor, getArithmeticFor, getArithmeticFor, getCheckedArithmeticFor, hashCode, integralPart, intValue, intValueExact, invert, invert, invert, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, max, min, min, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, shortValueExact, signum, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toString

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.decimal4j.api.MutableDecimal
abs, abs, add, add, add, add, add, add, add, add, addSquared, addSquared, addSquared, addUnscaled, addUnscaled, addUnscaled, addUnscaled, addUnscaled, avg, avg, divide, divide, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideBy, divideBy, divideBy, divideByPowerOfTen, divideByPowerOfTen, divideByPowerOfTen, divideExact, divideToIntegralValue, divideToIntegralValue, divideTruncate, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, divideUnscaled, fractionalPart, integralPart, invert, invert, invert, multiply, multiply, multiply, multiply, multiply, multiply, multiply, multiplyBy, multiplyBy, multiplyBy, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyByPowerOfTen, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, multiplyUnscaled, negate, negate, pow, pow, pow, remainder, round, round, round, shiftLeft, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRight, sqrt, sqrt, square, square, square, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtract, subtractSquared, subtractSquared, subtractSquared, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled, subtractUnscaled

Methods inherited from interface org.decimal4j.api.Decimal
byteValue, byteValueExact, compareTo, compareToNumerically, divideToLongValue, divideToLongValue, doubleValue, doubleValue, equals, floatValue, floatValue, hashCode, intValue, intValueExact, isBetweenZeroAndMinusOne, isBetweenZeroAndOne, isEqualTo, isEqualToNumerically, isGreaterThan, isGreaterThanOrEqualTo, isIntegral, isIntegralPartZero, isLessThan, isLessThanOrEqualTo, isMinusOne, isNegative, isNonNegative, isNonPositive, isOne, isPositive, isUlp, isZero, longValue, longValue, longValueExact, max, min, shortValue, shortValueExact, signum, toBigDecimal, toBigDecimal, toBigInteger, toBigInteger, toBigIntegerExact, toString

- Constructor Detail
  - MutableDecimal9f
```
public MutableDecimal9f()
```
    Constructs a new MutableDecimal9f with value zero.
    
    See Also:
    
    zero()
  - MutableDecimal9f
```
public MutableDecimal9f(String value)
```
    Translates the string representation of a Decimal into a MutableDecimal9f. The string representation consists of an optional sign, '+' or '-' , followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction.
    The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. If the fraction contains more than 9 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - String value to convert into a MutableDecimal9f
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a MutableDecimal9f
    
    See Also:
    
    AbstractMutableDecimal.set(String, RoundingMode)
  - MutableDecimal9f
```
public MutableDecimal9f(long value)
```
    Constructs a MutableDecimal9f whose value is numerically equal to that of the specified long value. An exception is thrown if the specified value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - long value to convert into a MutableDecimal9f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal9f
  - MutableDecimal9f
```
public MutableDecimal9f(double value)
```
    Constructs a MutableDecimal9f whose value is calculated by rounding the specified double argument to scale 9 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - double value to convert into a MutableDecimal9f
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the double to be represented as a MutableDecimal9f
    
    See Also:
    
    AbstractMutableDecimal.set(double, RoundingMode), AbstractMutableDecimal.set(float), AbstractMutableDecimal.set(float, RoundingMode)
  - MutableDecimal9f
```
public MutableDecimal9f(BigInteger value)
```
    Constructs a MutableDecimal9f whose value is numerically equal to that of the specified BigInteger value. An exception is thrown if the specified value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - BigInteger value to convert into a MutableDecimal9f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal9f
  - MutableDecimal9f
```
public MutableDecimal9f(BigDecimal value)
```
    Constructs a MutableDecimal9f whose value is calculated by rounding the specified BigDecimal argument to scale 9 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - BigDecimal value to convert into a MutableDecimal9f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal9f
    
    See Also:
    
    AbstractMutableDecimal.set(BigDecimal, RoundingMode)
  - MutableDecimal9f
```
public MutableDecimal9f(Decimal9f value)
```
    Constructs a MutableDecimal9f whose value is numerically equal to that of the specified Decimal9f value.
    
    Parameters:
    
    value - Decimal9f value to convert into a MutableDecimal9f
  - MutableDecimal9f
```
public MutableDecimal9f(Decimal<?> value)
```
    Constructs a MutableDecimal9f whose value is calculated by rounding the specified Decimal argument to scale 9 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal9f.
    
    Parameters:
    
    value - Decimal value to convert into a MutableDecimal9f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal9f
    
    See Also:
    
    AbstractMutableDecimal.set(Decimal, RoundingMode)
- Method Detail
  - create
```
protected final MutableDecimal9f create(long unscaled)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal whose value is (unscaled × 10^-scale).
    
    Specified by:
    
    create in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Parameters:
    
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    
    unscaled × 10^-scale
  - createArray
```
protected final MutableDecimal9f[] createArray(int length)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal array of the specified length.
    
    Specified by:
    
    createArray in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Parameters:
    
    length - the length of the array to return
    
    Returns:
    
    new D[length]
  - self
```
protected final MutableDecimal9f self()
```
    Description copied from class: AbstractDecimal
    
    Returns this decimal value as concrete implementation subtype.
    
    Specified by:
    
    self in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    this
  - getScaleMetrics
```
public final Scale9f getScaleMetrics()
```
    Description copied from interface: Decimal
    
    Returns the metrics associated with the scale of this Decimal. Scale defines the number of fraction digits and the scale factor applied to the long value underlying this Decimal.
    
    Specified by:
    
    getScaleMetrics in interface Decimal<Scale9f>
    
    Returns:
    
    the scale metrics object
    
    See Also:
    
    ScaleMetrics.getScale(), ScaleMetrics.getScaleFactor()
  - getScale
```
public final int getScale()
```
    Description copied from interface: Decimal
    
    Returns the scale associated with this Decimal. The scale defines the number of fraction digits and the scale factor applied to the long value underlying this Decimal.
    If the scale is f then the value represented by a Decimal instance is (unscaledValue × 10^-f).
    This method is a shortcut for getScaleMetrics().getScale().
    
    Specified by:
    
    getScale in interface Decimal<Scale9f>
    
    Returns:
    
    the scale
    
    See Also:
    
    Decimal.getScaleMetrics(), ScaleMetrics.getScale(), Decimal.unscaledValue()
  - getFactory
```
public Factory9f getFactory()
```
    Description copied from interface: Decimal
    
    Returns the factory that can be used to create other Decimal values of the same scale as this Decimal.
    
    Specified by:
    
    getFactory in interface Decimal<Scale9f>
    
    Returns:
    
    the factory to create other Decimal values of the same scale as this Decimal
  - getDefaultArithmetic
```
protected DecimalArithmetic getDefaultArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the default arithmetic performing unchecked operations with rounding mode HALF_UP.
    
    Overrides:
    
    getDefaultArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    default arithmetic with HALF_UP rounding and UNCHECKED overflow mode
  - getDefaultCheckedArithmetic
```
protected DecimalArithmetic getDefaultCheckedArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the default arithmetic performing checked operations with rounding mode HALF_UP.
    
    Overrides:
    
    getDefaultCheckedArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    default arithmetic with HALF_UP rounding and CHECKED overflow mode
  - getRoundingDownArithmetic
```
protected DecimalArithmetic getRoundingDownArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode DOWN.
    
    Overrides:
    
    getRoundingDownArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    arithmetic with DOWN rounding and UNCHECKED overflow mode
  - getRoundingFloorArithmetic
```
protected DecimalArithmetic getRoundingFloorArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode FLOOR.
    
    Overrides:
    
    getRoundingFloorArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    arithmetic with FLOOR rounding and UNCHECKED overflow mode
  - getRoundingHalfEvenArithmetic
```
protected DecimalArithmetic getRoundingHalfEvenArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode HALF_EVEN.
    
    Overrides:
    
    getRoundingHalfEvenArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    arithmetic with HALF_UP rounding and UNCHECKED overflow mode
  - getRoundingUnnecessaryArithmetic
```
protected DecimalArithmetic getRoundingUnnecessaryArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode UNNECESSARY.
    
    Overrides:
    
    getRoundingUnnecessaryArithmetic in class AbstractDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    arithmetic with UNNECESSARY rounding and UNCHECKED overflow mode
  - clone
```
public MutableDecimal9f clone()
```
    Description copied from interface: MutableDecimal
    
    Returns a clone of this mutable Decimal numerically identical to this value.
    
    Specified by:
    
    clone in interface MutableDecimal<Scale9f>
    
    Specified by:
    
    clone in class AbstractMutableDecimal<Scale9f,MutableDecimal9f>
    
    Returns:
    
    a numerically identical clone of this value
  - unscaled
```
public static MutableDecimal9f unscaled(long unscaledValue)
```
    Returns a new MutableDecimal9f whose value is equal to unscaledValue * 10^-9.
    
    Parameters:
    
    unscaledValue - the unscaled decimal value to convert
    
    Returns:
    
    a new MutableDecimal9f value initialised with unscaledValue * 10^-9
    
    See Also:
    
    AbstractMutableDecimal.setUnscaled(long, int), AbstractMutableDecimal.setUnscaled(long, int, RoundingMode)
  - zero
```
public static MutableDecimal9f zero()
```
    Returns a new MutableDecimal9f whose value is equal to zero.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 0.
  - ulp
```
public static MutableDecimal9f ulp()
```
    Returns a new MutableDecimal9f whose value is equal to one ULP.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10^-9.
  - one
```
public static MutableDecimal9f one()
```
    Returns a new MutableDecimal9f whose value is equal to one.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 1.
  - two
```
public static MutableDecimal9f two()
```
    Returns a new MutableDecimal9f whose value is equal to two.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 2.
  - three
```
public static MutableDecimal9f three()
```
    Returns a new MutableDecimal9f whose value is equal to three.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 3.
  - four
```
public static MutableDecimal9f four()
```
    Returns a new MutableDecimal9f whose value is equal to four.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 4.
  - five
```
public static MutableDecimal9f five()
```
    Returns a new MutableDecimal9f whose value is equal to five.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 5.
  - six
```
public static MutableDecimal9f six()
```
    Returns a new MutableDecimal9f whose value is equal to six.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 6.
  - seven
```
public static MutableDecimal9f seven()
```
    Returns a new MutableDecimal9f whose value is equal to seven.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 7.
  - eight
```
public static MutableDecimal9f eight()
```
    Returns a new MutableDecimal9f whose value is equal to eight.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 8.
  - nine
```
public static MutableDecimal9f nine()
```
    Returns a new MutableDecimal9f whose value is equal to nine.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 9.
  - ten
```
public static MutableDecimal9f ten()
```
    Returns a new MutableDecimal9f whose value is equal to ten.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10.
  - hundred
```
public static MutableDecimal9f hundred()
```
    Returns a new MutableDecimal9f whose value is equal to one hundred.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 100.
  - thousand
```
public static MutableDecimal9f thousand()
```
    Returns a new MutableDecimal9f whose value is equal to one thousand.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 1000.
  - million
```
public static MutableDecimal9f million()
```
    Returns a new MutableDecimal9f whose value is equal to one million.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10⁶.
  - billion
```
public static MutableDecimal9f billion()
```
    Returns a new MutableDecimal9f whose value is equal to one billion.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10⁹.
  - minusOne
```
public static MutableDecimal9f minusOne()
```
    Returns a new MutableDecimal9f whose value is equal to minus one.
    
    Returns:
    
    a new MutableDecimal9f value initialised with -1.
  - half
```
public static MutableDecimal9f half()
```
    Returns a new MutableDecimal9f whose value is equal to one half.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 0.5.
  - tenth
```
public static MutableDecimal9f tenth()
```
    Returns a new MutableDecimal9f whose value is equal to one tenth.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 0.1.
  - hundredth
```
public static MutableDecimal9f hundredth()
```
    Returns a new MutableDecimal9f whose value is equal to one hundredth.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 0.01.
  - thousandth
```
public static MutableDecimal9f thousandth()
```
    Returns a new MutableDecimal9f whose value is equal to one thousandth.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 0.001.
  - millionth
```
public static MutableDecimal9f millionth()
```
    Returns a new MutableDecimal9f whose value is equal to one millionth.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10^-6.
  - billionth
```
public static MutableDecimal9f billionth()
```
    Returns a new MutableDecimal9f whose value is equal to one billionth.
    
    Returns:
    
    a new MutableDecimal9f value initialised with 10^-9.
  - multiplyExact
```
public Multipliable9f multiplyExact()
```
    Returns this Decimal as a multipliable factor for exact typed exact multiplication. The second factor is passed to one of the by(..) methods of the returned multiplier. The scale of the result is the sum of the scales of this Decimal and the second factor passed to the by(..) method.
    The method is similar to multiplyExact(Decimal) but the result is retrieved in exact typed form with the correct result scale.
    For instance one can write:
```
 Decimal11f product = this.multiplyExact().by(Decimal2f.FIVE);
 
```
    Returns:
    
    a multipliable object encapsulating this Decimal as first factor of an exact multiplication
  - toImmutableDecimal
```
public Decimal9f toImmutableDecimal()
```
    Description copied from interface: Decimal
    
    If this Decimal value is already an ImmutableDecimal it is simply returned. Otherwise a new immutable value with the same scale and numerical value as this Decimal is created and returned.
    
    Specified by:
    
    toImmutableDecimal in interface Decimal<Scale9f>
    
    Returns:
    
    this if immutable and a new ImmutableDecimal with the same scale and value as this Decimal otherwise
  - toMutableDecimal
```
public MutableDecimal9f toMutableDecimal()
```
    Description copied from interface: Decimal
    
    If this Decimal value is already a MutableDecimal it is simply returned. Otherwise a new mutable value with the same scale and numerical value as this Decimal is created and returned.
    
    Specified by:
    
    toMutableDecimal in interface Decimal<Scale9f>
    
    Returns:
    
    this if mutable and a new MutableDecimal with the same scale and value as this Decimal otherwise

Class MutableDecimal9f

Constructor Summary

Method Summary

Methods inherited from class org.decimal4j.base.AbstractMutableDecimal

Methods inherited from class org.decimal4j.base.AbstractDecimal

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.decimal4j.api.MutableDecimal

Methods inherited from interface org.decimal4j.api.Decimal

Constructor Detail

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

MutableDecimal9f

Method Detail

create

createArray

self

getScaleMetrics

getScale

getFactory

getDefaultArithmetic

getDefaultCheckedArithmetic

getRoundingDownArithmetic

getRoundingFloorArithmetic

getRoundingHalfEvenArithmetic

getRoundingUnnecessaryArithmetic

clone

unscaled

zero

ulp

one

two

three

four

five

six

seven

eight

nine

ten

hundred

thousand

million

billion

minusOne

half

tenth

hundredth

thousandth

millionth

billionth

multiplyExact

toImmutableDecimal

toMutableDecimal