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 following stopping criteria used by clustering models:

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
TypeField
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
TypeMethod
static ClusteringStoppingCriterion getInstance(int id)
          Returns the ClusteringStoppingCriterion instance specified by id.
static ClusteringStoppingCriterion getInstance(java.lang.String name)
          Returns the ClusteringStoppingCriterion instance specified by name.
static ClusteringStoppingCriterion[] list()
          Returns all ClusteringStoppingCriterion enumerations.
static java.lang.String[] listNames()
          Returns all ClusteringStoppingCriterion names.
 
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 all ClusteringStoppingCriterion names.
Returns:
String[]

list

public static ClusteringStoppingCriterion[] list()
Returns all ClusteringStoppingCriterion enumerations.
Returns:
ClusteringStoppingCriterion[]

getInstance

public static ClusteringStoppingCriterion getInstance(java.lang.String name)
Returns the ClusteringStoppingCriterion instance specified by name.
Parameters:
name - Clustering stopping criterion name (error, errorAndIterations, or iterations)
Returns:
ClusteringStoppingCriterion

getInstance

public static ClusteringStoppingCriterion getInstance(int id)
Returns the ClusteringStoppingCriterion instance specified by id.
Parameters:
id - Clustering stopping criterion ID
Returns:
ClusteringStoppingCriterion