com.chemaxon.search.mcs

Enum SearchMode

java.lang.Object

java.lang.Enum<SearchMode>

com.chemaxon.search.mcs.SearchMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchMode>

@PublicAPI
public enum SearchMode
extends java.lang.Enum<SearchMode>

Enum type for search modes of MaxCommonSubstructure (MCS) algorithms. The applied mode controls the running time and the accuracy of the heuristic algorithms.

Author:

Peter Kovacs (pkovacs84), Peter Englert

See Also:

MaxCommonSubstructure.setSearchMode(SearchMode)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAST Fast search mode.
NORMAL Normal search mode.

Method Summary

Modifier and Type	Method and Description
static SearchMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SearchMode[]	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

NORMAL

public static final SearchMode NORMAL

Normal search mode. It is the default option, which yields quite good results in relatively short time.

FAST

public static final SearchMode FAST

Fast search mode. It is faster than the NORMAL search mode, but could find smaller common substructures (especially for large molecules).

Method Detail

values

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

Returns:

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

valueOf

public static SearchMode 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