org.decimal4j.arithmetic

Class Pow

java.lang.Object

org.decimal4j.arithmetic.Pow

final class Pow
extends Object

Contains static methods to calculate powers of a Decimal number.

Method Summary

Modifier and Type	Method and Description
static long	pow(DecimalArithmetic arith, DecimalRounding rounding, long uDecimalBase, int exponent) Power function for checked or unchecked arithmetic.
static long	powLong(DecimalArithmetic arith, DecimalRounding rounding, long lBase, int exponent) Calculates the power (lBaseexponent).
static long	powLongChecked(DecimalArithmetic arith, DecimalRounding rounding, long lBase, int exponent) Calculates the power (lBaseexponent).

Methods inherited from class java.lang.Object

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

Method Detail

powLong

public static final long powLong(DecimalArithmetic arith,
                                 DecimalRounding rounding,
                                 long lBase,
                                 int exponent)

Calculates the power (lBaseexponent). Overflows are silently ignored.

Parameters:

arith - the arithmetic associated with lBase

rounding - the rounding to apply if rounding is necessary for negative exponents

lBase - the unscaled decimal base value

exponent - the exponent

Returns:

round(lBaseexponent)

Throws:

ArithmeticException - if lBase==0 and the exponent is negative or if roundingMode==UNNECESSARY and rounding is necessary

powLongChecked

public static final long powLongChecked(DecimalArithmetic arith,
                                        DecimalRounding rounding,
                                        long lBase,
                                        int exponent)

Calculates the power (lBaseexponent). An exception is thrown if an overflow occurs.

Parameters:

arith - the arithmetic associated with lBase

rounding - the rounding to apply if rounding is necessary for negative exponents

lBase - the unscaled decimal base value

exponent - the exponent

Returns:

round(lBaseexponent)

Throws:

ArithmeticException - if lBase==0 and the exponent is negative, if roundingMode==UNNECESSARY and rounding is necessary or if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

pow

public static final long pow(DecimalArithmetic arith,
                             DecimalRounding rounding,
                             long uDecimalBase,
                             int exponent)

Power function for checked or unchecked arithmetic. The result is within 1 ULP for positive exponents.

Parameters:

arith - the arithmetic

rounding - the rounding to apply

uDecimalBase - the unscaled base

exponent - the exponent

Returns:

uDecimalbase ^ exponent