Scale17f (decimal4j API 1.0.7-SNAPSHOT)

java.lang.Object
- java.lang.Enum<Scale17f>
- - org.decimal4j.scale.Scale17f

All Implemented Interfaces:

Serializable, Comparable<Scale17f>, ScaleMetrics
```
public enum Scale17f
extends Enum<Scale17f>
implements ScaleMetrics
```
Scale class for decimals with scale 17 and scale factor 100000000000000000.

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
The singleton instance for scale 17.

Enum Constants
Enum Constant and Description
`INSTANCE` The singleton instance for scale 17.

Field Summary

Fields
Modifier and Type Field and Description

static int SCALE
The scale value 17.

static long SCALE_FACTOR
The scale factor 10¹⁷.

Fields
Modifier and Type	Field and Description
`static int`	`SCALE` The scale value `17`.
`static long`	`SCALE_FACTOR` The scale factor `10¹⁷`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`divideByScaleFactor(long dividend)` Returns `dividend/scaleFactor`.
`long`	`divideUnsignedByScaleFactor(long unsignedDividend)` Returns `unsignedDividend/scaleFactor` using unsigned division.
`DecimalArithmetic`	`getArithmetic(RoundingMode roundingMode)` Returns the arithmetic for this scale that performs all operations with the specified `roundingMode` and without overflow checks.
`DecimalArithmetic`	`getArithmetic(TruncationPolicy truncationPolicy)` Returns the arithmetic for this scale that performs all operations with the specified `truncationPolicy`.
`DecimalArithmetic`	`getCheckedArithmetic(RoundingMode roundingMode)` Returns the arithmetic for this scale that performs all operations with the specified `roundingMode` and with overflow checks.
`DecimalArithmetic`	`getDefaultArithmetic()` Returns the default arithmetic for this scale performing unchecked operations with rounding mode `HALF_UP`.
`DecimalArithmetic`	`getDefaultCheckedArithmetic()` Returns the default arithmetic for this scale performing checked operations with rounding mode `HALF_UP`.
`long`	`getMaxIntegerValue()` Returns the largest integer value that can be represented using this scale.
`long`	`getMinIntegerValue()` Returns the smallest integer value that can be represented using this scale.
`DecimalArithmetic`	`getRoundingDownArithmetic()` Returns the arithmetic for this scale performing unchecked operations with rounding mode `DOWN`.
`DecimalArithmetic`	`getRoundingFloorArithmetic()` Returns the arithmetic for this scale performing unchecked operations with rounding mode `FLOOR`.
`DecimalArithmetic`	`getRoundingHalfEvenArithmetic()` Returns the arithmetic for this scale performing unchecked operations with rounding mode `HALF_EVEN`.
`DecimalArithmetic`	`getRoundingUnnecessaryArithmetic()` Returns the arithmetic for this scale performing unchecked operations with rounding mode `UNNECESSARY`.
`int`	`getScale()` Returns the scale, the number of fraction digits to the right of the decimal point of a `Decimal` value.
`long`	`getScaleFactor()` Returns the scale factor, which is 10^f where `f` stands for the `scale`.
`BigDecimal`	`getScaleFactorAsBigDecimal()` Returns the `scale factor` as a `BigDecimal` value with scale zero.
`BigInteger`	`getScaleFactorAsBigInteger()` Returns the `scale factor` as a `BigInteger` value.
`int`	`getScaleFactorNumberOfLeadingZeros()` Returns the number of leading zeros of the scale factor
`boolean`	`isValidIntegerValue(long value)` Returns true if the specified integer `value` can be represented using this scale.
`long`	`moduloByScaleFactor(long dividend)` Returns `dividend % scaleFactor` also known as reminder.
`long`	`mulhiByScaleFactor(int factor)` Returns `factor*high32(scaleFactor)` where high32 refers to the high 32 bits of the factor.
`long`	`mulloByScaleFactor(int factor)` Returns `factor*low32(scaleFactor)` where low32 refers to the low 32 bits of the factor.
`long`	`multiplyByScaleFactor(long factor)` Returns `factor*scaleFactor`.
`long`	`multiplyByScaleFactorExact(long factor)` Returns `factor*scaleFactor`, checking for lost information.
`String`	`toString()`
`String`	`toString(long value)` Returns the string representation of the specified `value` applying this metric's scale.
`static Scale17f`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Scale17f[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - INSTANCE
```
public static final Scale17f INSTANCE
```
    The singleton instance for scale 17.
- Field Detail
  - SCALE
```
public static final int SCALE
```
    The scale value 17.
    
    See Also:
    
    Constant Field Values
  - SCALE_FACTOR
```
public static final long SCALE_FACTOR
```
    The scale factor 10¹⁷.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Scale17f[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Scale17f c : Scale17f.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Scale17f valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getScale
```
public final int getScale()
```
    Description copied from interface: ScaleMetrics
    
    Returns the scale, the number of fraction digits to the right of the decimal point of a Decimal value.
    
    Specified by:
    
    getScale in interface ScaleMetrics
    
    Returns:
    
    the scale also known as number of fraction digits
  - getScaleFactor
```
public final long getScaleFactor()
```
    Description copied from interface: ScaleMetrics
    
    Returns the scale factor, which is 10^f where f stands for the scale.
    
    Specified by:
    
    getScaleFactor in interface ScaleMetrics
    
    Returns:
    
    the scale factor
  - getScaleFactorNumberOfLeadingZeros
```
public final int getScaleFactorNumberOfLeadingZeros()
```
    Description copied from interface: ScaleMetrics
    
    Returns the number of leading zeros of the scale factor
    
    Specified by:
    
    getScaleFactorNumberOfLeadingZeros in interface ScaleMetrics
    
    Returns:
    
    Long.numberOfLeadingZeros(long) applied to the scale factor
  - multiplyByScaleFactor
```
public final long multiplyByScaleFactor(long factor)
```
    Description copied from interface: ScaleMetrics
    
    Returns factor*scaleFactor.
    
    Specified by:
    
    multiplyByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*scaleFactor
  - getScaleFactorAsBigInteger
```
public final BigInteger getScaleFactorAsBigInteger()
```
    Description copied from interface: ScaleMetrics
    
    Returns the scale factor as a BigInteger value.
    
    Specified by:
    
    getScaleFactorAsBigInteger in interface ScaleMetrics
    
    Returns:
    
    the scale factor as big integer
  - getScaleFactorAsBigDecimal
```
public final BigDecimal getScaleFactorAsBigDecimal()
```
    Description copied from interface: ScaleMetrics
    
    Returns the scale factor as a BigDecimal value with scale zero.
    
    Specified by:
    
    getScaleFactorAsBigDecimal in interface ScaleMetrics
    
    Returns:
    
    the scale factor as big decimal with scale zero.
  - getMaxIntegerValue
```
public final long getMaxIntegerValue()
```
    Description copied from interface: ScaleMetrics
    
    Returns the largest integer value that can be represented using this scale.
    
    Specified by:
    
    getMaxIntegerValue in interface ScaleMetrics
    
    Returns:
    
    Long.MAX_VALUE / scaleFactor
  - getMinIntegerValue
```
public final long getMinIntegerValue()
```
    Description copied from interface: ScaleMetrics
    
    Returns the smallest integer value that can be represented using this scale.
    
    Specified by:
    
    getMinIntegerValue in interface ScaleMetrics
    
    Returns:
    
    Long.MIN_VALUE / scaleFactor
  - isValidIntegerValue
```
public final boolean isValidIntegerValue(long value)
```
    Description copied from interface: ScaleMetrics
    
    Returns true if the specified integer value can be represented using this scale.
    
    Specified by:
    
    isValidIntegerValue in interface ScaleMetrics
    
    Parameters:
    
    value - the value to test
    
    Returns:
    
    true if (Long.MIN_VALUE / scaleFactor) <= value <= (Long.MAX_VALUE / scaleFactor)
  - multiplyByScaleFactorExact
```
public final long multiplyByScaleFactorExact(long factor)
```
    Description copied from interface: ScaleMetrics
    
    Returns factor*scaleFactor, checking for lost information. If the result is out of the range of the long type, then an ArithmeticException is thrown.
    
    Specified by:
    
    multiplyByScaleFactorExact in interface ScaleMetrics
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*scaleFactor
  - mulloByScaleFactor
```
public final long mulloByScaleFactor(int factor)
```
    Description copied from interface: ScaleMetrics
    
    Returns factor*low32(scaleFactor) where low32 refers to the low 32 bits of the factor.
    
    Specified by:
    
    mulloByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*low32(scaleFactor)
  - mulhiByScaleFactor
```
public final long mulhiByScaleFactor(int factor)
```
    Description copied from interface: ScaleMetrics
    
    Returns factor*high32(scaleFactor) where high32 refers to the high 32 bits of the factor.
    
    Specified by:
    
    mulhiByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*high32(scaleFactor)
  - divideByScaleFactor
```
public final long divideByScaleFactor(long dividend)
```
    Description copied from interface: ScaleMetrics
    
    Returns dividend/scaleFactor.
    
    Specified by:
    
    divideByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    dividend - the dividend
    
    Returns:
    
    dividend/scaleFactor
  - divideUnsignedByScaleFactor
```
public final long divideUnsignedByScaleFactor(long unsignedDividend)
```
    Description copied from interface: ScaleMetrics
    
    Returns unsignedDividend/scaleFactor using unsigned division.
    
    Specified by:
    
    divideUnsignedByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    unsignedDividend - the unsigned dividend
    
    Returns:
    
    unsignedDividend/scaleFactor
  - moduloByScaleFactor
```
public final long moduloByScaleFactor(long dividend)
```
    Description copied from interface: ScaleMetrics
    
    Returns dividend % scaleFactor also known as reminder.
    
    Specified by:
    
    moduloByScaleFactor in interface ScaleMetrics
    
    Parameters:
    
    dividend - the dividend
    
    Returns:
    
    dividend % scaleFactor
  - toString
```
public final String toString(long value)
```
    Description copied from interface: ScaleMetrics
    
    Returns the string representation of the specified value applying this metric's scale.
    
    Specified by:
    
    toString in interface ScaleMetrics
    
    Parameters:
    
    value - the unscaled decimal to convert to a string
    
    Returns:
    
    a fixed-point string representation of the specified value
    
    See Also:
    
    DecimalArithmetic.toString(long)
  - getDefaultArithmetic
```
public final DecimalArithmetic getDefaultArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the default arithmetic for this scale performing unchecked operations with rounding mode HALF_UP.
    
    Specified by:
    
    getDefaultArithmetic in interface ScaleMetrics
    
    Returns:
    
    default arithmetic for this scale rounding HALF_UP without overflow checks
  - getDefaultCheckedArithmetic
```
public final DecimalArithmetic getDefaultCheckedArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the default arithmetic for this scale performing checked operations with rounding mode HALF_UP.
    
    Specified by:
    
    getDefaultCheckedArithmetic in interface ScaleMetrics
    
    Returns:
    
    default arithmetic for this scale rounding HALF_UP with overflow checks
  - getRoundingDownArithmetic
```
public final DecimalArithmetic getRoundingDownArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale performing unchecked operations with rounding mode DOWN.
    
    Specified by:
    
    getRoundingDownArithmetic in interface ScaleMetrics
    
    Returns:
    
    arithmetic for this scale rounding DOWN without overflow checks
  - getRoundingFloorArithmetic
```
public final DecimalArithmetic getRoundingFloorArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale performing unchecked operations with rounding mode FLOOR.
    
    Specified by:
    
    getRoundingFloorArithmetic in interface ScaleMetrics
    
    Returns:
    
    arithmetic for this scale rounding FLOOR without overflow checks
  - getRoundingHalfEvenArithmetic
```
public final DecimalArithmetic getRoundingHalfEvenArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale performing unchecked operations with rounding mode HALF_EVEN.
    
    Specified by:
    
    getRoundingHalfEvenArithmetic in interface ScaleMetrics
    
    Returns:
    
    arithmetic for this scale rounding HALF_EVEN without overflow checks
  - getRoundingUnnecessaryArithmetic
```
public final DecimalArithmetic getRoundingUnnecessaryArithmetic()
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale performing unchecked operations with rounding mode UNNECESSARY.
    
    Specified by:
    
    getRoundingUnnecessaryArithmetic in interface ScaleMetrics
    
    Returns:
    
    default arithmetic for this scale for rounding UNNECESSARY mode without overflow checks
  - getArithmetic
```
public final DecimalArithmetic getArithmetic(RoundingMode roundingMode)
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale that performs all operations with the specified roundingMode and without overflow checks.
    
    Specified by:
    
    getArithmetic in interface ScaleMetrics
    
    Parameters:
    
    roundingMode - the rounding mode used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified rounding mode and without overflow checks
  - getCheckedArithmetic
```
public final DecimalArithmetic getCheckedArithmetic(RoundingMode roundingMode)
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale that performs all operations with the specified roundingMode and with overflow checks.
    
    Specified by:
    
    getCheckedArithmetic in interface ScaleMetrics
    
    Parameters:
    
    roundingMode - the rounding mode used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified rounding mode and with overflow checks
  - getArithmetic
```
public final DecimalArithmetic getArithmetic(TruncationPolicy truncationPolicy)
```
    Description copied from interface: ScaleMetrics
    
    Returns the arithmetic for this scale that performs all operations with the specified truncationPolicy.
    
    Specified by:
    
    getArithmetic in interface ScaleMetrics
    
    Parameters:
    
    truncationPolicy - the truncation policy used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified truncation policy
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Enum<Scale17f>

Enum Scale17f

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INSTANCE

Field Detail

SCALE

SCALE_FACTOR

Method Detail

values

valueOf

getScale

getScaleFactor

getScaleFactorNumberOfLeadingZeros

multiplyByScaleFactor

getScaleFactorAsBigInteger

getScaleFactorAsBigDecimal

getMaxIntegerValue

getMinIntegerValue

isValidIntegerValue

multiplyByScaleFactorExact

mulloByScaleFactor

mulhiByScaleFactor

divideByScaleFactor

divideUnsignedByScaleFactor

moduloByScaleFactor

toString

getDefaultArithmetic

getDefaultCheckedArithmetic

getRoundingDownArithmetic

getRoundingFloorArithmetic

getRoundingHalfEvenArithmetic

getRoundingUnnecessaryArithmetic

getArithmetic

getCheckedArithmetic

getArithmetic

toString