oracle.dmt.odm
Class ClusteringStoppingCriterion

java.lang.Object
  |
  +--oracle.dmt.odm.Enum
        |
        +--oracle.dmt.odm.ClusteringStoppingCriterion

All Implemented Interfaces:

java.io.Serializable

public class ClusteringStoppingCriterion

extends Enum

The enumeration class ClusteringStoppingCriterion is used to represent the stopping criteria used by clustering models.

The semantics of the value are as follows:

• iterations - Training stops after a maximum number of iterations over the.data in the buffer is reached.
• error - Training stops after the change in error between two consecutive iterations is less than a given threshold.
• errorAndIterations - Training stops if either one of the two above criteria is matched.

Since:

9.2.0

See Also:

Serialized Form

Field Summary

static ClusteringStoppingCriterion	error Specifies the error stopping criterion.
static ClusteringStoppingCriterion	errorAndIterations Specifies the errorAndIterations stopping criterion.
static ClusteringStoppingCriterion	iterations Specifies the iterations stopping criterion.

Method Summary

static ClusteringStoppingCriterion	getInstance(int id) Returns ClusteringStoppingCriterion enumeration object corresponding to the specified ID.
static ClusteringStoppingCriterion	getInstance(java.lang.String name) Returns ClusteringStoppingCriterion enumeration object corresponding to the specified name.
static ClusteringStoppingCriterion[]	list() Returns the list of all ClusteringStoppingCriterion enumerations defined.
static java.lang.String[]	listNames() Returns the list of names of all ClusteringStoppingCriterion enumerations defined.

Methods inherited from class oracle.dmt.odm.Enum

getEnum, getID, isEqual

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iterations

public static final ClusteringStoppingCriterion iterations

Specifies the iterations stopping criterion.

error

public static final ClusteringStoppingCriterion error

Specifies the error stopping criterion.

errorAndIterations

public static final ClusteringStoppingCriterion errorAndIterations

Specifies the errorAndIterations stopping criterion.

Method Detail

listNames

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

Returns the list of names of all ClusteringStoppingCriterion enumerations defined.

Returns:

array of names for the ClusteringStoppingCriterion enumeration

list

public static ClusteringStoppingCriterion[] list()

Returns the list of all ClusteringStoppingCriterion enumerations defined.

Returns:

array of enumeration values for the ClusteringStoppingCriterion enumeration

getInstance

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

Returns ClusteringStoppingCriterion enumeration object corresponding to the specified name.

Parameters:

name - Clustering stopping criterion name (error, errorAndIterations, or iterations)

Returns:

instance of the ClusteringStoppingCriterion enumeration object corresponding to the given name, null if there is no enumeration for this name.

getInstance

public static ClusteringStoppingCriterion getInstance(int id)

Returns ClusteringStoppingCriterion enumeration object corresponding to the specified ID.

Parameters:

id - Clustering stopping criterion ID

Returns:

instance of the ClusteringStoppingCriterion enumeration object corresponding to the given id, null if there is no enumeration for id.