com.aoindustries.math

Enum BigFraction.DistributionMethod

java.lang.Object

java.lang.Enum<BigFraction.DistributionMethod>

com.aoindustries.math.BigFraction.DistributionMethod

All Implemented Interfaces:

Serializable, Comparable<BigFraction.DistributionMethod>

Enclosing class:

BigFraction

public static enum BigFraction.DistributionMethod
extends Enum<BigFraction.DistributionMethod>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HALF_UP Distributes values by rounding with HALF_UP method.
PROPORTIONAL Distributes remainders to larger fractions first.

Method Summary

Modifier and Type	Method and Description
static BigFraction.DistributionMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static BigFraction.DistributionMethod[]	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

PROPORTIONAL

public static final BigFraction.DistributionMethod PROPORTIONAL

Distributes remainders to larger fractions first. This may be more appropriate when working with combinations of large and small fractions.

HALF_UP

public static final BigFraction.DistributionMethod HALF_UP

Distributes values by rounding with HALF_UP method. This matches what one might do by hand or with a calculator.

Method Detail

values

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

Returns:

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

valueOf

public static BigFraction.DistributionMethod 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