org.decimal4j.arithmetic

Enum SpecialPowResult

java.lang.Object

java.lang.Enum<SpecialPowResult>

org.decimal4j.arithmetic.SpecialPowResult

All Implemented Interfaces:

Serializable, Comparable<SpecialPowResult>

 enum SpecialPowResult
extends Enum<SpecialPowResult>

Helper class used by pow methods to handle special cases.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE_IS_MINUS_ONE a^n with a==-1 leading to 1 if n is even and to -1 if n is odd.
BASE_IS_ONE a^n with a==1 leading to 1
BASE_IS_ZERO a^n with a==0 leading to 0 if n>=0 and to an arithmetic exception if n<0
EXPONENT_IS_MINUS_ONE a^n with n==-1 leading to 1/a
EXPONENT_IS_ONE a^n with n==1 leading to a
EXPONENT_IS_TWO a^n with n==2 leading to square(a)
EXPONENT_IS_ZERO a^n with n==0 leading to 1

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static SpecialPowResult	getFor(DecimalArithmetic arithmetic, long uDecimal, long n) Returns the special power case if it is one and null otherwise.
(package private) abstract long	pow(DecimalArithmetic arithmetic, long uDecimal, int exponent) Performs the exponentiation for this special pow result.
static SpecialPowResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpecialPowResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXPONENT_IS_ZERO

public static final SpecialPowResult EXPONENT_IS_ZERO

a^n with n==0 leading to 1

EXPONENT_IS_ONE

public static final SpecialPowResult EXPONENT_IS_ONE

a^n with n==1 leading to a

BASE_IS_ZERO

public static final SpecialPowResult BASE_IS_ZERO

a^n with a==0 leading to 0 if n>=0 and to an arithmetic exception if n<0

BASE_IS_ONE

public static final SpecialPowResult BASE_IS_ONE

a^n with a==1 leading to 1

BASE_IS_MINUS_ONE

public static final SpecialPowResult BASE_IS_MINUS_ONE

a^n with a==-1 leading to 1 if n is even and to -1 if n is odd.

EXPONENT_IS_MINUS_ONE

public static final SpecialPowResult EXPONENT_IS_MINUS_ONE

a^n with n==-1 leading to 1/a

EXPONENT_IS_TWO

public static final SpecialPowResult EXPONENT_IS_TWO

a^n with n==2 leading to square(a)

Method Detail

values

public static SpecialPowResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpecialPowResult c : SpecialPowResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpecialPowResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

pow

abstract long pow(DecimalArithmetic arithmetic,
       long uDecimal,
       int exponent)

Performs the exponentiation for this special pow result. The arithmetics overflow mode is considered.

Parameters:

arithmetic - the arithmetic associated with the values

uDecimal - the base value

exponent - the exponent

Returns:

uDecimal^exponent

Throws:

ArithmeticException - if uDecimal==0 and exponent is negative or if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

getFor

static final SpecialPowResult getFor(DecimalArithmetic arithmetic,
                      long uDecimal,
                      long n)

Returns the special power case if it is one and null otherwise.

Parameters:

arithmetic - the arithmetic object

uDecimal - the base

n - the exponent

Returns:

the special case if it is one and null otherwise