Package com.bayesserver.statistics

Enum LogarithmBase

java.lang.Object

java.lang.Enum<LogarithmBase>

com.bayesserver.statistics.LogarithmBase

All Implemented Interfaces:

Serializable, Comparable<LogarithmBase>

public enum LogarithmBase
extends Enum<LogarithmBase>

Determines the base of the logarithm to use during calculations such as mutual information.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NATURAL	Natural (base e) logarithm.
TWO	Base 2 logarithm.

Method Summary

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

NATURAL

public static final LogarithmBase NATURAL

Natural (base e) logarithm.

TWO

public static final LogarithmBase TWO

Base 2 logarithm.

Method Detail

values

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

Returns:

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

valueOf

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