org.decimal4j.truncate

Enum CheckedRounding

java.lang.Object

java.lang.Enum<CheckedRounding>

org.decimal4j.truncate.CheckedRounding

All Implemented Interfaces:

Serializable, Comparable<CheckedRounding>, TruncationPolicy

public enum CheckedRounding
extends Enum<CheckedRounding>
implements TruncationPolicy

Provides rounding constants implementing TruncationPolicy for OverflowMode.CHECKED. The constants are equivalent to the constants defined by RoundingMode; the policy's getOverflowMode() method always returns CHECKED overflow mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CEILING Checked truncation policy with rounding mode to round towards positive infinity.
DOWN Checked truncation policy with rounding mode to round towards zero.
FLOOR Checked truncation policy with rounding mode to round towards negative infinity.
HALF_DOWN Checked truncation policy with rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
HALF_EVEN Checked truncation policy with rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.
HALF_UP Checked truncation policy with rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
UNNECESSARY Checked truncation policy with rounding mode to assert that the requested operation has an exact result, hence no rounding is necessary.
UP Checked truncation policy with rounding mode to round away from zero.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<CheckedRounding>	VALUES Immutable set with all values of this enum.

Fields inherited from interface org.decimal4j.truncate.TruncationPolicy

DEFAULT

Method Summary

Modifier and Type	Method and Description
OverflowMode	getOverflowMode() Returns OverflowMode.CHECKED.
String	toString() Returns "CHECKED/(name)" where (name) stands for the Enum.name() of this constant.
abstract UncheckedRounding	toUncheckedRounding() Returns the policy with the same rounding mode as this checked rounding policy but for UNCHECKED overflow mode.
static CheckedRounding	valueOf(RoundingMode roundingMode) Returns the checked rounding constant for the given rounding mode.
static CheckedRounding	valueOf(String name) Returns the enum constant of this type with the specified name.
static CheckedRounding[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.decimal4j.truncate.TruncationPolicy

getRoundingMode

Enum Constant Detail

UP

public static final CheckedRounding UP

Checked truncation policy with rounding mode to round away from zero. Always increments the digit prior to a non-zero discarded fraction. Note that this rounding mode never decreases the magnitude of the calculated value.

See Also:

RoundingMode.UP

DOWN

public static final CheckedRounding DOWN

Checked truncation policy with rounding mode to round towards zero. Never increments the digit prior to a discarded fraction (i.e., truncates). Note that this rounding mode never increases the magnitude of the calculated value.

See Also:

RoundingMode.DOWN

CEILING

public static final CheckedRounding CEILING

Checked truncation policy with rounding mode to round towards positive infinity. If the result is positive, behaves as for RoundingMode.UP; if negative, behaves as for RoundingMode.DOWN. Note that this rounding mode never decreases the calculated value.

See Also:

RoundingMode.CEILING

FLOOR

public static final CheckedRounding FLOOR

Checked truncation policy with rounding mode to round towards negative infinity. If the result is positive, behave as for RoundingMode.DOWN; if negative, behave as for RoundingMode.UP. Note that this rounding mode never increases the calculated value.

See Also:

RoundingMode.FLOOR

HALF_UP

public static final CheckedRounding HALF_UP

Checked truncation policy with rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. Behaves as for RoundingMode.UP if the discarded fraction is ≥ 0.5; otherwise, behaves as for RoundingMode.DOWN. Note that this is the rounding mode commonly taught at school.

See Also:

RoundingMode.HALF_UP

HALF_DOWN

public static final CheckedRounding HALF_DOWN

Checked truncation policy with rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. Behaves as for RoundingMode.UP if the discarded fraction is > 0.5; otherwise, behaves as for RoundingMode.DOWN.

See Also:

RoundingMode.HALF_DOWN

HALF_EVEN

public static final CheckedRounding HALF_EVEN

Checked truncation policy with rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor. Behaves as for RoundingMode.HALF_UP if the digit to the left of the discarded fraction is odd; behaves as for RoundingMode.HALF_DOWN if it's even. Note that this is the rounding mode that statistically minimizes cumulative error when applied repeatedly over a sequence of calculations. It is sometimes known as "Banker's rounding," and is chiefly used in the USA. This rounding mode is analogous to the rounding policy used for float and double arithmetic in Java.

See Also:

RoundingMode.HALF_EVEN

UNNECESSARY

public static final CheckedRounding UNNECESSARY

Checked truncation policy with rounding mode to assert that the requested operation has an exact result, hence no rounding is necessary. If this rounding mode is specified on an operation that yields an inexact result, an ArithmeticException is thrown.

See Also:

RoundingMode.UNNECESSARY

Field Detail

VALUES

public static final Set<CheckedRounding> VALUES

Immutable set with all values of this enum. Avoids object creation in contrast to values().

Method Detail

values

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

Returns:

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

valueOf

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

getOverflowMode

public final OverflowMode getOverflowMode()

Returns OverflowMode.CHECKED.

Specified by:

getOverflowMode in interface TruncationPolicy

Returns:

CHECKED overflow mode

toUncheckedRounding

public abstract UncheckedRounding toUncheckedRounding()

Returns the policy with the same rounding mode as this checked rounding policy but for UNCHECKED overflow mode.

Returns:

the UncheckedRounding counterpart to this policy.

toString

public final String toString()

Returns "CHECKED/(name)" where (name) stands for the Enum.name() of this constant.

Overrides:

toString in class Enum<CheckedRounding>

Returns:

a string like "CHECKED/HALF_UP"

valueOf

public static final CheckedRounding valueOf(RoundingMode roundingMode)

Returns the checked rounding constant for the given rounding mode.

Parameters:

roundingMode - the rounding mode

Returns:

the constant corresponding to the given rounding mode