Apache Groovy 3.0.20 · org.codehaus.groovy.runtime.typehandling.NumberMath

Stateless objects used to perform math on the various Number subclasses. Instances are required so that polymorphic calls work properly, but each subclass creates a singleton instance to minimize garbage. All methods must be thread-safe. The design goals of this class are as follows:

Support a 'least surprising' math model to scripting language users. This means that exact, or decimal math should be used for default calculations. This scheme assumes that by default, groovy literals with decimal points are instantiated as BigDecimal objects rather than binary floating points (Float, Double).
Do not force the appearance of exactness on a number that is by definition not guaranteed to be exact. In particular this means that if an operand in a NumberMath operation is a binary floating point number, ensure that the result remains a binary floating point number (i.e. never automatically promote a binary floating point number to a BigDecimal). This has the effect of preserving the expectations of binary floating point users and helps performance.
Provide an implementation that is as close as practical to the Java 1.5 BigDecimal math model which implements precision based floating point decimal math (ANSI X3.274-1996 and ANSI X3.274-1996/AM 1-2000 (section 7.4).

Constructor Summary

Access	Constructor and Description
public	NumberMath()

Method Summary

Modifier and Type	Method and Description
public static Number	abs(Number number)
protected abstract Number	absImpl(Number number)
public static Number	add(Number left, Number right)
public abstract Number	addImpl(Number left, Number right)
public static Number	and(Number left, Number right)
protected Number	andImpl(Number left, Number right)
public static Number	bitwiseNegate(Number left)
protected Number	bitwiseNegateImpl(Number left)
public static int	compareTo(Number left, Number right)
public abstract int	compareToImpl(Number left, Number right)
protected UnsupportedOperationException	createUnsupportedException(String operation, Number left)
public static Number	divide(Number left, Number right)
public abstract Number	divideImpl(Number left, Number right)
public static NumberMath	getMath(Number left, Number right) Determine which NumberMath instance to use, given the supplied operands.
pack-priv static NumberMath	getMath(Number number)
public static Number	intdiv(Number left, Number right)
protected Number	intdivImpl(Number left, Number right)
public static boolean	isBigDecimal(Number number)
public static boolean	isBigInteger(Number number)
public static boolean	isByte(Number number)
public static boolean	isFloatingPoint(Number number)
public static boolean	isInteger(Number number)
public static boolean	isLong(Number number)
public static boolean	isShort(Number number)
public static Number	leftShift(Number left, Number right) For this operation, consider the operands independently.
protected Number	leftShiftImpl(Number left, Number right)
public static Number	mod(Number left, Number right)
protected Number	modImpl(Number left, Number right)
public static Number	multiply(Number left, Number right)
public abstract Number	multiplyImpl(Number left, Number right)
public static Number	or(Number left, Number right)
protected Number	orImpl(Number left, Number right)
public static Number	rightShift(Number left, Number right) For this operation, consider the operands independently.
protected Number	rightShiftImpl(Number left, Number right)
public static Number	rightShiftUnsigned(Number left, Number right) For this operation, consider the operands independently.
protected Number	rightShiftUnsignedImpl(Number left, Number right)
public static Number	subtract(Number left, Number right)
public abstract Number	subtractImpl(Number left, Number right)
public static BigDecimal	toBigDecimal(Number n)
public static BigInteger	toBigInteger(Number n)
public static Number	unaryMinus(Number left)
protected abstract Number	unaryMinusImpl(Number left)
public static Number	unaryPlus(Number left)
protected abstract Number	unaryPlusImpl(Number left)
public static Number	xor(Number left, Number right)
protected Number	xorImpl(Number left, Number right)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NumberMath	back to summary
public NumberMath()

Method Detail

abs	back to summary
public static Number abs(Number number)

absImpl	back to summary
protected abstract Number absImpl(Number number)

add	back to summary
public static Number add(Number left, Number right)

addImpl	back to summary
public abstract Number addImpl(Number left, Number right)

and	back to summary
public static Number and(Number left, Number right)

andImpl	back to summary
protected Number andImpl(Number left, Number right)

bitwiseNegate	back to summary
public static Number bitwiseNegate(Number left)

bitwiseNegateImpl	back to summary
protected Number bitwiseNegateImpl(Number left)

compareTo	back to summary
public static int compareTo(Number left, Number right)

compareToImpl	back to summary
public abstract int compareToImpl(Number left, Number right)

createUnsupportedException	back to summary
protected UnsupportedOperationException createUnsupportedException(String operation, Number left)

divide	back to summary
public static Number divide(Number left, Number right)

divideImpl	back to summary
public abstract Number divideImpl(Number left, Number right)

getMath	back to summary
public static NumberMath getMath(Number left, Number right) Determine which NumberMath instance to use, given the supplied operands. This method implements the type promotion rules discussed in the documentation. Note that by the time this method is called, any Byte, Character or Short operands will have been promoted to Integer. For reference, here is the promotion matrix: bD bI D F L I bD bD bD D D bD bD bI bD bI D D bI bI D D D D D D D F D D D D D D L bD bI D D L L I bD bI D D L I Note that for division, if either operand isFloatingPoint, the result will be floating. Otherwise, the result is BigDecimal

getMath

back to summary

public static NumberMath getMath(Number left, Number right)

Determine which NumberMath instance to use, given the supplied operands. This method implements the type promotion rules discussed in the documentation. Note that by the time this method is called, any Byte, Character or Short operands will have been promoted to Integer. For reference, here is the promotion matrix: bD bI D F L I bD bD bD D D bD bD bI bD bI D D bI bI D D D D D D D F D D D D D D L bD bI D D L L I bD bI D D L I Note that for division, if either operand isFloatingPoint, the result will be floating. Otherwise, the result is BigDecimal

getMath	back to summary
pack-priv static NumberMath getMath(Number number)

intdiv	back to summary
public static Number intdiv(Number left, Number right)

intdivImpl	back to summary
protected Number intdivImpl(Number left, Number right)

isBigDecimal	back to summary
public static boolean isBigDecimal(Number number)

isBigInteger	back to summary
public static boolean isBigInteger(Number number)

isByte	back to summary
public static boolean isByte(Number number)

isFloatingPoint	back to summary
public static boolean isFloatingPoint(Number number)

isInteger	back to summary
public static boolean isInteger(Number number)

isLong	back to summary
public static boolean isLong(Number number)

isShort	back to summary
public static boolean isShort(Number number)

leftShift	back to summary
public static Number leftShift(Number left, Number right) For this operation, consider the operands independently. Throw an exception if the right operand (shift distance) is not an integral type. For the left operand (shift value) also require an integral type, but do NOT promote from Integer to Long. This is consistent with Java, and makes sense for the shift operators.

leftShiftImpl	back to summary
protected Number leftShiftImpl(Number left, Number right)

mod	back to summary
public static Number mod(Number left, Number right)

modImpl	back to summary
protected Number modImpl(Number left, Number right)

multiply	back to summary
public static Number multiply(Number left, Number right)

multiplyImpl	back to summary
public abstract Number multiplyImpl(Number left, Number right)

or	back to summary
public static Number or(Number left, Number right)

orImpl	back to summary
protected Number orImpl(Number left, Number right)

rightShift	back to summary
public static Number rightShift(Number left, Number right) For this operation, consider the operands independently. Throw an exception if the right operand (shift distance) is not an integral type. For the left operand (shift value) also require an integral type, but do NOT promote from Integer to Long. This is consistent with Java, and makes sense for the shift operators.

rightShiftImpl	back to summary
protected Number rightShiftImpl(Number left, Number right)

rightShiftUnsigned	back to summary
public static Number rightShiftUnsigned(Number left, Number right) For this operation, consider the operands independently. Throw an exception if the right operand (shift distance) is not an integral type. For the left operand (shift value) also require an integral type, but do NOT promote from Integer to Long. This is consistent with Java, and makes sense for the shift operators.

rightShiftUnsignedImpl	back to summary
protected Number rightShiftUnsignedImpl(Number left, Number right)

subtract	back to summary
public static Number subtract(Number left, Number right)

subtractImpl	back to summary
public abstract Number subtractImpl(Number left, Number right)

toBigDecimal	back to summary
public static BigDecimal toBigDecimal(Number n)

toBigInteger	back to summary
public static BigInteger toBigInteger(Number n)

unaryMinus	back to summary
public static Number unaryMinus(Number left)

unaryMinusImpl	back to summary
protected abstract Number unaryMinusImpl(Number left)

unaryPlus	back to summary
public static Number unaryPlus(Number left)

unaryPlusImpl	back to summary
protected abstract Number unaryPlusImpl(Number left)

xor	back to summary
public static Number xor(Number left, Number right)

xorImpl	back to summary
protected Number xorImpl(Number left, Number right)

public abstract Class NumberMath

Constructor Summary

Method Summary

Constructor Detail

Method Detail