org.decimal4j.arithmetic

Enum SpecialDivisionResult

java.lang.Object

java.lang.Enum<SpecialDivisionResult>

org.decimal4j.arithmetic.SpecialDivisionResult

All Implemented Interfaces:

Serializable, Comparable<SpecialDivisionResult>

enum SpecialDivisionResult
extends Enum<SpecialDivisionResult>

Helper class used by division and inversion methods to handle special cases.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIVIDEND_IS_ZERO a/b with a==0, b!=0 leading to 0/b=0
DIVISOR_EQUALS_DIVIDEND a/b with a==b resulting in a/a=b/b=1
DIVISOR_EQUALS_MINUS_DIVIDEND a/b with a==-b resulting in a/-a=-b/b=-1
DIVISOR_IS_MINUS_ONE a/b with b==-1 resulting in a/-1=-a
DIVISOR_IS_ONE a/b with b==1 leading to a/1=a
DIVISOR_IS_ZERO a/b with b==0 leading to an arithmetic exception

Method Summary

Modifier and Type	Method and Description
(package private) abstract long	divide(DecimalArithmetic arithmetic, long uDecimalDividend, long uDecimalDivisor) Performs the division for this special division result.
(package private) static SpecialDivisionResult	getFor(DecimalArithmetic arithmetic, long uDecimalDividend, long uDecimalDivisor) Returns the special division case if it is one and null otherwise.
static SpecialDivisionResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpecialDivisionResult[]	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

DIVIDEND_IS_ZERO

public static final SpecialDivisionResult DIVIDEND_IS_ZERO

a/b with a==0, b!=0 leading to 0/b=0

DIVISOR_IS_ZERO

public static final SpecialDivisionResult DIVISOR_IS_ZERO

a/b with b==0 leading to an arithmetic exception

DIVISOR_IS_ONE

public static final SpecialDivisionResult DIVISOR_IS_ONE

a/b with b==1 leading to a/1=a

DIVISOR_IS_MINUS_ONE

public static final SpecialDivisionResult DIVISOR_IS_MINUS_ONE

a/b with b==-1 resulting in a/-1=-a

DIVISOR_EQUALS_DIVIDEND

public static final SpecialDivisionResult DIVISOR_EQUALS_DIVIDEND

a/b with a==b resulting in a/a=b/b=1

DIVISOR_EQUALS_MINUS_DIVIDEND

public static final SpecialDivisionResult DIVISOR_EQUALS_MINUS_DIVIDEND

a/b with a==-b resulting in a/-a=-b/b=-1

Method Detail

values

public static SpecialDivisionResult[] 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 (SpecialDivisionResult c : SpecialDivisionResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpecialDivisionResult 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

divide

abstract long divide(DecimalArithmetic arithmetic,
                     long uDecimalDividend,
                     long uDecimalDivisor)

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

Parameters:

arithmetic - the arithmetic associated with the values

uDecimalDividend - the dividend

uDecimalDivisor - the divisor

Returns:

uDecimalDividend / uDecimalDivisor

Throws:

ArithmeticException - if this==DIVISOR_IS_ZERO or if an overflow occurs and the arithmetic's OverflowMode is set to throw an exception

getFor

static final SpecialDivisionResult getFor(DecimalArithmetic arithmetic,
                                          long uDecimalDividend,
                                          long uDecimalDivisor)

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

Parameters:

arithmetic - the arithmetic object

uDecimalDividend - the dividend

uDecimalDivisor - the divisor

Returns:

the special case if it is one and null otherwise