Decimal17f (decimal4j API 1.0.3)

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

All Implemented Interfaces:

Serializable, Comparable<Decimal<Scale17f>>, Decimal<Scale17f>, ImmutableDecimal<Scale17f>
```
public final class Decimal17f
extends AbstractImmutableDecimal<Scale17f,Decimal17f>
```
Decimal17f represents an immutable decimal number with a fixed number of 17 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 Decimal17f`	`BILLIONTH` The `Decimal17f` constant 10^-9.
`static DecimalArithmetic`	`DEFAULT_ARITHMETIC` Default arithmetic for `Decimal17f` performing unchecked operations with rounding mode `HALF_UP`.
`static DecimalArithmetic`	`DEFAULT_CHECKED_ARITHMETIC` Default arithmetic for `Decimal17f` performing checked operations with rounding mode `HALF_UP`.
`static Decimal17f`	`EIGHT` The `Decimal17f` constant 8.
`static Factory17f`	`FACTORY` Factory constant for `Decimal17f` returned by `getFactory()`.
`static Decimal17f`	`FIVE` The `Decimal17f` constant 5.
`static Decimal17f`	`FOUR` The `Decimal17f` constant 4.
`static Decimal17f`	`HALF` The `Decimal17f` constant 0.5.
`static Decimal17f`	`HUNDREDTH` The `Decimal17f` constant 0.01.
`static Decimal17f`	`MAX_INTEGER_VALUE` A constant holding the maximum integer value a `Decimal17f` can have, 92.00000000000000000.
`static Decimal17f`	`MAX_VALUE` A constant holding the maximum value a `Decimal17f` can have, 92.23372036854775807.
`static Scale17f`	`METRICS` Scale metrics constant for `Decimal17f` returned by `getScaleMetrics()`.
`static Decimal17f`	`MILLIONTH` The `Decimal17f` constant 10^-6.
`static Decimal17f`	`MIN_INTEGER_VALUE` A constant holding the minimum integer value a `Decimal17f` can have, -92.00000000000000000.
`static Decimal17f`	`MIN_VALUE` A constant holding the minimum value a `Decimal17f` can have, -92.23372036854775808.
`static Decimal17f`	`MINUS_ONE` The `Decimal17f` constant -1.
`static Decimal17f`	`NINE` The `Decimal17f` constant 9.
`static Decimal17f`	`ONE` The `Decimal17f` constant 1.
`static long`	`ONE_UNSCALED` The unscaled long value that represents one.
`static Decimal17f`	`QUADRILLIONTH` The `Decimal17f` constant 10^-15.
`static int`	`SCALE` Scale value 17 for `Decimal17f` returned by `getScale()`.
`static Decimal17f`	`SEVEN` The `Decimal17f` constant 7.
`static Decimal17f`	`SIX` The `Decimal17f` constant 6.
`static Decimal17f`	`TEN` The `Decimal17f` constant 10.
`static Decimal17f`	`TENTH` The `Decimal17f` constant 0.1.
`static Decimal17f`	`THOUSANDTH` The `Decimal17f` constant 0.001.
`static Decimal17f`	`THREE` The `Decimal17f` constant 3.
`static Decimal17f`	`TRILLIONTH` The `Decimal17f` constant 10^-12.
`static Decimal17f`	`TWO` The `Decimal17f` constant 2.
`static Decimal17f`	`ULP` A constant holding the smallest positive value a `Decimal17f` can have, 10^-17.
`static Decimal17f`	`ZERO` The `Decimal17f` constant zero.

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected Decimal17f`	`create(long unscaled)` Returns a new `Decimal` whose value is `(unscaled × 10^-scale)`.
`protected Decimal17f[]`	`createArray(int length)` Returns a new `Decimal` array of the specified `length`.
`protected Decimal17f`	`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`.
`Factory17f`	`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.
`Scale17f`	`getScaleMetrics()` Returns the metrics associated with the scale of this Decimal.
`Multipliable17f`	`multiplyExact()` Returns this `Decimal` as a multipliable factor for typed exact multiplication.
`protected Decimal17f`	`self()` Returns `this` decimal value as concrete implementation subtype.
`Decimal17f`	`toImmutableDecimal()` If this `Decimal` value is already an `ImmutableDecimal` it is simply returned.
`MutableDecimal17f`	`toMutableDecimal()` If this `Decimal` value is already a `MutableDecimal` it is simply returned.
`static Decimal17f`	`valueOf(BigDecimal value)` Returns a `Decimal17f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 17 using `HALF_UP` rounding.
`static Decimal17f`	`valueOf(BigDecimal value, RoundingMode roundingMode)` Returns a `Decimal17f` whose value is calculated by rounding the specified `BigDecimal` argument to scale 17 using the specified `roundingMode`.
`static Decimal17f`	`valueOf(BigInteger value)` Returns a `Decimal17f` whose value is numerically equal to that of the specified `BigInteger` value.
`static Decimal17f`	`valueOf(Decimal<?> value)` Returns a `Decimal17f` whose value is calculated by rounding the specified `Decimal` argument to scale 17 using `HALF_UP` rounding.
`static Decimal17f`	`valueOf(Decimal<?> value, RoundingMode roundingMode)` Returns a `Decimal17f` whose value is calculated by rounding the specified `Decimal` argument to scale 17 using the specified `roundingMode`.
`static Decimal17f`	`valueOf(double value)` Returns a `Decimal17f` whose value is calculated by rounding the specified `double` argument to scale 17 using `HALF_UP` rounding.
`static Decimal17f`	`valueOf(double value, RoundingMode roundingMode)` Returns a `Decimal17f` whose value is calculated by rounding the specified `double` argument to scale 17 using the specified `roundingMode`.
`static Decimal17f`	`valueOf(float value)` Returns a `Decimal17f` whose value is calculated by rounding the specified `float` argument to scale 17 using `HALF_UP` rounding.
`static Decimal17f`	`valueOf(float value, RoundingMode roundingMode)` Returns a `Decimal17f` whose value is calculated by rounding the specified `float` argument to scale 17 using the specified `roundingMode`.
`static Decimal17f`	`valueOf(long value)` Returns a `Decimal17f` whose value is numerically equal to that of the specified `long` value.
`static Decimal17f`	`valueOf(String value)` Translates the string representation of a `Decimal` into a `Decimal17f`.
`static Decimal17f`	`valueOf(String value, RoundingMode roundingMode)` Translates the string representation of a `Decimal` into a `Decimal17f`.
`static Decimal17f`	`valueOfUnscaled(long unscaledValue)` Returns a `Decimal17f` whose value is numerically equal to `(unscaledValue × 10^-17)`.
`static Decimal17f`	`valueOfUnscaled(long unscaledValue, int scale)` Returns a `Decimal17f` whose value is numerically equal to `(unscaledValue × 10^-scale)`.
`static Decimal17f`	`valueOfUnscaled(long unscaledValue, int scale, RoundingMode roundingMode)` Returns a `Decimal17f` 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 17 for Decimal17f returned by getScale().
    
    See Also:
    Constant Field Values
  - METRICS
```
public static final Scale17f METRICS
```
    Scale metrics constant for Decimal17f returned by getScaleMetrics().
  - FACTORY
```
public static final Factory17f FACTORY
```
    Factory constant for Decimal17f returned by getFactory().
  - DEFAULT_ARITHMETIC
```
public static final DecimalArithmetic DEFAULT_ARITHMETIC
```
    Default arithmetic for Decimal17f performing unchecked operations with rounding mode HALF_UP.
  - DEFAULT_CHECKED_ARITHMETIC
```
public static final DecimalArithmetic DEFAULT_CHECKED_ARITHMETIC
```
    Default arithmetic for Decimal17f 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 Decimal17f ZERO
```
    The Decimal17f constant zero.
  - ULP
```
public static final Decimal17f ULP
```
    A constant holding the smallest positive value a Decimal17f can have, 10^-17.
  - ONE
```
public static final Decimal17f ONE
```
    The Decimal17f constant 1.
  - TWO
```
public static final Decimal17f TWO
```
    The Decimal17f constant 2.
  - THREE
```
public static final Decimal17f THREE
```
    The Decimal17f constant 3.
  - FOUR
```
public static final Decimal17f FOUR
```
    The Decimal17f constant 4.
  - FIVE
```
public static final Decimal17f FIVE
```
    The Decimal17f constant 5.
  - SIX
```
public static final Decimal17f SIX
```
    The Decimal17f constant 6.
  - SEVEN
```
public static final Decimal17f SEVEN
```
    The Decimal17f constant 7.
  - EIGHT
```
public static final Decimal17f EIGHT
```
    The Decimal17f constant 8.
  - NINE
```
public static final Decimal17f NINE
```
    The Decimal17f constant 9.
  - TEN
```
public static final Decimal17f TEN
```
    The Decimal17f constant 10.
  - MINUS_ONE
```
public static final Decimal17f MINUS_ONE
```
    The Decimal17f constant -1.
  - HALF
```
public static final Decimal17f HALF
```
    The Decimal17f constant 0.5.
  - TENTH
```
public static final Decimal17f TENTH
```
    The Decimal17f constant 0.1.
  - HUNDREDTH
```
public static final Decimal17f HUNDREDTH
```
    The Decimal17f constant 0.01.
  - THOUSANDTH
```
public static final Decimal17f THOUSANDTH
```
    The Decimal17f constant 0.001.
  - MILLIONTH
```
public static final Decimal17f MILLIONTH
```
    The Decimal17f constant 10^-6.
  - BILLIONTH
```
public static final Decimal17f BILLIONTH
```
    The Decimal17f constant 10^-9.
  - TRILLIONTH
```
public static final Decimal17f TRILLIONTH
```
    The Decimal17f constant 10^-12.
  - QUADRILLIONTH
```
public static final Decimal17f QUADRILLIONTH
```
    The Decimal17f constant 10^-15.
  - MAX_VALUE
```
public static final Decimal17f MAX_VALUE
```
    A constant holding the maximum value a Decimal17f can have, 92.23372036854775807.
  - MAX_INTEGER_VALUE
```
public static final Decimal17f MAX_INTEGER_VALUE
```
    A constant holding the maximum integer value a Decimal17f can have, 92.00000000000000000.
  - MIN_VALUE
```
public static final Decimal17f MIN_VALUE
```
    A constant holding the minimum value a Decimal17f can have, -92.23372036854775808.
  - MIN_INTEGER_VALUE
```
public static final Decimal17f MIN_INTEGER_VALUE
```
    A constant holding the minimum integer value a Decimal17f can have, -92.00000000000000000.
- Constructor Detail
  - Decimal17f
```
public Decimal17f(String value)
```
    Translates the string representation of a Decimal into a Decimal17f. 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 17 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - String value to convert into a Decimal17f
    
    Throws:
    
    NumberFormatException - if value does not represent a valid Decimal or if the value is too large to be represented as a Decimal17f
- Method Detail
  - getScaleMetrics
```
public final Scale17f 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 Factory17f 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 Decimal17f self()
```
    Description copied from class: AbstractDecimal
    
    Returns this decimal value as concrete implementation subtype.
    
    Specified by:
    
    self in class AbstractDecimal<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    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<Scale17f,Decimal17f>
    
    Returns:
    arithmetic with UNNECESSARY rounding and UNCHECKED overflow mode
  - valueOf
```
public static Decimal17f valueOf(long value)
```
    Returns a Decimal17f 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 Decimal17f.
    
    Parameters:
    value - long value to convert into a Decimal17f
    
    Returns:
    a Decimal17f value numerically equal to the specified long value
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
  - valueOf
```
public static Decimal17f valueOf(float value)
```
    Returns a Decimal17f whose value is calculated by rounding the specified float argument to scale 17 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - float value to convert into a Decimal17f
    
    Returns:
    a Decimal17f 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 Decimal17f
  - valueOf
```
public static Decimal17f valueOf(float value,
                 RoundingMode roundingMode)
```
    Returns a Decimal17f whose value is calculated by rounding the specified float argument to scale 17 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - float value to convert into a Decimal17f
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    a Decimal17f 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 Decimal17f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal17f valueOf(double value)
```
    Returns a Decimal17f whose value is calculated by rounding the specified double argument to scale 17 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - double value to convert into a Decimal17f
    
    Returns:
    a Decimal17f 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 Decimal17f
  - valueOf
```
public static Decimal17f valueOf(double value,
                 RoundingMode roundingMode)
```
    Returns a Decimal17f whose value is calculated by rounding the specified double argument to scale 17 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - double value to convert into a Decimal17f
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    a Decimal17f 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 Decimal17f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal17f valueOf(BigInteger value)
```
    Returns a Decimal17f 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 Decimal17f.
    
    Parameters:
    value - BigInteger value to convert into a Decimal17f
    
    Returns:
    a Decimal17f value numerically equal to the specified big integer value
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
  - valueOf
```
public static Decimal17f valueOf(BigDecimal value)
```
    Returns a Decimal17f whose value is calculated by rounding the specified BigDecimal argument to scale 17 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - BigDecimal value to convert into a Decimal17f
    
    Returns:
    a Decimal17f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
  - valueOf
```
public static Decimal17f valueOf(BigDecimal value,
                 RoundingMode roundingMode)
```
    Returns a Decimal17f whose value is calculated by rounding the specified BigDecimal argument to scale 17 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - BigDecimal value to convert into a Decimal17f
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    a Decimal17f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal17f valueOf(Decimal<?> value)
```
    Returns a Decimal17f whose value is calculated by rounding the specified Decimal argument to scale 17 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - Decimal value to convert into a Decimal17f
    
    Returns:
    a Decimal17f calculated as: round_{HALF_UP}(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
  - valueOf
```
public static Decimal17f valueOf(Decimal<?> value,
                 RoundingMode roundingMode)
```
    Returns a Decimal17f whose value is calculated by rounding the specified Decimal argument to scale 17 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - Decimal value to convert into a Decimal17f
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    a Decimal17f calculated as: round(value)
    
    Throws:
    
    IllegalArgumentException - if value is too large to be represented as a Decimal17f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOf
```
public static Decimal17f valueOf(String value)
```
    Translates the string representation of a Decimal into a Decimal17f. 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 17 digits, the value is rounded using HALF_UP rounding. An exception is thrown if the value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - String value to convert into a Decimal17f
    
    Returns:
    a Decimal17f 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 Decimal17f
  - valueOf
```
public static Decimal17f valueOf(String value,
                 RoundingMode roundingMode)
```
    Translates the string representation of a Decimal into a Decimal17f. 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 17 digits, the value is rounded using the specified roundingMode. An exception is thrown if the value is too large to be represented as a Decimal17f.
    
    Parameters:
    value - String value to convert into a Decimal17f
    roundingMode - the rounding mode to apply if the fraction contains more than 17 digits
    
    Returns:
    a Decimal17f 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 Decimal17f
    
    ArithmeticException - if roundingMode==UNNECESSARY and rounding is necessary
  - valueOfUnscaled
```
public static Decimal17f valueOfUnscaled(long unscaledValue)
```
    Returns a Decimal17f whose value is numerically equal to (unscaledValue × 10^-17).
    
    Parameters:
    unscaledValue - unscaled value to convert into a Decimal17f
    
    Returns:
    a Decimal17f calculated as: unscaledValue × 10^-17
  - valueOfUnscaled
```
public static Decimal17f valueOfUnscaled(long unscaledValue,
                         int scale)
```
    Returns a Decimal17f whose value is numerically equal to (unscaledValue × 10^-scale). The result is rounded to scale 17 using HALF_UP rounding. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    unscaledValue - unscaled value to convert into a Decimal17f
    scale - the scale to apply to unscaledValue
    
    Returns:
    a Decimal17f calculated as: round_{HALF_UP}(unscaledValue × 10^-scale)
    
    Throws:
    
    IllegalArgumentException - if the specified value is too large to be represented as a Decimal17f
  - valueOfUnscaled
```
public static Decimal17f valueOfUnscaled(long unscaledValue,
                         int scale,
                         RoundingMode roundingMode)
```
    Returns a Decimal17f whose value is numerically equal to (unscaledValue × 10^-scale). The result is rounded to scale 17 using the specified roundingMode. An exception is thrown if the specified value is too large to be represented as a Decimal17f.
    
    Parameters:
    unscaledValue - unscaled value to convert into a Decimal17
    scale - the scale to apply to unscaledValue
    roundingMode - the rounding mode to apply during the conversion if necessary
    
    Returns:
    a Decimal17f calculated as: round(unscaledValue × 10^-scale)
    
    Throws:
    
    IllegalArgumentException - if the specified value is too large to be represented as a Decimal17f
  - createOrAssign
```
protected Decimal17f 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<Scale17f,Decimal17f>
    
    Parameters:
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    unscaled × 10^-scale
  - create
```
protected Decimal17f create(long unscaled)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal whose value is (unscaled × 10^-scale).
    
    Specified by:
    
    create in class AbstractDecimal<Scale17f,Decimal17f>
    
    Parameters:
    unscaled - unscaled value to be returned as a Decimal
    
    Returns:
    unscaled × 10^-scale
  - createArray
```
protected Decimal17f[] createArray(int length)
```
    Description copied from class: AbstractDecimal
    
    Returns a new Decimal array of the specified length.
    
    Specified by:
    
    createArray in class AbstractDecimal<Scale17f,Decimal17f>
    
    Parameters:
    length - the length of the array to return
    
    Returns:
    new D[length]
  - multiplyExact
```
public Multipliable17f 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:
```
 Decimal17f product = this.multiplyExact().by(Decimal0f.FIVE);
 
```
    Returns:
    a multipliable object encapsulating this Decimal as first factor of an exact multiplication
  - toMutableDecimal
```
public MutableDecimal17f 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 Decimal17f 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 Decimal17f

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

MINUS_ONE

HALF

TENTH

HUNDREDTH

THOUSANDTH

MILLIONTH

BILLIONTH

TRILLIONTH

QUADRILLIONTH

MAX_VALUE

MAX_INTEGER_VALUE

MIN_VALUE

MIN_INTEGER_VALUE

Constructor Detail

Decimal17f

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