Package jdistlib

Enum Class MultivariateProbabilityStatus

java.lang.Object

java.lang.Enum<MultivariateProbabilityStatus>

jdistlib.MultivariateProbabilityStatus

All Implemented Interfaces:

Serializable, Comparable<MultivariateProbabilityStatus>, Constable

public enum MultivariateProbabilityStatus
extends Enum<MultivariateProbabilityStatus>

Terminal status of a numerical multivariate probability calculation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVALID_INPUT	Parameters, bounds, options, or the random stream were invalid.
MAX_EVALUATIONS_REACHED	A usable estimate was produced, but its error estimate exceeds tolerance.
SUCCESS	The requested tolerance was met, or the answer was obtained exactly.

Method Summary

Modifier and Type	Method	Description
int	code()	Stable legacy integer code.
String	message()	Human-readable status text.
static MultivariateProbabilityStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MultivariateProbabilityStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final MultivariateProbabilityStatus SUCCESS

The requested tolerance was met, or the answer was obtained exactly.

MAX_EVALUATIONS_REACHED

public static final MultivariateProbabilityStatus MAX_EVALUATIONS_REACHED

A usable estimate was produced, but its error estimate exceeds tolerance.

INVALID_INPUT

public static final MultivariateProbabilityStatus INVALID_INPUT

Parameters, bounds, options, or the random stream were invalid.

Method Details

values

public static MultivariateProbabilityStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MultivariateProbabilityStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

code

public int code()

Stable legacy integer code.

message

public String message()

Human-readable status text.