biz.sc.mm.dm.supervised.statistical

Class ConvergenceCriterion

java.lang.Object

biz.sc.mm.dm.Enum

biz.sc.mm.dm.supervised.statistical.ConvergenceCriterion

All Implemented Interfaces:

java.io.Serializable

public class ConvergenceCriterion
extends Enum

Convergence criterion for nonlinear optimization methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConvergenceCriterion	gradient Gradient norm is less than predefined threshold
static ConvergenceCriterion	gradientRelative Relative (normalized) gradient norm is less than predefined threshold
static ConvergenceCriterion	likelihood Likelihood value change is less than predefined threshold
static ConvergenceCriterion	likelihoodRelative Relative (normalized) likelihood value change is less than predefined threshold
static ConvergenceCriterion	parameterRelative Parameters vector change is less than predefined threshold

Method Summary

Methods

Modifier and Type	Method and Description
static ConvergenceCriterion	getInstance(int id) Returns enumeration element corresponding to the specified identifier.
static ConvergenceCriterion	getInstance(java.lang.String name) Returns enumeration element corresponding to the specified name.
static ConvergenceCriterion[]	list() Returns the array of this enumeration elements.
static java.lang.String[]	listNames() Returns the names of this enumeration elements.

Methods inherited from class biz.sc.mm.dm.Enum

equals, getDefaultValue, getEnum, getID, getInstance, hashCode, isEqual, list, listNames, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

gradient

public static final ConvergenceCriterion gradient

Gradient norm is less than predefined threshold

gradientRelative

public static final ConvergenceCriterion gradientRelative

Relative (normalized) gradient norm is less than predefined threshold

likelihood

public static final ConvergenceCriterion likelihood

Likelihood value change is less than predefined threshold

likelihoodRelative

public static final ConvergenceCriterion likelihoodRelative

Relative (normalized) likelihood value change is less than predefined threshold

parameterRelative

public static final ConvergenceCriterion parameterRelative

Parameters vector change is less than predefined threshold

Method Detail

listNames

public static java.lang.String[] listNames()

Returns the names of this enumeration elements.

Returns:

the names of this enumeration elements.

list

public static ConvergenceCriterion[] list()

Returns the array of this enumeration elements.

Returns:

the array of this enumeration elements.

getInstance

public static ConvergenceCriterion getInstance(java.lang.String name)

Returns enumeration element corresponding to the specified name.

Parameters:

name - the name of the element.

Returns:

enumeration element.

Throws:

NoSuchElementException - if such element does not exist.

getInstance

public static ConvergenceCriterion getInstance(int id)

Returns enumeration element corresponding to the specified identifier.

Parameters:

id - the identifier of the element.

Returns:

enumeration element.

Throws:

NoSuchElementException - if such element does not exist.