org.decimal4j.arithmetic

Class Pow10

java.lang.Object

org.decimal4j.arithmetic.Pow10

final class Pow10
extends Object

Contains methods for multiplications and divisions with powers of ten.

Method Summary

Methods

Modifier and Type	Method and Description
static long	divideByPowerOf10(DecimalRounding rounding, long uDecimal, int n) Divides the given value by a power of 10 rounding the result if necessary.
(package private) static long	divideByPowerOf10(DecimalRounding rounding, long uDecimalDividend, ScaleMetrics dividendMetrics, boolean pow10divisorIsPositive, ScaleMetrics pow10divisorMetrics) Divides the specified dividend by a power of ten rounding the result if necessary.
static long	divideByPowerOf10(long uDecimal, int n) Divides the given value by a power of 10 truncating the result if necessary.
(package private) static long	divideByPowerOf10(long uDecimalDividend, ScaleMetrics dividendMetrics, boolean pow10divisorIsPositive, ScaleMetrics pow10divisorMetrics) Divides the specified dividend by a power of ten truncating the result if necessary.
static long	divideByPowerOf10Checked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal, int n) Divides the given value by a power of 10 rounding the result if necessary.
(package private) static long	divideByPowerOf10Checked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalDividend, ScaleMetrics dividendMetrics, boolean pow10divisorIsPositive, ScaleMetrics pow10divisorMetrics) Divides the specified dividend by a power of ten rounding the result if necessary.
static long	divideByPowerOf10Checked(DecimalArithmetic arith, long uDecimal, int n) Divides the given value by a power of 10 truncating the result if necessary.
(package private) static long	divideByPowerOf10Checked(DecimalArithmetic arith, long uDecimalDividend, ScaleMetrics dividendMetrics, boolean pow10divisorIsPositive, ScaleMetrics pow10divisorMetrics) Divides the specified dividend by a power of ten truncating the result if necessary.
static long	multiplyByPowerOf10(DecimalRounding rounding, long uDecimal, int n) Calculates the multiple by a power of 10 rounding the result if necessary for negative n.
static long	multiplyByPowerOf10(long uDecimal, int n) Calculates the multiple by a power of 10 truncating the result if necessary for negative n.
static long	multiplyByPowerOf10Checked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal, int n) Calculates the multiple by a power of 10 rounding the result if necessary for negative n.
static long	multiplyByPowerOf10Checked(DecimalArithmetic arith, long uDecimal, int n) Calculates the multiple by a power of 10 truncating the result if necessary for negative n.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

multiplyByPowerOf10

public static final long multiplyByPowerOf10(long uDecimal,
                       int n)

Calculates the multiple by a power of 10 truncating the result if necessary for negative n. Overflows are silently truncated.

Parameters:

uDecimal - the value to multiply

n - the power-ten exponent

Returns:

round_DOWN(uDecimal * 10ⁿ)

multiplyByPowerOf10

public static final long multiplyByPowerOf10(DecimalRounding rounding,
                       long uDecimal,
                       int n)

Calculates the multiple by a power of 10 rounding the result if necessary for negative n. Overflows are silently truncated.

Parameters:

rounding - the rounding to apply if necessary

uDecimal - the value to multiply

n - the power-ten exponent

Returns:

round(uDecimal * 10ⁿ)

multiplyByPowerOf10Checked

public static final long multiplyByPowerOf10Checked(DecimalArithmetic arith,
                              long uDecimal,
                              int n)

Calculates the multiple by a power of 10 truncating the result if necessary for negative n. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

uDecimal - the value to multiply

n - the power-ten exponent

Returns:

round_DOWN(uDecimal * 10ⁿ)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

multiplyByPowerOf10Checked

public static final long multiplyByPowerOf10Checked(DecimalArithmetic arith,
                              DecimalRounding rounding,
                              long uDecimal,
                              int n)

Calculates the multiple by a power of 10 rounding the result if necessary for negative n. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply if necessary

uDecimal - the value to multiply

n - the power-ten exponent

Returns:

round(uDecimal * 10ⁿ)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

divideByPowerOf10

public static final long divideByPowerOf10(long uDecimal,
                     int n)

Divides the given value by a power of 10 truncating the result if necessary. Overflows are silently truncated.

Parameters:

uDecimal - the value to divide

n - the power-ten exponent

Returns:

round_DOWN(uDecimal / 10ⁿ)

divideByPowerOf10

public static final long divideByPowerOf10(DecimalRounding rounding,
                     long uDecimal,
                     int n)

Divides the given value by a power of 10 rounding the result if necessary. Overflows are silently truncated.

Parameters:

rounding - the rounding to apply if necessary

uDecimal - the value to divide

n - the power-ten exponent

Returns:

round(uDecimal / 10ⁿ)

divideByPowerOf10Checked

public static final long divideByPowerOf10Checked(DecimalArithmetic arith,
                            long uDecimal,
                            int n)

Divides the given value by a power of 10 truncating the result if necessary. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

uDecimal - the value to divide

n - the power-ten exponent

Returns:

round_DOWN(uDecimal / 10ⁿ)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

divideByPowerOf10Checked

public static final long divideByPowerOf10Checked(DecimalArithmetic arith,
                            DecimalRounding rounding,
                            long uDecimal,
                            int n)

Divides the given value by a power of 10 rounding the result if necessary. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the value

rounding - the rounding to apply if necessary

uDecimal - the value to divide

n - the power-ten exponent

Returns:

round(uDecimal / 10ⁿ)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

divideByPowerOf10

static final long divideByPowerOf10(long uDecimalDividend,
                     ScaleMetrics dividendMetrics,
                     boolean pow10divisorIsPositive,
                     ScaleMetrics pow10divisorMetrics)

Divides the specified dividend by a power of ten truncating the result if necessary. Overflows are silently truncated.

Parameters:

uDecimalDividend - the dividend to divide

dividendMetrics - the arithmetics associated with the dividend

pow10divisorIsPositive - true if the divisor is positive

pow10divisorMetrics - the metrics reflecting the power-ten-division

Returns:

round_DOWN(uDecimalDividend / 10^{(scale - scale10)}) where scale is the scale of the dividend and scale10 is the exponent of the power-ten divisor (negated if pow10divisorIsPositive==false)

divideByPowerOf10

static final long divideByPowerOf10(DecimalRounding rounding,
                     long uDecimalDividend,
                     ScaleMetrics dividendMetrics,
                     boolean pow10divisorIsPositive,
                     ScaleMetrics pow10divisorMetrics)

Divides the specified dividend by a power of ten rounding the result if necessary. Overflows are silently truncated.

Parameters:

rounding - the rounding to apply if rounding is necessary

uDecimalDividend - the dividend to divide

dividendMetrics - the arithmetics associated with the dividend

pow10divisorIsPositive - true if the divisor is positive

pow10divisorMetrics - the metrics reflecting the power-ten-division

Returns:

round(uDecimalDividend / 10^{(scale - scale10)}) where scale is the scale of the dividend and scale10 is the exponent of the power-ten divisor (negated if pow10divisorIsPositive==false)

divideByPowerOf10Checked

static final long divideByPowerOf10Checked(DecimalArithmetic arith,
                            long uDecimalDividend,
                            ScaleMetrics dividendMetrics,
                            boolean pow10divisorIsPositive,
                            ScaleMetrics pow10divisorMetrics)

Divides the specified dividend by a power of ten truncating the result if necessary. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the dividend value

uDecimalDividend - the dividend to divide

dividendMetrics - the arithmetics associated with the dividend

pow10divisorIsPositive - true if the divisor is positive

pow10divisorMetrics - the metrics reflecting the power-ten-division

Returns:

round_DOWN(uDecimalDividend / 10^{(scale - scale10)}) where scale is the scale of the dividend and scale10 is the exponent of the power-ten divisor (negated if pow10divisorIsPositive==false)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

divideByPowerOf10Checked

static final long divideByPowerOf10Checked(DecimalArithmetic arith,
                            DecimalRounding rounding,
                            long uDecimalDividend,
                            ScaleMetrics dividendMetrics,
                            boolean pow10divisorIsPositive,
                            ScaleMetrics pow10divisorMetrics)

Divides the specified dividend by a power of ten rounding the result if necessary. An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with the dividend value

rounding - the rounding to apply if rounding is necessary

uDecimalDividend - the dividend to divide

dividendMetrics - the arithmetics associated with the dividend

pow10divisorIsPositive - true if the divisor is positive

pow10divisorMetrics - the metrics reflecting the power-ten-division

Returns:

round(uDecimalDividend / 10^{(scale - scale10)}) where scale is the scale of the dividend and scale10 is the exponent of the power-ten divisor (negated if pow10divisorIsPositive==false)

Throws:

ArithmeticException - if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception