Package org.apache.commons.statistics.inference

Enum PValueMethod

java.lang.Object

java.lang.Enum<PValueMethod>

org.apache.commons.statistics.inference.PValueMethod

All Implemented Interfaces:

Serializable, Comparable<PValueMethod>

public enum PValueMethod
extends Enum<PValueMethod>

Represents a method for computing a p-value for a test statistic.

Since:

1.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASYMPTOTIC	Use the asymptotic distribution of the test statistic to evaluate the p-value.
AUTO	Automatically choose the method to evaluate the p-value.
ESTIMATE	Use an estimation method for the p-value.
EXACT	Use the exact distribution of the test statistic to evaluate the p-value.

Method Summary

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

AUTO

public static final PValueMethod AUTO

Automatically choose the method to evaluate the p-value.

The choice will use heuristics based on the input data.

EXACT

public static final PValueMethod EXACT

Use the exact distribution of the test statistic to evaluate the p-value.

ASYMPTOTIC

public static final PValueMethod ASYMPTOTIC

Use the asymptotic distribution of the test statistic to evaluate the p-value.

ESTIMATE

public static final PValueMethod ESTIMATE

Use an estimation method for the p-value. For example this may use random sampling or permutations.

Method Detail

values

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

Returns:

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

valueOf

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