org.decimal4j.arithmetic

Enum SpecialMultiplicationResult

java.lang.Object

java.lang.Enum<SpecialMultiplicationResult>

org.decimal4j.arithmetic.SpecialMultiplicationResult

All Implemented Interfaces:

Serializable, Comparable<SpecialMultiplicationResult>

enum SpecialMultiplicationResult
extends Enum<SpecialMultiplicationResult>

Helper class used by multiplication methods to handle special cases.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FACTOR_1_IS_MINUS_ONE a*b with a==-1 leading to -b
FACTOR_1_IS_ONE a*b with a==1 leading to b
FACTOR_2_IS_MINUS_ONE a*b with b==-1 leading to -a
FACTOR_2_IS_ONE a*b with b==1 leading to a
FACTOR_IS_ZERO a*b with a==0 or b==0 leading to 0
FACTORS_ARE_EQUAL a*b with a==b leading to a^2

Method Summary

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

FACTOR_IS_ZERO

public static final SpecialMultiplicationResult FACTOR_IS_ZERO

a*b with a==0 or b==0 leading to 0

FACTOR_1_IS_ONE

public static final SpecialMultiplicationResult FACTOR_1_IS_ONE

a*b with a==1 leading to b

FACTOR_2_IS_ONE

public static final SpecialMultiplicationResult FACTOR_2_IS_ONE

a*b with b==1 leading to a

FACTOR_1_IS_MINUS_ONE

public static final SpecialMultiplicationResult FACTOR_1_IS_MINUS_ONE

a*b with a==-1 leading to -b

FACTOR_2_IS_MINUS_ONE

public static final SpecialMultiplicationResult FACTOR_2_IS_MINUS_ONE

a*b with b==-1 leading to -a

FACTORS_ARE_EQUAL

public static final SpecialMultiplicationResult FACTORS_ARE_EQUAL

a*b with a==b leading to a^2

Method Detail

values

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

Returns:

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

valueOf

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

multiply

abstract long multiply(DecimalArithmetic arithmetic,
                       long uDecimal1,
                       long uDecimal2)

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

Parameters:

arithmetic - the arithmetic associated with the values

uDecimal1 - the first factor

uDecimal2 - the second factor

Returns:

uDecimal1 * uDecimal2

Throws:

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

getFor

static final SpecialMultiplicationResult getFor(DecimalArithmetic arithmetic,
                                                long uDecimal1,
                                                long uDecimal2)

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

Parameters:

arithmetic - the arithmetic object

uDecimal1 - the first factor

uDecimal2 - the second factor

Returns:

special case if found one and null otherwise