org.decimal4j.arithmetic

Class Div

java.lang.Object

org.decimal4j.arithmetic.Div

final class Div
extends Object

Provides static methods to calculate division results.

Method Summary

Modifier and Type	Method and Description
(package private) static long	div128by64(DecimalRounding rounding, boolean neg, long u1, long u0, long v0) PRECONDITION: Unsigned.isLess(u1, v0)
static long	divide(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalDividend, long uDecimalDivisor) Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor with rounding and without overflow checks.
static long	divide(DecimalArithmetic arith, long uDecimalDividend, long uDecimalDivisor) Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor without rounding and overflow checks.
static long	divideByLong(DecimalRounding rounding, long uDecimalDividend, long lDivisor) Calculates unchecked division by a long value with rounding.
static long	divideByLongChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalDividend, long lDivisor) Calculates checked division by a long value with rounding.
static long	divideByUnscaled(DecimalRounding rounding, long uDecimalDividend, long unscaledDivisor, int scale) Calculates unchecked division by an unscaled value with the given scale without rounding.
static long	divideByUnscaled(long uDecimalDividend, long unscaledDivisor, int scale) Calculates unchecked division by an unscaled value with the given scale without rounding and overflow checks.
static long	divideByUnscaledChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalDividend, long unscaledDivisor, int scale) Calculates unchecked division by an unscaled value with the given scale without rounding and with overflow checks.
static long	divideByUnscaledChecked(DecimalArithmetic arith, long uDecimalDividend, long unscaledDivisor, int scale) Calculates unchecked division by an unscaled value with the given scale without rounding and with overflow checks.
static long	divideChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalDividend, long uDecimalDivisor) Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor with rounding and with overflow checks.
static long	divideChecked(DecimalArithmetic arith, long uDecimalDividend, long uDecimalDivisor) Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor without rounding and with overflow checks.

Methods inherited from class java.lang.Object

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

Method Detail

divideByLong

public static final long divideByLong(DecimalRounding rounding,
                                      long uDecimalDividend,
                                      long lDivisor)

Calculates unchecked division by a long value with rounding.

Parameters:

rounding - the decimal rounding to apply if rounding is necessary

uDecimalDividend - the unscaled decimal dividend

lDivisor - the long divisor

Returns:

the division result with rounding and no overflow checks

divideByLongChecked

public static final long divideByLongChecked(DecimalArithmetic arith,
                                             DecimalRounding rounding,
                                             long uDecimalDividend,
                                             long lDivisor)

Calculates checked division by a long value with rounding.

Parameters:

arith - the arithmetic used to format numbers when throwing exceptions

rounding - the decimal rounding to apply if rounding is necessary

uDecimalDividend - the unscaled decimal dividend

lDivisor - the long divisor

Returns:

the division result with rounding and overflow checks

divide

public static final long divide(DecimalArithmetic arith,
                                long uDecimalDividend,
                                long uDecimalDivisor)

Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor without rounding and overflow checks.

Parameters:

arith - the arithmetic with scale metrics and overflow mode

uDecimalDividend - the unscaled decimal dividend

uDecimalDivisor - the unscaled decimal divisor

Returns:

the division result without rounding and without overflow checks.

divideByUnscaled

public static final long divideByUnscaled(long uDecimalDividend,
                                          long unscaledDivisor,
                                          int scale)

Calculates unchecked division by an unscaled value with the given scale without rounding and overflow checks.

Parameters:

uDecimalDividend - the unscaled decimal dividend

unscaledDivisor - the long divisor

scale - the scale of the divisor

Returns:

the division result without rounding and without overflow checks

divide

public static final long divide(DecimalArithmetic arith,
                                DecimalRounding rounding,
                                long uDecimalDividend,
                                long uDecimalDivisor)

Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor with rounding and without overflow checks.

Parameters:

arith - the arithmetic with scale metrics and overflow mode

rounding - the decimal rounding to apply if rounding is necessary

uDecimalDividend - the unscaled decimal dividend

uDecimalDivisor - the unscaled decimal divisor

Returns:

the division result with rounding and without overflow checks

divideByUnscaled

public static final long divideByUnscaled(DecimalRounding rounding,
                                          long uDecimalDividend,
                                          long unscaledDivisor,
                                          int scale)

Calculates unchecked division by an unscaled value with the given scale without rounding.

Parameters:

rounding - the rounding to apply

uDecimalDividend - the unscaled decimal dividend

unscaledDivisor - the long divisor

scale - the scale of the divisor

Returns:

the division result without rounding and without overflow checks

divideChecked

public static final long divideChecked(DecimalArithmetic arith,
                                       long uDecimalDividend,
                                       long uDecimalDivisor)

Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor without rounding and with overflow checks.

Parameters:

arith - the arithmetic with scale metrics and overflow mode

uDecimalDividend - the unscaled decimal dividend

uDecimalDivisor - the unscaled decimal divisor

Returns:

the division result without rounding and with overflow checks

divideByUnscaledChecked

public static final long divideByUnscaledChecked(DecimalArithmetic arith,
                                                 long uDecimalDividend,
                                                 long unscaledDivisor,
                                                 int scale)

Calculates unchecked division by an unscaled value with the given scale without rounding and with overflow checks.

Parameters:

arith - the arithmetic associated with the dividend

uDecimalDividend - the unscaled decimal dividend

unscaledDivisor - the long divisor

scale - the scale of the divisor

Returns:

the division result without rounding and with overflow checks

divideChecked

public static final long divideChecked(DecimalArithmetic arith,
                                       DecimalRounding rounding,
                                       long uDecimalDividend,
                                       long uDecimalDivisor)

Calculates (uDecimalDividend * scaleFactor) / uDecimalDivisor with rounding and with overflow checks.

Parameters:

arith - the arithmetic with scale metrics and overflow mode

rounding - the decimal rounding to apply if rounding is necessary

uDecimalDividend - the unscaled decimal dividend

uDecimalDivisor - the unscaled decimal divisor

Returns:

the division result with rounding and with overflow checks

divideByUnscaledChecked

public static final long divideByUnscaledChecked(DecimalArithmetic arith,
                                                 DecimalRounding rounding,
                                                 long uDecimalDividend,
                                                 long unscaledDivisor,
                                                 int scale)

Calculates unchecked division by an unscaled value with the given scale without rounding and with overflow checks.

Parameters:

arith - the arithmetic associated with the dividend

rounding - the ronuding to apply

uDecimalDividend - the unscaled decimal dividend

unscaledDivisor - the long divisor

scale - the scale of the divisor

Returns:

the division result without rounding and with overflow checks

div128by64

static final long div128by64(DecimalRounding rounding,
                             boolean neg,
                             long u1,
                             long u0,
                             long v0)

PRECONDITION: Unsigned.isLess(u1, v0)

Divides a 128 bit divisor by a 64 bit dividend and returns the signed 64 bit result. Rounding is applied if rounding != null, otherwise the value is truncated.

From www.codeproject.com.

Parameters:

neg - true if result is negative

u1 - high order 64 bits of dividend

u0 - low order 64 bits of dividend

v0 - 64 bit divisor

rounding - rounding to apply, or null to truncate result

Returns:

the signed quotient, rounded if rounding != null