org.decimal4j.arithmetic

Class Mul

java.lang.Object

org.decimal4j.arithmetic.Mul

final class Mul
extends Object

Provides methods to calculate multiplication results.

Method Summary

Modifier and Type	Method and Description
static long	multiply(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal1, long uDecimal2) Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor applying the specified rounding if necessary.
static long	multiply(DecimalArithmetic arith, long uDecimal1, long uDecimal2) Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor without rounding.
static long	multiplyByUnscaled(DecimalRounding rounding, long uDecimal, long unscaled, int scale) Calculates unchecked multiplication by an unscaled value with the given scale with rounding.
static long	multiplyByUnscaled(long uDecimal, long unscaled, int scale) Calculates unchecked multiplication by an unscaled value with the given scale without rounding.
static long	multiplyByUnscaledChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal, long unscaled, int scale) Calculates checked multiplication by an unscaled value with the given scale with rounding.
static long	multiplyByUnscaledChecked(DecimalArithmetic arith, long uDecimal, long unscaled, int scale) Calculates checked multiplication by an unscaled value with the given scale without rounding.
static long	multiplyChecked(DecimalArithmetic arith, DecimalRounding rounding, long uDecimal1, long uDecimal2) Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor with rounding.
static long	multiplyChecked(DecimalArithmetic arith, long uDecimal1, long uDecimal2) Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor without rounding checking for overflows.

Methods inherited from class java.lang.Object

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

Method Detail

multiply

public static final long multiply(DecimalArithmetic arith,
                                  long uDecimal1,
                                  long uDecimal2)

Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor without rounding.

Parameters:

arith - the arithmetic with access to scale metrics etc.

uDecimal1 - the first unscaled decimal factor

uDecimal2 - the second unscaled decimal factor

Returns:

the multiplication result without rounding

multiplyByUnscaled

public static final long multiplyByUnscaled(long uDecimal,
                                            long unscaled,
                                            int scale)

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

Parameters:

uDecimal - the unscaled decimal factor

unscaled - the second unscaled factor

scale - the scale of the second factor

Returns:

the multiplication result without rounding and without overflow checks

multiply

public static final long multiply(DecimalArithmetic arith,
                                  DecimalRounding rounding,
                                  long uDecimal1,
                                  long uDecimal2)

Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor applying the specified rounding if necessary.

Parameters:

arith - the arithmetic with access to scale metrics etc.

rounding - the rounding to apply if necessary

uDecimal1 - the first unscaled decimal factor

uDecimal2 - the second unscaled decimal factor

Returns:

the multiplication result with rounding

multiplyByUnscaled

public static final long multiplyByUnscaled(DecimalRounding rounding,
                                            long uDecimal,
                                            long unscaled,
                                            int scale)

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

Parameters:

rounding - the rounding to apply

uDecimal - the unscaled decimal factor

unscaled - the second unscaled factor

scale - the scale of the second factor

Returns:

the multiplication result with rounding and without overflow checks

multiplyChecked

public static final long multiplyChecked(DecimalArithmetic arith,
                                         long uDecimal1,
                                         long uDecimal2)

Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor without rounding checking for overflows.

Parameters:

arith - the arithmetic with access to scale metrics etc.

uDecimal1 - the first unscaled decimal factor

uDecimal2 - the second unscaled decimal factor

Returns:

the multiplication result without rounding and with overflow checks

multiplyByUnscaledChecked

public static final long multiplyByUnscaledChecked(DecimalArithmetic arith,
                                                   long uDecimal,
                                                   long unscaled,
                                                   int scale)

Calculates checked multiplication by an unscaled value with the given scale without rounding.

Parameters:

arith - the decimal arithmetics associated with the first factor

uDecimal - the unscaled decimal factor

unscaled - the second unscaled factor

scale - the scale of the second factor

Returns:

the multiplication result without rounding and with overflow checks

multiplyChecked

public static final long multiplyChecked(DecimalArithmetic arith,
                                         DecimalRounding rounding,
                                         long uDecimal1,
                                         long uDecimal2)

Calculates the multiple uDecimal1 * uDecimal2 / scaleFactor with rounding.

Parameters:

arith - the arithmetic with access to scale metrics etc.

rounding - the rounding to apply for truncated decimals

uDecimal1 - the first unscaled decimal factor

uDecimal2 - the second unscaled decimal factor

Returns:

the multiplication result with rounding and overflow checking

multiplyByUnscaledChecked

public static final long multiplyByUnscaledChecked(DecimalArithmetic arith,
                                                   DecimalRounding rounding,
                                                   long uDecimal,
                                                   long unscaled,
                                                   int scale)

Calculates checked multiplication by an unscaled value with the given scale with rounding.

Parameters:

arith - the arithmetics associated with uDecimal

rounding - the rounding to apply

uDecimal - the unscaled decimal factor

unscaled - the second unscaled factor

scale - the scale of the second factor

Returns:

the multiplication result with rounding and overflow checks