ScaleMetrics (decimal4j API 1.0.7-SNAPSHOT)

All Known Implementing Classes:

Scale0f, Scale10f, Scale11f, Scale12f, Scale13f, Scale14f, Scale15f, Scale16f, Scale17f, Scale18f, Scale1f, Scale2f, Scale3f, Scale4f, Scale5f, Scale6f, Scale7f, Scale8f, Scale9f
```
public interface ScaleMetrics
```
ScaleMetrics defines various metrics associated with the scale of a Decimal number. It is mainly used internally from code implementing the arithmetic operations of a Decimal.
The scale determines the number of fraction digits of the Decimal. The scale factor is the multiplier/divisor for conversions between the Decimal value and the unscaled long value underlying every Decimal.
Operations such as multiplyByScaleFactor(..) are defined here as separate methods to allow for compiler optimizations. Multiplications and divisions are for instance translated into shifts and adds by the compiler instead of the more expensive multiplication and division operations with non-constant long values.
ScaleMetrics also provides access to DecimalArithmetic instances for different rounding modes and overflow policies. DecimalArithmetic objects can be used to deal with Decimal numbers in their primitive form, meaning that Decimal numbers are passed to the arithmetic class as unscaled long values.

Method Summary

All Methods Instance Methods Abstract 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(long value)` Returns the string representation of the specified `value` applying this metric's scale.

- Method Detail
  - getScale
```
int getScale()
```
    Returns the scale, the number of fraction digits to the right of the decimal point of a Decimal value.
    
    Returns:
    
    the scale also known as number of fraction digits
  - getScaleFactor
```
long getScaleFactor()
```
    Returns the scale factor, which is 10^f where f stands for the scale.
    
    Returns:
    
    the scale factor
  - getScaleFactorAsBigInteger
```
BigInteger getScaleFactorAsBigInteger()
```
    Returns the scale factor as a BigInteger value.
    
    Returns:
    
    the scale factor as big integer
  - getScaleFactorAsBigDecimal
```
BigDecimal getScaleFactorAsBigDecimal()
```
    Returns the scale factor as a BigDecimal value with scale zero.
    
    Returns:
    
    the scale factor as big decimal with scale zero.
  - getScaleFactorNumberOfLeadingZeros
```
int getScaleFactorNumberOfLeadingZeros()
```
    Returns the number of leading zeros of the scale factor
    
    Returns:
    
    Long.numberOfLeadingZeros(long) applied to the scale factor
  - getMaxIntegerValue
```
long getMaxIntegerValue()
```
    Returns the largest integer value that can be represented using this scale.
    
    Returns:
    
    Long.MAX_VALUE / scaleFactor
  - getMinIntegerValue
```
long getMinIntegerValue()
```
    Returns the smallest integer value that can be represented using this scale.
    
    Returns:
    
    Long.MIN_VALUE / scaleFactor
  - isValidIntegerValue
```
boolean isValidIntegerValue(long value)
```
    Returns true if the specified integer value can be represented using this scale.
    
    Parameters:
    
    value - the value to test
    
    Returns:
    
    true if (Long.MIN_VALUE / scaleFactor) <= value <= (Long.MAX_VALUE / scaleFactor)
  - multiplyByScaleFactor
```
long multiplyByScaleFactor(long factor)
```
    Returns factor*scaleFactor.
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*scaleFactor
  - multiplyByScaleFactorExact
```
long multiplyByScaleFactorExact(long factor)
```
    Returns factor*scaleFactor, checking for lost information. If the result is out of the range of the long type, then an ArithmeticException is thrown.
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*scaleFactor
    
    Throws:
    
    ArithmeticException - if an overflow occurs
  - mulloByScaleFactor
```
long mulloByScaleFactor(int factor)
```
    Returns factor*low32(scaleFactor) where low32 refers to the low 32 bits of the factor.
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*low32(scaleFactor)
  - mulhiByScaleFactor
```
long mulhiByScaleFactor(int factor)
```
    Returns factor*high32(scaleFactor) where high32 refers to the high 32 bits of the factor.
    
    Parameters:
    
    factor - the factor
    
    Returns:
    
    factor*high32(scaleFactor)
  - divideByScaleFactor
```
long divideByScaleFactor(long dividend)
```
    Returns dividend/scaleFactor.
    
    Parameters:
    
    dividend - the dividend
    
    Returns:
    
    dividend/scaleFactor
  - divideUnsignedByScaleFactor
```
long divideUnsignedByScaleFactor(long unsignedDividend)
```
    Returns unsignedDividend/scaleFactor using unsigned division.
    
    Parameters:
    
    unsignedDividend - the unsigned dividend
    
    Returns:
    
    unsignedDividend/scaleFactor
  - moduloByScaleFactor
```
long moduloByScaleFactor(long dividend)
```
    Returns dividend % scaleFactor also known as reminder.
    
    Parameters:
    
    dividend - the dividend
    
    Returns:
    
    dividend % scaleFactor
  - toString
```
String toString(long value)
```
    Returns the string representation of the specified value applying this metric's scale.
    
    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
```
DecimalArithmetic getDefaultArithmetic()
```
    Returns the default arithmetic for this scale performing unchecked operations with rounding mode HALF_UP.
    
    Returns:
    
    default arithmetic for this scale rounding HALF_UP without overflow checks
  - getDefaultCheckedArithmetic
```
DecimalArithmetic getDefaultCheckedArithmetic()
```
    Returns the default arithmetic for this scale performing checked operations with rounding mode HALF_UP.
    
    Returns:
    
    default arithmetic for this scale rounding HALF_UP with overflow checks
  - getRoundingDownArithmetic
```
DecimalArithmetic getRoundingDownArithmetic()
```
    Returns the arithmetic for this scale performing unchecked operations with rounding mode DOWN.
    
    Returns:
    
    arithmetic for this scale rounding DOWN without overflow checks
  - getRoundingFloorArithmetic
```
DecimalArithmetic getRoundingFloorArithmetic()
```
    Returns the arithmetic for this scale performing unchecked operations with rounding mode FLOOR.
    
    Returns:
    
    arithmetic for this scale rounding FLOOR without overflow checks
  - getRoundingHalfEvenArithmetic
```
DecimalArithmetic getRoundingHalfEvenArithmetic()
```
    Returns the arithmetic for this scale performing unchecked operations with rounding mode HALF_EVEN.
    
    Returns:
    
    arithmetic for this scale rounding HALF_EVEN without overflow checks
  - getRoundingUnnecessaryArithmetic
```
DecimalArithmetic getRoundingUnnecessaryArithmetic()
```
    Returns the arithmetic for this scale performing unchecked operations with rounding mode UNNECESSARY.
    
    Returns:
    
    default arithmetic for this scale for rounding UNNECESSARY mode without overflow checks
  - getArithmetic
```
DecimalArithmetic getArithmetic(RoundingMode roundingMode)
```
    Returns the arithmetic for this scale that performs all operations with the specified roundingMode and without overflow checks.
    
    Parameters:
    
    roundingMode - the rounding mode used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified rounding mode and without overflow checks
  - getCheckedArithmetic
```
DecimalArithmetic getCheckedArithmetic(RoundingMode roundingMode)
```
    Returns the arithmetic for this scale that performs all operations with the specified roundingMode and with overflow checks.
    
    Parameters:
    
    roundingMode - the rounding mode used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified rounding mode and with overflow checks
  - getArithmetic
```
DecimalArithmetic getArithmetic(TruncationPolicy truncationPolicy)
```
    Returns the arithmetic for this scale that performs all operations with the specified truncationPolicy.
    
    Parameters:
    
    truncationPolicy - the truncation policy used by the returned arithmetic
    
    Returns:
    
    arithmetic for this scale with specified truncation policy

Interface ScaleMetrics

Method Summary

Method Detail

getScale

getScaleFactor

getScaleFactorAsBigInteger

getScaleFactorAsBigDecimal

getScaleFactorNumberOfLeadingZeros

getMaxIntegerValue

getMinIntegerValue

isValidIntegerValue

multiplyByScaleFactor

multiplyByScaleFactorExact

mulloByScaleFactor

mulhiByScaleFactor

divideByScaleFactor

divideUnsignedByScaleFactor

moduloByScaleFactor

toString

getDefaultArithmetic

getDefaultCheckedArithmetic

getRoundingDownArithmetic

getRoundingFloorArithmetic

getRoundingHalfEvenArithmetic

getRoundingUnnecessaryArithmetic

getArithmetic

getCheckedArithmetic

getArithmetic