MutableDecimal3f (decimal4j API 1.0.3)

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Decimal<Scale3f>>, Decimal<Scale3f>, MutableDecimal<Scale3f>
```
public final class MutableDecimal3f
extends AbstractMutableDecimal<Scale3f,MutableDecimal3f>
implements Cloneable
```
MutableDecimal3f represents a mutable decimal number with a fixed number of 3 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
`MutableDecimal3f()` Constructs a new `MutableDecimal3f` with value zero.
`MutableDecimal3f(BigDecimal value)` Constructs a `MutableDecimal3f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 3 using `HALF_UP` rounding.
`MutableDecimal3f(BigInteger value)` Constructs a `MutableDecimal3f` whose value is numerically equal to that of the specified `BigInteger` value.
`MutableDecimal3f(Decimal<?> value)` Constructs a `MutableDecimal3f` whose value is calculated by rounding the specified `Decimal` argument to scale 3 using `HALF_UP` rounding.
`MutableDecimal3f(Decimal3f value)` Constructs a `MutableDecimal3f` whose value is numerically equal to that of the specified `Decimal3f` value.
`MutableDecimal3f(double value)` Constructs a `MutableDecimal3f` whose value is calculated by rounding the specified `double` argument to scale 3 using `HALF_UP` rounding.
`MutableDecimal3f(long value)` Constructs a `MutableDecimal3f` whose value is numerically equal to that of the specified `long` value.
`MutableDecimal3f(String value)` Translates the string representation of a `Decimal` into a `MutableDecimal3f`.

Method Summary

Methods
Modifier and Type	Method and Description
`static MutableDecimal3f`	`billion()` Returns a new `MutableDecimal3f` whose value is equal to one billion.
`MutableDecimal3f`	`clone()` Returns a clone of this mutable Decimal numerically identical to this value.
`protected MutableDecimal3f`	`create(long unscaled)` Returns a new `Decimal` whose value is `(unscaled × 10^-scale)`.
`protected MutableDecimal3f[]`	`createArray(int length)` Returns a new `Decimal` array of the specified `length`.
`static MutableDecimal3f`	`eight()` Returns a new `MutableDecimal3f` whose value is equal to eight.
`static MutableDecimal3f`	`five()` Returns a new `MutableDecimal3f` whose value is equal to five.
`static MutableDecimal3f`	`four()` Returns a new `MutableDecimal3f` 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`.
`Factory3f`	`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.
`Scale3f`	`getScaleMetrics()` Returns the metrics associated with the scale of this Decimal.
`static MutableDecimal3f`	`half()` Returns a new `MutableDecimal3f` whose value is equal to one half.
`static MutableDecimal3f`	`hundred()` Returns a new `MutableDecimal3f` whose value is equal to one hundred.
`static MutableDecimal3f`	`hundredth()` Returns a new `MutableDecimal3f` whose value is equal to one hundredth.
`static MutableDecimal3f`	`million()` Returns a new `MutableDecimal3f` whose value is equal to one million.
`static MutableDecimal3f`	`minusOne()` Returns a new `MutableDecimal3f` whose value is equal to minus one.
`Multipliable3f`	`multiplyExact()` Returns this `Decimal` as a multipliable factor for exact typed exact multiplication.
`static MutableDecimal3f`	`nine()` Returns a new `MutableDecimal3f` whose value is equal to nine.
`static MutableDecimal3f`	`one()` Returns a new `MutableDecimal3f` whose value is equal to one.
`static MutableDecimal3f`	`quadrillion()` Returns a new `MutableDecimal3f` whose value is equal to one quadrillion.
`protected MutableDecimal3f`	`self()` Returns `this` decimal value as concrete implementation subtype.
`static MutableDecimal3f`	`seven()` Returns a new `MutableDecimal3f` whose value is equal to seven.
`static MutableDecimal3f`	`six()` Returns a new `MutableDecimal3f` whose value is equal to six.
`static MutableDecimal3f`	`ten()` Returns a new `MutableDecimal3f` whose value is equal to ten.
`static MutableDecimal3f`	`tenth()` Returns a new `MutableDecimal3f` whose value is equal to one tenth.
`static MutableDecimal3f`	`thousand()` Returns a new `MutableDecimal3f` whose value is equal to one thousand.
`static MutableDecimal3f`	`thousandth()` Returns a new `MutableDecimal3f` whose value is equal to one thousandth.
`static MutableDecimal3f`	`three()` Returns a new `MutableDecimal3f` whose value is equal to three.
`Decimal3f`	`toImmutableDecimal()` If this `Decimal` value is already an `ImmutableDecimal` it is simply returned.
`MutableDecimal3f`	`toMutableDecimal()` If this `Decimal` value is already a `MutableDecimal` it is simply returned.
`static MutableDecimal3f`	`trillion()` Returns a new `MutableDecimal3f` whose value is equal to one trillion.
`static MutableDecimal3f`	`two()` Returns a new `MutableDecimal3f` whose value is equal to two.
`static MutableDecimal3f`	`ulp()` Returns a new `MutableDecimal3f` whose value is equal to one ULP.
`static MutableDecimal3f`	`unscaled(long unscaledValue)` Returns a new `MutableDecimal3f` whose value is equal to `unscaledValue * 10^-3`.
`static MutableDecimal3f`	`zero()` Returns a new `MutableDecimal3f` 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
  - MutableDecimal3f
```
public MutableDecimal3f()
```
    Constructs a new MutableDecimal3f with value zero.
    
    See Also:
    zero()
  - MutableDecimal3f
```
public MutableDecimal3f(String value)
```
    Translates the string representation of a Decimal into a MutableDecimal3f. 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 3 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a MutableDecimal3f.
    
    Parameters:
    value - String value to convert into a MutableDecimal3f
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a MutableDecimal3f
    See Also:
    AbstractMutableDecimal.set(String, RoundingMode)
  - MutableDecimal3f
```
public MutableDecimal3f(long value)
```
    Constructs a MutableDecimal3f 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 MutableDecimal3f.
    
    Parameters:
    value - long value to convert into a MutableDecimal3f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal3f
  - MutableDecimal3f
```
public MutableDecimal3f(double value)
```
    Constructs a MutableDecimal3f whose value is calculated by rounding the specified double argument to scale 3 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal3f.
    
    Parameters:
    value - double value to convert into a MutableDecimal3f
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the double to be represented as a MutableDecimal3f
    See Also:
    AbstractMutableDecimal.set(double, RoundingMode), AbstractMutableDecimal.set(float), AbstractMutableDecimal.set(float, RoundingMode)
  - MutableDecimal3f
```
public MutableDecimal3f(BigInteger value)
```
    Constructs a MutableDecimal3f 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 MutableDecimal3f.
    
    Parameters:
    value - BigInteger value to convert into a MutableDecimal3f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal3f
  - MutableDecimal3f
```
public MutableDecimal3f(BigDecimal value)
```
    Constructs a MutableDecimal3f whose value is calculated by rounding the specified BigDecimal argument to scale 3 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal3f.
    
    Parameters:
    value - BigDecimal value to convert into a MutableDecimal3f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal3f
    See Also:
    AbstractMutableDecimal.set(BigDecimal, RoundingMode)
  - MutableDecimal3f
```
public MutableDecimal3f(Decimal3f value)
```
    Constructs a MutableDecimal3f whose value is numerically equal to that of the specified Decimal3f value.
    
    Parameters:
    value - Decimal3f value to convert into a MutableDecimal3f
  - MutableDecimal3f
```
public MutableDecimal3f(Decimal<?> value)
```
    Constructs a MutableDecimal3f whose value is calculated by rounding the specified Decimal argument to scale 3 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a MutableDecimal3f.
    
    Parameters:
    value - Decimal value to convert into a MutableDecimal3f
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a MutableDecimal3f
    See Also:
    AbstractMutableDecimal.set(Decimal, RoundingMode)
- Method Detail
  - create
```
protected final MutableDecimal3f create(long unscaled)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal whose value is (unscaled × 10^-scale).
    
    Specified by:
    
    create in class AbstractDecimal<Scale3f,MutableDecimal3f>
    
    Parameters:
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    unscaled × 10^-scale
  - createArray
```
protected final MutableDecimal3f[] createArray(int length)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal array of the specified length.
    
    Specified by:
    
    createArray in class AbstractDecimal<Scale3f,MutableDecimal3f>
    
    Parameters:
    length - the length of the array to return
    
    Returns:
    new D[length]
  - self
```
protected final MutableDecimal3f self()
```
    Description copied from class: AbstractDecimal
    
    Returns this decimal value as concrete implementation subtype.
    
    Specified by:
    
    self in class AbstractDecimal<Scale3f,MutableDecimal3f>
    
    Returns:
    this
  - getScaleMetrics
```
public final Scale3f 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<Scale3f>
    
    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<Scale3f>
    
    Returns:
    the scale
    See Also:
    Decimal.getScaleMetrics(), ScaleMetrics.getScale(), Decimal.unscaledValue()
  - getFactory
```
public Factory3f 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<Scale3f>
    
    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<Scale3f,MutableDecimal3f>
    
    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<Scale3f,MutableDecimal3f>
    
    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<Scale3f,MutableDecimal3f>
    
    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<Scale3f,MutableDecimal3f>
    
    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<Scale3f,MutableDecimal3f>
    
    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<Scale3f,MutableDecimal3f>
    
    Returns:
    arithmetic with UNNECESSARY rounding and UNCHECKED overflow mode
  - clone
```
public MutableDecimal3f clone()
```
    Description copied from interface: MutableDecimal
    
    Returns a clone of this mutable Decimal numerically identical to this value.
    
    Specified by:
    
    clone in interface MutableDecimal<Scale3f>
    
    Specified by:
    
    clone in class AbstractMutableDecimal<Scale3f,MutableDecimal3f>
    
    Returns:
    a numerically identical clone of this value
  - unscaled
```
public static MutableDecimal3f unscaled(long unscaledValue)
```
    Returns a new MutableDecimal3f whose value is equal to unscaledValue * 10^-3.
    
    Parameters:
    unscaledValue - the unscaled decimal value to convert
    
    Returns:
    a new MutableDecimal3f value initialised with unscaledValue * 10^-3
    See Also:
    AbstractMutableDecimal.setUnscaled(long, int), AbstractMutableDecimal.setUnscaled(long, int, RoundingMode)
  - zero
```
public static MutableDecimal3f zero()
```
    Returns a new MutableDecimal3f whose value is equal to zero.
    
    Returns:
    a new MutableDecimal3f value initialised with 0.
  - ulp
```
public static MutableDecimal3f ulp()
```
    Returns a new MutableDecimal3f whose value is equal to one ULP.
    
    Returns:
    a new MutableDecimal3f value initialised with 10^-3.
  - one
```
public static MutableDecimal3f one()
```
    Returns a new MutableDecimal3f whose value is equal to one.
    
    Returns:
    a new MutableDecimal3f value initialised with 1.
  - two
```
public static MutableDecimal3f two()
```
    Returns a new MutableDecimal3f whose value is equal to two.
    
    Returns:
    a new MutableDecimal3f value initialised with 2.
  - three
```
public static MutableDecimal3f three()
```
    Returns a new MutableDecimal3f whose value is equal to three.
    
    Returns:
    a new MutableDecimal3f value initialised with 3.
  - four
```
public static MutableDecimal3f four()
```
    Returns a new MutableDecimal3f whose value is equal to four.
    
    Returns:
    a new MutableDecimal3f value initialised with 4.
  - five
```
public static MutableDecimal3f five()
```
    Returns a new MutableDecimal3f whose value is equal to five.
    
    Returns:
    a new MutableDecimal3f value initialised with 5.
  - six
```
public static MutableDecimal3f six()
```
    Returns a new MutableDecimal3f whose value is equal to six.
    
    Returns:
    a new MutableDecimal3f value initialised with 6.
  - seven
```
public static MutableDecimal3f seven()
```
    Returns a new MutableDecimal3f whose value is equal to seven.
    
    Returns:
    a new MutableDecimal3f value initialised with 7.
  - eight
```
public static MutableDecimal3f eight()
```
    Returns a new MutableDecimal3f whose value is equal to eight.
    
    Returns:
    a new MutableDecimal3f value initialised with 8.
  - nine
```
public static MutableDecimal3f nine()
```
    Returns a new MutableDecimal3f whose value is equal to nine.
    
    Returns:
    a new MutableDecimal3f value initialised with 9.
  - ten
```
public static MutableDecimal3f ten()
```
    Returns a new MutableDecimal3f whose value is equal to ten.
    
    Returns:
    a new MutableDecimal3f value initialised with 10.
  - hundred
```
public static MutableDecimal3f hundred()
```
    Returns a new MutableDecimal3f whose value is equal to one hundred.
    
    Returns:
    a new MutableDecimal3f value initialised with 100.
  - thousand
```
public static MutableDecimal3f thousand()
```
    Returns a new MutableDecimal3f whose value is equal to one thousand.
    
    Returns:
    a new MutableDecimal3f value initialised with 1000.
  - million
```
public static MutableDecimal3f million()
```
    Returns a new MutableDecimal3f whose value is equal to one million.
    
    Returns:
    a new MutableDecimal3f value initialised with 10⁶.
  - billion
```
public static MutableDecimal3f billion()
```
    Returns a new MutableDecimal3f whose value is equal to one billion.
    
    Returns:
    a new MutableDecimal3f value initialised with 10⁹.
  - trillion
```
public static MutableDecimal3f trillion()
```
    Returns a new MutableDecimal3f whose value is equal to one trillion.
    
    Returns:
    a new MutableDecimal3f value initialised with 10¹².
  - quadrillion
```
public static MutableDecimal3f quadrillion()
```
    Returns a new MutableDecimal3f whose value is equal to one quadrillion.
    
    Returns:
    a new MutableDecimal3f value initialised with 10¹⁵.
  - minusOne
```
public static MutableDecimal3f minusOne()
```
    Returns a new MutableDecimal3f whose value is equal to minus one.
    
    Returns:
    a new MutableDecimal3f value initialised with -1.
  - half
```
public static MutableDecimal3f half()
```
    Returns a new MutableDecimal3f whose value is equal to one half.
    
    Returns:
    a new MutableDecimal3f value initialised with 0.5.
  - tenth
```
public static MutableDecimal3f tenth()
```
    Returns a new MutableDecimal3f whose value is equal to one tenth.
    
    Returns:
    a new MutableDecimal3f value initialised with 0.1.
  - hundredth
```
public static MutableDecimal3f hundredth()
```
    Returns a new MutableDecimal3f whose value is equal to one hundredth.
    
    Returns:
    a new MutableDecimal3f value initialised with 0.01.
  - thousandth
```
public static MutableDecimal3f thousandth()
```
    Returns a new MutableDecimal3f whose value is equal to one thousandth.
    
    Returns:
    a new MutableDecimal3f value initialised with 0.001.
  - multiplyExact
```
public Multipliable3f 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:
```
 Decimal5f product = this.multiplyExact().by(Decimal2f.FIVE);
 
```
    Returns:
    a multipliable object encapsulating this Decimal as first factor of an exact multiplication
  - toImmutableDecimal
```
public Decimal3f 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<Scale3f>
    
    Returns:
    this if immutable and a new ImmutableDecimal with the same scale and value as this Decimal otherwise
  - toMutableDecimal
```
public MutableDecimal3f 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<Scale3f>
    
    Returns:
    this if mutable and a new MutableDecimal with the same scale and value as this Decimal otherwise

Class MutableDecimal3f

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

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

MutableDecimal3f

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

trillion

quadrillion

minusOne

half

tenth

hundredth

thousandth

multiplyExact

toImmutableDecimal

toMutableDecimal