chemaxon.sss.search
Enum MCES.TerminationCause

java.lang.Object
  java.lang.Enum<MCES.TerminationCause>
      chemaxon.sss.search.MCES.TerminationCause

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MCES.TerminationCause>

Enclosing class:

MCES

public static enum MCES.TerminationCause
extends java.lang.Enum<MCES.TerminationCause>

Enum type for causes of MCES search termination. Various limits can be specified for the search process. If a limit is reached, then the algorithm terminates with the best result obtained so far. The cause of the termination can be retrieved using MCES.getTerminationCause().

Enum Constant Summary

FINISHED
Normal termination.

OPTIMAL
Optimal MCES is found.

STEP_LIMIT
The step count limit is reached.

TIME_LIMIT
The time limit is reached.

Method Summary

static MCES.TerminationCause	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MCES.TerminationCause[]	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

FINISHED

public static final MCES.TerminationCause FINISHED

Normal termination. The whole search process of the applied MCES search mode is accomplished. The found common substructure may be either optimal (the largest one) or smaller. Since the algorithm is heuristic, it not necessarily finds the exact MCES. In many cases, however, it can guarantee that the found result is optimal, which is indicated by OPTIMAL termination cause.

OPTIMAL

public static final MCES.TerminationCause OPTIMAL

Optimal MCES is found. This termination cause indicates the cases when the algorithm can guarantee that the found common substructure is the exact optimal result. However, the algorithm could even find optimal MCES without recognizing that it is actually optimal. In such cases, FINISHED termination cause is returned.

STEP_LIMIT

public static final MCES.TerminationCause STEP_LIMIT

The step count limit is reached. The found common substructure could be smaller than what could be found by the whole search process of the applied search mode.

See Also:

MCES.setStepCountLimit()

TIME_LIMIT

public static final MCES.TerminationCause TIME_LIMIT

The time limit is reached. The found common substructure could be smaller than what could be found by the whole search process of the applied search mode.

See Also:

MCES.setTimeLimit()

Method Detail

values

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

Returns:

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

valueOf

public static MCES.TerminationCause valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null