org.decimal4j.arithmetic

Class AbstractCheckedScaleNfArithmetic

java.lang.Object

org.decimal4j.arithmetic.AbstractArithmetic

org.decimal4j.arithmetic.AbstractCheckedArithmetic

org.decimal4j.arithmetic.AbstractCheckedScaleNfArithmetic

All Implemented Interfaces:

DecimalArithmetic

Direct Known Subclasses:

CheckedScaleNfRoundingArithmetic, CheckedScaleNfTruncatingArithmetic

public abstract class AbstractCheckedScaleNfArithmetic
extends AbstractCheckedArithmetic

Base class for arithmetic implementations with overflow check for scales other than zero.

Constructor Summary

Constructors

Constructor and Description
AbstractCheckedScaleNfArithmetic(ScaleMetrics scaleMetrics) Constructor with scale metrics for this arithmetic.

Method Summary

Modifier and Type	Method and Description
long	addLong(long uDecimal, long lValue) Returns an unscaled decimal whose value is the sum of the specified arguments: (uDecimal + lValue).
int	getScale() Returns the scale f applied to all unscaled decimal values passed to and returned by this DecimalArithmetic.
ScaleMetrics	getScaleMetrics() Returns the scale metrics associated with this decimal arithmetic object.
long	one() Returns the unscaled decimal for the decimal value 1.
long	subtractLong(long uDecimal, long lValue) Returns an unscaled decimal whose value is the difference of the specified arguments: (uDecimal - lValue) .
String	toString(long uDecimal) Converts the specified unscaled decimal value into a String and returns it.
void	toString(long uDecimal, Appendable appendable) Converts the specified unscaled decimal value into a String and appends the string to the appendable.

Methods inherited from class org.decimal4j.arithmetic.AbstractCheckedArithmetic

abs, add, getOverflowMode, getTruncationPolicy, multiplyByLong, negate, subtract

Methods inherited from class org.decimal4j.arithmetic.AbstractArithmetic

compare, compareToUnscaled, deriveArithmetic, deriveArithmetic, deriveArithmetic, deriveArithmetic, deriveArithmetic, fromBigInteger, signum, toBigDecimal, toBigDecimal

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

addUnscaled, avg, divide, divideByLong, divideByPowerOf10, divideByUnscaled, fromBigDecimal, fromDouble, fromFloat, fromLong, fromUnscaled, getRoundingMode, invert, multiply, multiplyByPowerOf10, multiplyByUnscaled, parse, parse, pow, round, shiftLeft, shiftRight, sqrt, square, subtractUnscaled, toDouble, toFloat, toLong, toUnscaled

Constructor Detail

AbstractCheckedScaleNfArithmetic

public AbstractCheckedScaleNfArithmetic(ScaleMetrics scaleMetrics)

Constructor with scale metrics for this arithmetic.

Parameters:

scaleMetrics - the scale metrics

Method Detail

getScaleMetrics

public final ScaleMetrics getScaleMetrics()

Description copied from interface: DecimalArithmetic

Returns the scale metrics associated with this decimal arithmetic object.

Returns:

the scale metrics

getScale

public final int getScale()

Description copied from interface: DecimalArithmetic

Returns the scale f applied to all unscaled decimal values passed to and returned by this DecimalArithmetic. Corresponds to the number of digits to the right of the decimal point (cannot be negative).

A given Decimal value multiplied with 10f results in an unscaled long value. Conversely, a Decimal value d can be computed from the unscaled value u as d = u*10-f.

Returns:

the non-negative scale f applied to unscaled decimal values within this DecimalArithmetic object

See Also:

ScaleMetrics.getScale()

one

public final long one()

Description copied from interface: DecimalArithmetic

Returns the unscaled decimal for the decimal value 1. One is the value 10scale which is also the multiplier used to get the unscaled decimal from the true decimal value.

Returns:

the unscaled decimal representing the decimal value 1

addLong

public final long addLong(long uDecimal,
                          long lValue)

Description copied from interface: DecimalArithmetic

Returns an unscaled decimal whose value is the sum of the specified arguments: (uDecimal + lValue).

Mathematically the method calculates (uDecimal + lValue * 10scale) avoiding information loss due to overflow of intermediary results.

Parameters:

uDecimal - unscaled decimal value to be added

lValue - long value to be added

Returns:

(uDecimal + lValue * 10scale)

subtractLong

public final long subtractLong(long uDecimal,
                               long lValue)

Description copied from interface: DecimalArithmetic

Returns an unscaled decimal whose value is the difference of the specified arguments: (uDecimal - lValue) .

Mathematically the method calculates (uDecimal - lValue * 10scale) avoiding information loss due to overflow of intermediary results.

Parameters:

uDecimal - unscaled decimal value to subtract from

lValue - long value to subtract

Returns:

(uDecimal - lValue * 10scale)

toString

public final String toString(long uDecimal)

Description copied from interface: DecimalArithmetic

Converts the specified unscaled decimal value into a String and returns it. If the scale is zero, the conversion is identical to Long.toString(long). For all other scales a value with exactly scale fraction digits is returned even if some trailing fraction digits are zero.

Note: this operation is not strictly garbage free since the result value is allocated; however no temporary objects other than the result are allocated during the conversion (internally a ThreadLocal StringBuilder object is used to construct the string value, which may become garbage if the thread becomes garbage).

Parameters:

uDecimal - the unscaled decimal value to convert into a String

Returns:

the uDecimal value as into a String

toString

public final void toString(long uDecimal,
                           Appendable appendable)
                    throws IOException

Description copied from interface: DecimalArithmetic

Converts the specified unscaled decimal value into a String and appends the string to the appendable.

If the scale is zero, the conversion into a string is identical to Long.toString(long). For all other scales a string value with exactly scale fraction digits is created even if some trailing fraction digits are zero.

Note: this operation is not strictly garbage free since internally, a ThreadLocal string builder is used to construct the string. The ThreadLocal value may become garbage if the thread becomes garbage.

Parameters:

uDecimal - the unscaled decimal value to convert into a String

appendable - the appendable to which the string representation of the unscaled decimal value is to be appended

Throws:

IOException - If an I/O error occurs when appending to appendable