org.openscience.cdk.smsd.interfaces

Enum Algorithm

java.lang.Object

java.lang.Enum<Algorithm>

org.openscience.cdk.smsd.interfaces.Algorithm

All Implemented Interfaces:

Serializable, Comparable<Algorithm>

Deprecated.

SMSD has been deprecated from the CDK with a newer, more recent version of SMSD is available at http://github.com/asad/smsd.

@Deprecated
public enum Algorithm
extends Enum<Algorithm>

This class represents various algorithm type supported by SMSD. Presently SMSD supports 5 different kinds of algorithms:

1. 0: default,
2. 1: MCSPlus,
3. 2: VFLibMCS,
4. 3: CDKMCS,
5. 4: SubStructure
6. 5: TurboSubStructure

Author:

Syed Asad Rahman <asad@ebi.ac.uk>

Source code:

master

Belongs to CDK module:

smsd

Enum Constant Summary

Enum Constants

Enum Constant and Description
CDKMCS Deprecated. CDK UIT MCS.
DEFAULT Deprecated. Default SMSD algorithm.
MCSPlus Deprecated. MCS Plus algorithm.
SubStructure Deprecated. Substructure search will return all maps.
TurboSubStructure Deprecated. Substructure search will return first map.
VFLibMCS Deprecated. VF Lib based MCS algorithm.

Method Summary

Modifier and Type	Method and Description
<status> int	compareTo(Algorithm obj) Deprecated. Compares algorithm types.
String	description() Deprecated. Returns short description of the algorithm.
int	type() Deprecated. Returns type of algorithm.
static Algorithm	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static Algorithm[]	values() Deprecated. 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

DEFAULT

public static final Algorithm DEFAULT

Deprecated.

Default SMSD algorithm.

MCSPlus

public static final Algorithm MCSPlus

Deprecated.

MCS Plus algorithm.

VFLibMCS

public static final Algorithm VFLibMCS

Deprecated.

VF Lib based MCS algorithm.

CDKMCS

public static final Algorithm CDKMCS

Deprecated.

CDK UIT MCS.

SubStructure

public static final Algorithm SubStructure

Deprecated.

Substructure search will return all maps.

TurboSubStructure

public static final Algorithm TurboSubStructure

Deprecated.

Substructure search will return first map.

Method Detail

values

public static Algorithm[] values()

Deprecated.

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 (Algorithm c : Algorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static Algorithm valueOf(String name)

Deprecated.

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:

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

NullPointerException - if the argument is null

type

public int type()

Deprecated.

Returns type of algorithm.

Returns:

type of algorithm

description

public String description()

Deprecated.

Returns short description of the algorithm.

Returns:

description of the algorithm

compareTo

public <status> int compareTo(Algorithm obj)

Deprecated.

Compares algorithm types.

Type Parameters:

status -

Parameters:

obj -

Returns:

status