org.decimal4j.arithmetic

Class AbstractArithmetic

java.lang.Object

org.decimal4j.arithmetic.AbstractArithmetic

All Implemented Interfaces:

DecimalArithmetic

Direct Known Subclasses:

AbstractCheckedArithmetic, AbstractUncheckedArithmetic

public abstract class AbstractArithmetic
extends Object
implements DecimalArithmetic

Base class for all arithmetic implementations providing operations which are common irrespective of scale, rounding mode and overflow mode.

Constructor Summary

Constructors

Constructor and Description
AbstractArithmetic()

Method Summary

Modifier and Type	Method and Description
int	compare(long uDecimal1, long uDecimal2) Compares two unscaled decimal values numerically.
int	compareToUnscaled(long uDecimal, long unscaled, int scale) Compares two unscaled decimal values numerically.
DecimalArithmetic	deriveArithmetic(int scale) Derives an arithmetic instance for the specified scale using this arithmetic's rounding mode and overflow mode.
DecimalArithmetic	deriveArithmetic(OverflowMode overflowMode) Derives an arithmetic instance for the same scale as this arithmetic but for the specified overflowMode.
DecimalArithmetic	deriveArithmetic(RoundingMode roundingMode) Derives an arithmetic instance for the same scale as this arithmetic but for the specified roundingMode.
DecimalArithmetic	deriveArithmetic(RoundingMode roundingMode, OverflowMode overflowMode) Derives an arithmetic instance for the same scale as this arithmetic but for the specified roundingMode and overflowMode.
DecimalArithmetic	deriveArithmetic(TruncationPolicy truncationPolicy) Derives an arithmetic instance for the same scale as this arithmetic but with rounding and overflow mode specified by the given truncationPolicy.
long	fromBigInteger(BigInteger value) Converts the specified BigInteger value to an unscaled decimal.
int	signum(long uDecimal) Returns the signum function of the specified unscaled decimal.
BigDecimal	toBigDecimal(long uDecimal) Converts the specified unscaled decimal value into a BigDecimal value using this arithmetic's scale for the result value.
BigDecimal	toBigDecimal(long uDecimal, int scale) Converts the specified unscaled decimal value into a BigDecimal value using the specified scale for the result value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.decimal4j.api.DecimalArithmetic

abs, add, addLong, addUnscaled, avg, divide, divideByLong, divideByPowerOf10, divideByUnscaled, fromBigDecimal, fromDouble, fromFloat, fromLong, fromUnscaled, getOverflowMode, getRoundingMode, getScale, getScaleMetrics, getTruncationPolicy, invert, multiply, multiplyByLong, multiplyByPowerOf10, multiplyByUnscaled, negate, one, parse, parse, pow, round, shiftLeft, shiftRight, sqrt, square, subtract, subtractLong, subtractUnscaled, toDouble, toFloat, toLong, toString, toString, toUnscaled

Constructor Detail

AbstractArithmetic

public AbstractArithmetic()

Method Detail

deriveArithmetic

public final DecimalArithmetic deriveArithmetic(int scale)

Description copied from interface: DecimalArithmetic

Derives an arithmetic instance for the specified scale using this arithmetic's rounding mode and overflow mode.

Specified by:

deriveArithmetic in interface DecimalArithmetic

Parameters:

scale - the scale for the new arithmetic; must be in [0,18] both ends inclusive

Returns:

an arithmetic instance with the given scale and this arithmetic's rounding and overflow mode

See Also:

Scales.getScaleMetrics(int), ScaleMetrics.getArithmetic(RoundingMode), ScaleMetrics.getArithmetic(TruncationPolicy)

deriveArithmetic

public final DecimalArithmetic deriveArithmetic(RoundingMode roundingMode)

Description copied from interface: DecimalArithmetic

Derives an arithmetic instance for the same scale as this arithmetic but for the specified roundingMode. The returned arithmetic uses the same overflow mode as this arithmetic.

Specified by:

deriveArithmetic in interface DecimalArithmetic

Parameters:

roundingMode - the rounding mode for the new arithmetic

Returns:

an arithmetic instance with the given rounding mode and this arithmetic's scale and overflow mode

deriveArithmetic

public final DecimalArithmetic deriveArithmetic(RoundingMode roundingMode,
                                                OverflowMode overflowMode)

Description copied from interface: DecimalArithmetic

Derives an arithmetic instance for the same scale as this arithmetic but for the specified roundingMode and overflowMode.

Specified by:

deriveArithmetic in interface DecimalArithmetic

Parameters:

roundingMode - the rounding mode for the new arithmetic

overflowMode - the overflow mode for the new arithmetic

Returns:

an arithmetic instance with the given rounding and overflow mode and this arithmetic's scale

deriveArithmetic

public final DecimalArithmetic deriveArithmetic(OverflowMode overflowMode)

Description copied from interface: DecimalArithmetic

Derives an arithmetic instance for the same scale as this arithmetic but for the specified overflowMode. The returned arithmetic uses the same rounding mode as this arithmetic.

Specified by:

deriveArithmetic in interface DecimalArithmetic

Parameters:

overflowMode - the overflow mode for the new arithmetic

Returns:

an arithmetic instance with the given overflow mode and this arithmetic's scale and rounding mode

deriveArithmetic

public final DecimalArithmetic deriveArithmetic(TruncationPolicy truncationPolicy)

Description copied from interface: DecimalArithmetic

Derives an arithmetic instance for the same scale as this arithmetic but with rounding and overflow mode specified by the given truncationPolicy.

Specified by:

deriveArithmetic in interface DecimalArithmetic

Parameters:

truncationPolicy - the truncation policy specifying rounding and overflow mode for the new arithmetic

Returns:

an arithmetic instance with rounding and overflow mode specified by the truncation policy using this arithmetic's scale

signum

public final int signum(long uDecimal)

Description copied from interface: DecimalArithmetic

Returns the signum function of the specified unscaled decimal.

Specified by:

signum in interface DecimalArithmetic

Parameters:

uDecimal - the unscaled decimal

Returns:

-1, 0, or 1 as the value of the specified unscaled decimal is negative, zero, or positive.

compare

public final int compare(long uDecimal1,
                         long uDecimal2)

Description copied from interface: DecimalArithmetic

Compares two unscaled decimal values numerically.

Specified by:

compare in interface DecimalArithmetic

Parameters:

uDecimal1 - the first unscaled decimal to compare

uDecimal2 - the second unscaled decimal to compare

Returns:

the value 0 if unscaled1 == unscaled2; a value less than 0 if unscaled1 < unscaled2; and a value greater than 0 if unscaled1 > unscaled2

compareToUnscaled

public final int compareToUnscaled(long uDecimal,
                                   long unscaled,
                                   int scale)

Description copied from interface: DecimalArithmetic

Compares two unscaled decimal values numerically. Note that scale of the first operand is determined by this arithmetic's scale whereas the scale of the second unscaled value is explicitly specified by the scale argument.

Specified by:

compareToUnscaled in interface DecimalArithmetic

Parameters:

uDecimal - the first unscaled decimal to compare

unscaled - the second unscaled decimal to compare

scale - the scale of unscaled

Returns:

the value 0 if unscaled1 == unscaled2; a value less than 0 if unscaled1 < unscaled2; and a value greater than 0 if unscaled1 > unscaled2

fromBigInteger

public final long fromBigInteger(BigInteger value)

Description copied from interface: DecimalArithmetic

Converts the specified BigInteger value to an unscaled decimal. An exception is thrown if the specified value is too large to be represented as a Decimal of this arithmetic's scale.

Specified by:

fromBigInteger in interface DecimalArithmetic

Parameters:

value - the value to convert

Returns:

the unscaled decimal representing the same value as the given big integer value

toBigDecimal

public final BigDecimal toBigDecimal(long uDecimal)

Description copied from interface: DecimalArithmetic

Converts the specified unscaled decimal value into a BigDecimal value using this arithmetic's scale for the result value.

Note: this operation is not strictly garbage free since the result value is usually allocated; however no temporary objects other than the result are allocated during the conversion.

Specified by:

toBigDecimal in interface DecimalArithmetic

Parameters:

uDecimal - the unscaled decimal value to convert into a BigDecimal value

Returns:

the uDecimal value converted into a BigDecimal value

toBigDecimal

public final BigDecimal toBigDecimal(long uDecimal,
                                     int scale)

Description copied from interface: DecimalArithmetic

Converts the specified unscaled decimal value into a BigDecimal value using the specified scale for the result value. The arithmetic's rounding mode is applied if rounding is necessary.

Note: this operation is not garbage free since the result value is usually allocated and also temporary objects may be allocated during the conversion. Note however that temporary objects are only allocated if the unscaled value of the result exceeds the range of a long value.

Specified by:

toBigDecimal in interface DecimalArithmetic

Parameters:

uDecimal - the unscaled decimal value to convert into a BigDecimal value

scale - the scale to use for the resulting BigDecimal value

Returns:

the uDecimal value converted into a BigDecimal value, possibly rounded or truncated