org.decimal4j.arithmetic

Enum RoundingInverse

java.lang.Object

java.lang.Enum<RoundingInverse>

org.decimal4j.arithmetic.RoundingInverse

All Implemented Interfaces:

Serializable, Comparable<RoundingInverse>

enum RoundingInverse
extends Enum<RoundingInverse>

Defines different inverses of a DecimalRounding. Each constant provides its own implementation of an invert(DecimalRounding) method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDITIVE_REVERSION Constant calculating inverted rounding due to sign reversion occurring after an addition or subtraction.
RECIPROCAL Constant calculating inverted rounding due to reciprocal of a value.
SIGN_REVERSION Constant calculating inverted rounding due to sign reversion.

Method Summary

Modifier and Type	Method and Description
abstract DecimalRounding	invert(DecimalRounding rounding) Returns the inverted rounding for the inversion case defined by this constant.
static RoundingInverse	valueOf(String name) Returns the enum constant of this type with the specified name.
static RoundingInverse[]	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

SIGN_REVERSION

public static final RoundingInverse SIGN_REVERSION

Constant calculating inverted rounding due to sign reversion.

The inverted rounding mode can be used to round a value a instead of the value -a.

ADDITIVE_REVERSION

public static final RoundingInverse ADDITIVE_REVERSION

Constant calculating inverted rounding due to sign reversion occurring after an addition or subtraction.

The inverted rounding mode can be used to round a value x instead of the sum (a + x) when sum and x have opposite sign (equivalent for a difference (a - x)).

RECIPROCAL

public static final RoundingInverse RECIPROCAL

Constant calculating inverted rounding due to reciprocal of a value.

The inverted rounding mode can be used to round a value x instead of the reciprocal value 1/x.

Method Detail

values

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

Returns:

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

valueOf

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

invert

public abstract DecimalRounding invert(DecimalRounding rounding)

Returns the inverted rounding for the inversion case defined by this constant.

Parameters:

rounding - the original rounding

Returns:

the inverted rounding