MutableDecimal2f (decimal4j API 1.0.7-SNAPSHOT)

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

All Implemented Interfaces:

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

Method Summary

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

Class MutableDecimal2f

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

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

MutableDecimal2f

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

multiplyExact

toImmutableDecimal

toMutableDecimal