Decimal13f (decimal4j API 1.0.7-SNAPSHOT)

java.lang.Object
- java.lang.Number
- - org.decimal4j.base.AbstractDecimal<S,D>
  - - org.decimal4j.base.AbstractImmutableDecimal<Scale13f,Decimal13f>
    - - org.decimal4j.immutable.Decimal13f

All Implemented Interfaces:

Serializable, Comparable<Decimal<Scale13f>>, Decimal<Scale13f>, ImmutableDecimal<Scale13f>
```
public final class Decimal13f
extends AbstractImmutableDecimal<Scale13f,Decimal13f>
```
Decimal13f represents an immutable decimal number with a fixed number of 13 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

Field Summary

Fields
Modifier and Type	Field and Description
`static Decimal13f`	`BILLIONTH` The `Decimal13f` constant 10^-9.
`static DecimalArithmetic`	`DEFAULT_ARITHMETIC` Default arithmetic for `Decimal13f` performing unchecked operations with rounding mode `HALF_UP`.
`static DecimalArithmetic`	`DEFAULT_CHECKED_ARITHMETIC` Default arithmetic for `Decimal13f` performing checked operations with rounding mode `HALF_UP`.
`static Decimal13f`	`EIGHT` The `Decimal13f` constant 8.
`static Factory13f`	`FACTORY` Factory constant for `Decimal13f` returned by `getFactory()`.
`static Decimal13f`	`FIVE` The `Decimal13f` constant 5.
`static Decimal13f`	`FOUR` The `Decimal13f` constant 4.
`static Decimal13f`	`HALF` The `Decimal13f` constant 0.5.
`static Decimal13f`	`HUNDRED` The `Decimal13f` constant 100.
`static Decimal13f`	`HUNDREDTH` The `Decimal13f` constant 0.01.
`static Decimal13f`	`MAX_INTEGER_VALUE` A constant holding the maximum integer value a `Decimal13f` can have, 922337.0000000000000.
`static Decimal13f`	`MAX_VALUE` A constant holding the maximum value a `Decimal13f` can have, 922337.2036854775807.
`static Scale13f`	`METRICS` Scale metrics constant for `Decimal13f` returned by `getScaleMetrics()`.
`static Decimal13f`	`MILLIONTH` The `Decimal13f` constant 10^-6.
`static Decimal13f`	`MIN_INTEGER_VALUE` A constant holding the minimum integer value a `Decimal13f` can have, -922337.0000000000000.
`static Decimal13f`	`MIN_VALUE` A constant holding the minimum value a `Decimal13f` can have, -922337.2036854775808.
`static Decimal13f`	`MINUS_ONE` The `Decimal13f` constant -1.
`static Decimal13f`	`NINE` The `Decimal13f` constant 9.
`static Decimal13f`	`ONE` The `Decimal13f` constant 1.
`static long`	`ONE_UNSCALED` The unscaled long value that represents one.
`static int`	`SCALE` Scale value 13 for `Decimal13f` returned by `getScale()`.
`static Decimal13f`	`SEVEN` The `Decimal13f` constant 7.
`static Decimal13f`	`SIX` The `Decimal13f` constant 6.
`static Decimal13f`	`TEN` The `Decimal13f` constant 10.
`static Decimal13f`	`TENTH` The `Decimal13f` constant 0.1.
`static Decimal13f`	`THOUSAND` The `Decimal13f` constant 1000.
`static Decimal13f`	`THOUSANDTH` The `Decimal13f` constant 0.001.
`static Decimal13f`	`THREE` The `Decimal13f` constant 3.
`static Decimal13f`	`TRILLIONTH` The `Decimal13f` constant 10^-12.
`static Decimal13f`	`TWO` The `Decimal13f` constant 2.
`static Decimal13f`	`ULP` A constant holding the smallest positive value a `Decimal13f` can have, 10^-13.
`static Decimal13f`	`ZERO` The `Decimal13f` constant zero.

Constructor Summary

Constructors
Constructor and Description

Decimal13f(String value)
Translates the string representation of a Decimal into a Decimal13f.

Constructors
Constructor and Description
`Decimal13f(String value)` Translates the string representation of a `Decimal` into a `Decimal13f`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Decimal13f`	`create(long unscaled)` Returns a new `Decimal` whose value is `(unscaled × 10^-scale)`.
`protected Decimal13f[]`	`createArray(int length)` Returns a new `Decimal` array of the specified `length`.
`protected Decimal13f`	`createOrAssign(long unscaled)` Returns this or a new `Decimal` whose value is `(unscaled × 10^-scale)`.
`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`.
`Factory13f`	`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.
`Scale13f`	`getScaleMetrics()` Returns the metrics associated with the scale of this Decimal.
`Multipliable13f`	`multiplyExact()` Returns this `Decimal` as a multipliable factor for typed exact multiplication.
`protected Decimal13f`	`self()` Returns `this` decimal value as concrete implementation subtype.
`Decimal13f`	`toImmutableDecimal()` If this `Decimal` value is already an `ImmutableDecimal` it is simply returned.
`MutableDecimal13f`	`toMutableDecimal()` If this `Decimal` value is already a `MutableDecimal` it is simply returned.
`static Decimal13f`	`valueOf(BigDecimal value)` Returns a `Decimal13f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 13 using `HALF_UP` rounding.
`static Decimal13f`	`valueOf(BigDecimal value, RoundingMode roundingMode)` Returns a `Decimal13f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 13 using the specified `roundingMode`.
`static Decimal13f`	`valueOf(BigInteger value)` Returns a `Decimal13f` whose value is numerically equal to that of the specified `BigInteger` value.
`static Decimal13f`	`valueOf(Decimal<?> value)` Returns a `Decimal13f` whose value is calculated by rounding the specified `Decimal` argument to scale 13 using `HALF_UP` rounding.
`static Decimal13f`	`valueOf(Decimal<?> value, RoundingMode roundingMode)` Returns a `Decimal13f` whose value is calculated by rounding the specified `Decimal` argument to scale 13 using the specified `roundingMode`.
`static Decimal13f`	`valueOf(double value)` Returns a `Decimal13f` whose value is calculated by rounding the specified `double` argument to scale 13 using `HALF_UP` rounding.
`static Decimal13f`	`valueOf(double value, RoundingMode roundingMode)` Returns a `Decimal13f` whose value is calculated by rounding the specified `double` argument to scale 13 using the specified `roundingMode`.
`static Decimal13f`	`valueOf(float value)` Returns a `Decimal13f` whose value is calculated by rounding the specified `float` argument to scale 13 using `HALF_UP` rounding.
`static Decimal13f`	`valueOf(float value, RoundingMode roundingMode)` Returns a `Decimal13f` whose value is calculated by rounding the specified `float` argument to scale 13 using the specified `roundingMode`.
`static Decimal13f`	`valueOf(long value)` Returns a `Decimal13f` whose value is numerically equal to that of the specified `long` value.
`static Decimal13f`	`valueOf(String value)` Translates the string representation of a `Decimal` into a `Decimal13f`.
`static Decimal13f`	`valueOf(String value, RoundingMode roundingMode)` Translates the string representation of a `Decimal` into a `Decimal13f`.
`static Decimal13f`	`valueOfUnscaled(long unscaledValue)` Returns a `Decimal13f` whose value is numerically equal to `(unscaledValue × 10^-13)`.
`static Decimal13f`	`valueOfUnscaled(long unscaledValue, int scale)` Returns a `Decimal13f` whose value is numerically equal to `(unscaledValue × 10^-scale)`.
`static Decimal13f`	`valueOfUnscaled(long unscaledValue, int scale, RoundingMode roundingMode)` Returns a `Decimal13f` whose value is numerically equal to `(unscaledValue × 10^-scale)`.

Methods inherited from class org.decimal4j.base.AbstractImmutableDecimal
max, min, multiplyExact, scale, scale, scale, scale, toString, 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

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.decimal4j.api.ImmutableDecimal
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

- Field Detail
  - SCALE
```
public static final int SCALE
```
    Scale value 13 for Decimal13f returned by getScale().
    
    See Also:
    
    Constant Field Values
  - METRICS
```
public static final Scale13f METRICS
```
    Scale metrics constant for Decimal13f returned by getScaleMetrics().
  - FACTORY
```
public static final Factory13f FACTORY
```
    Factory constant for Decimal13f returned by getFactory().
  - DEFAULT_ARITHMETIC
```
public static final DecimalArithmetic DEFAULT_ARITHMETIC
```
    Default arithmetic for Decimal13f performing unchecked operations with rounding mode HALF_UP.
  - DEFAULT_CHECKED_ARITHMETIC
```
public static final DecimalArithmetic DEFAULT_CHECKED_ARITHMETIC
```
    Default arithmetic for Decimal13f performing checked operations with rounding mode HALF_UP.
  - ONE_UNSCALED
```
public static final long ONE_UNSCALED
```
    The unscaled long value that represents one.
  - ZERO
```
public static final Decimal13f ZERO
```
    The Decimal13f constant zero.
  - ULP
```
public static final Decimal13f ULP
```
    A constant holding the smallest positive value a Decimal13f can have, 10^-13.
  - ONE
```
public static final Decimal13f ONE
```
    The Decimal13f constant 1.
  - TWO
```
public static final Decimal13f TWO
```
    The Decimal13f constant 2.
  - THREE
```
public static final Decimal13f THREE
```
    The Decimal13f constant 3.
  - FOUR
```
public static final Decimal13f FOUR
```
    The Decimal13f constant 4.
  - FIVE
```
public static final Decimal13f FIVE
```
    The Decimal13f constant 5.
  - SIX
```
public static final Decimal13f SIX
```
    The Decimal13f constant 6.
  - SEVEN
```
public static final Decimal13f SEVEN
```
    The Decimal13f constant 7.
  - EIGHT
```
public static final Decimal13f EIGHT
```
    The Decimal13f constant 8.
  - NINE
```
public static final Decimal13f NINE
```
    The Decimal13f constant 9.
  - TEN
```
public static final Decimal13f TEN
```
    The Decimal13f constant 10.
  - HUNDRED
```
public static final Decimal13f HUNDRED
```
    The Decimal13f constant 100.
  - THOUSAND
```
public static final Decimal13f THOUSAND
```
    The Decimal13f constant 1000.
  - MINUS_ONE
```
public static final Decimal13f MINUS_ONE
```
    The Decimal13f constant -1.
  - HALF
```
public static final Decimal13f HALF
```
    The Decimal13f constant 0.5.
  - TENTH
```
public static final Decimal13f TENTH
```
    The Decimal13f constant 0.1.
  - HUNDREDTH
```
public static final Decimal13f HUNDREDTH
```
    The Decimal13f constant 0.01.
  - THOUSANDTH
```
public static final Decimal13f THOUSANDTH
```
    The Decimal13f constant 0.001.
  - MILLIONTH
```
public static final Decimal13f MILLIONTH
```
    The Decimal13f constant 10^-6.
  - BILLIONTH
```
public static final Decimal13f BILLIONTH
```
    The Decimal13f constant 10^-9.
  - TRILLIONTH
```
public static final Decimal13f TRILLIONTH
```
    The Decimal13f constant 10^-12.
  - MAX_VALUE
```
public static final Decimal13f MAX_VALUE
```
    A constant holding the maximum value a Decimal13f can have, 922337.2036854775807.
  - MAX_INTEGER_VALUE
```
public static final Decimal13f MAX_INTEGER_VALUE
```
    A constant holding the maximum integer value a Decimal13f can have, 922337.0000000000000.
  - MIN_VALUE
```
public static final Decimal13f MIN_VALUE
```
    A constant holding the minimum value a Decimal13f can have, -922337.2036854775808.
  - MIN_INTEGER_VALUE
```
public static final Decimal13f MIN_INTEGER_VALUE
```
    A constant holding the minimum integer value a Decimal13f can have, -922337.0000000000000.
- Constructor Detail
  - Decimal13f
```
public Decimal13f(String value)
```
    Translates the string representation of a Decimal into a Decimal13f. 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 13 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - String value to convert into a Decimal13f
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a Decimal13f
- Method Detail
  - getScaleMetrics
```
public final Scale13f 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.
    
    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().
    
    Returns:
    
    the scale
    
    See Also:
    
    Decimal.getScaleMetrics(), ScaleMetrics.getScale(), Decimal.unscaledValue()
  - getFactory
```
public final Factory13f 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.
    
    Returns:
    
    the factory to create other Decimal values of the same scale as this Decimal
  - self
```
protected final Decimal13f self()
```
    Description copied from class: AbstractDecimal
    
    Returns this decimal value as concrete implementation subtype.
    
    Specified by:
    
    self in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    this
  - getDefaultArithmetic
```
protected final DecimalArithmetic getDefaultArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the default arithmetic performing unchecked operations with rounding mode HALF_UP.
    
    Overrides:
    
    getDefaultArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    default arithmetic with HALF_UP rounding and UNCHECKED overflow mode
  - getDefaultCheckedArithmetic
```
protected final DecimalArithmetic getDefaultCheckedArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the default arithmetic performing checked operations with rounding mode HALF_UP.
    
    Overrides:
    
    getDefaultCheckedArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    default arithmetic with HALF_UP rounding and CHECKED overflow mode
  - getRoundingDownArithmetic
```
protected final DecimalArithmetic getRoundingDownArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode DOWN.
    
    Overrides:
    
    getRoundingDownArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    arithmetic with DOWN rounding and UNCHECKED overflow mode
  - getRoundingFloorArithmetic
```
protected final DecimalArithmetic getRoundingFloorArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode FLOOR.
    
    Overrides:
    
    getRoundingFloorArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    arithmetic with FLOOR rounding and UNCHECKED overflow mode
  - getRoundingHalfEvenArithmetic
```
protected final DecimalArithmetic getRoundingHalfEvenArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode HALF_EVEN.
    
    Overrides:
    
    getRoundingHalfEvenArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    arithmetic with HALF_UP rounding and UNCHECKED overflow mode
  - getRoundingUnnecessaryArithmetic
```
protected final DecimalArithmetic getRoundingUnnecessaryArithmetic()
```
    Description copied from class: AbstractDecimal
    
    Returns the arithmetic performing unchecked operations with rounding mode UNNECESSARY.
    
    Overrides:
    
    getRoundingUnnecessaryArithmetic in class AbstractDecimal<Scale13f,Decimal13f>
    
    Returns:
    
    arithmetic with UNNECESSARY rounding and UNCHECKED overflow mode
  - valueOf
```
public static Decimal13f valueOf(long value)
```
    Returns a Decimal13f 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 Decimal13f.
    
    Parameters:
    
    value - long value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f value numerically equal to the specified long value
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(float value)
```
    Returns a Decimal13f whose value is calculated by rounding the specified float argument to scale 13 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - float value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(float value,
                                 RoundingMode roundingMode)
```
    Returns a Decimal13f whose value is calculated by rounding the specified float argument to scale 13 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - float value to convert into a Decimal13f
    
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    
    a Decimal13f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the float to be represented as a Decimal13f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal13f valueOf(double value)
```
    Returns a Decimal13f whose value is calculated by rounding the specified double argument to scale 13 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - double value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the double to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(double value,
                                 RoundingMode roundingMode)
```
    Returns a Decimal13f whose value is calculated by rounding the specified double argument to scale 13 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - double value to convert into a Decimal13f
    
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    
    a Decimal13f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is NaN or infinite or if the magnitude is too large for the double to be represented as a Decimal13f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal13f valueOf(BigInteger value)
```
    Returns a Decimal13f 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 Decimal13f.
    
    Parameters:
    
    value - BigInteger value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f value numerically equal to the specified big integer value
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(BigDecimal value)
```
    Returns a Decimal13f whose value is calculated by rounding the specified BigDecimal argument to scale 13 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - BigDecimal value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(BigDecimal value,
                                 RoundingMode roundingMode)
```
    Returns a Decimal13f whose value is calculated by rounding the specified BigDecimal argument to scale 13 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - BigDecimal value to convert into a Decimal13f
    
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    
    a Decimal13f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal13f valueOf(Decimal<?> value)
```
    Returns a Decimal13f whose value is calculated by rounding the specified Decimal argument to scale 13 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - Decimal value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(Decimal<?> value,
                                 RoundingMode roundingMode)
```
    Returns a Decimal13f whose value is calculated by rounding the specified Decimal argument to scale 13 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - Decimal value to convert into a Decimal13f
    
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    
    a Decimal13f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal13f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal13f valueOf(String value)
```
    Translates the string representation of a Decimal into a Decimal13f. 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 13 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - String value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a Decimal13f
  - valueOf
```
public static Decimal13f valueOf(String value,
                                 RoundingMode roundingMode)
```
    Translates the string representation of a Decimal into a Decimal13f. 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 13 digits, the value is rounded using the specified roundingMode. An exception is thrown if the value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    value - String value to convert into a Decimal13f
    
    roundingMode - the rounding mode to apply if the fraction contains more than 13 digits
    
    Returns:
    
    a Decimal13f calculated as: round(value)
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a Decimal13f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOfUnscaled
```
public static Decimal13f valueOfUnscaled(long unscaledValue)
```
    Returns a Decimal13f whose value is numerically equal to (unscaledValue × 10^-13).
    
    Parameters:
    
    unscaledValue - unscaled value to convert into a Decimal13f
    
    Returns:
    
    a Decimal13f calculated as: unscaledValue × 10^-13
  - valueOfUnscaled
```
public static Decimal13f valueOfUnscaled(long unscaledValue,
                                         int scale)
```
    Returns a Decimal13f whose value is numerically equal to (unscaledValue × 10^-scale). The result is rounded to scale 13 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    unscaledValue - unscaled value to convert into a Decimal13f
    
    scale - the scale to apply to unscaledValue
    
    Returns:
    
    a Decimal13f calculated as: round_{HALF_UP}(unscaledValue × 10^-scale)
    
    Throws:
    
    IllegalArgumentException - if the specified value is too large to be represented as a Decimal13f
  - valueOfUnscaled
```
public static Decimal13f valueOfUnscaled(long unscaledValue,
                                         int scale,
                                         RoundingMode roundingMode)
```
    Returns a Decimal13f whose value is numerically equal to (unscaledValue × 10^-scale). The result is rounded to scale 13 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal13f.
    
    Parameters:
    
    unscaledValue - unscaled value to convert into a Decimal13
    
    scale - the scale to apply to unscaledValue
    
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    
    a Decimal13f calculated as: round(unscaledValue × 10^-scale)
    
    Throws:
    
    IllegalArgumentException - if the specified value is too large to be represented as a Decimal13f
  - createOrAssign
```
protected Decimal13f createOrAssign(long unscaled)
```
    Description copied from class: AbstractDecimal
    
    Returns this or a new Decimal whose value is (unscaled × 10^-scale).
    The returned value is a new instance if this decimal is an ImmutableDecimal. If it is a MutableDecimal then its internal state is altered and this is returned as result now representing (unscaled × 10^-scale).
    
    Specified by:
    
    createOrAssign in class AbstractDecimal<Scale13f,Decimal13f>
    
    Parameters:
    
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    
    unscaled × 10^-scale
  - create
```
protected Decimal13f create(long unscaled)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal whose value is (unscaled × 10^-scale).
    
    Specified by:
    
    create in class AbstractDecimal<Scale13f,Decimal13f>
    
    Parameters:
    
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    
    unscaled × 10^-scale
  - createArray
```
protected Decimal13f[] createArray(int length)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal array of the specified length.
    
    Specified by:
    
    createArray in class AbstractDecimal<Scale13f,Decimal13f>
    
    Parameters:
    
    length - the length of the array to return
    
    Returns:
    
    new D[length]
  - multiplyExact
```
public Multipliable13f multiplyExact()
```
    Returns this Decimal as a multipliable factor for 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:
```
 Decimal15f product = this.multiplyExact().by(Decimal2f.FIVE);
 
```
    Returns:
    
    a multipliable object encapsulating this Decimal as first factor of an exact multiplication
  - toMutableDecimal
```
public MutableDecimal13f 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.
    
    Returns:
    
    this if mutable and a new MutableDecimal with the same scale and value as this Decimal otherwise
  - toImmutableDecimal
```
public Decimal13f 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.
    
    Returns:
    
    this if immutable and a new ImmutableDecimal with the same scale and value as this Decimal otherwise

Class Decimal13f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.decimal4j.base.AbstractImmutableDecimal

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.ImmutableDecimal

Methods inherited from interface org.decimal4j.api.Decimal

Field Detail

SCALE

METRICS

FACTORY

DEFAULT_ARITHMETIC

DEFAULT_CHECKED_ARITHMETIC

ONE_UNSCALED

ZERO

ULP

ONE

TWO

THREE

FOUR

FIVE

SIX

SEVEN

EIGHT

NINE

TEN

HUNDRED

THOUSAND

MINUS_ONE

HALF

TENTH

HUNDREDTH

THOUSANDTH

MILLIONTH

BILLIONTH

TRILLIONTH

MAX_VALUE

MAX_INTEGER_VALUE

MIN_VALUE

MIN_INTEGER_VALUE

Constructor Detail

Decimal13f

Method Detail

getScaleMetrics

getScale

getFactory

self

getDefaultArithmetic

getDefaultCheckedArithmetic

getRoundingDownArithmetic

getRoundingFloorArithmetic

getRoundingHalfEvenArithmetic

getRoundingUnnecessaryArithmetic

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOfUnscaled

valueOfUnscaled

valueOfUnscaled

createOrAssign

create

createArray

multiplyExact

toMutableDecimal

toImmutableDecimal