@PublicAPI public enum RingHandlingMode extends java.lang.Enum<RingHandlingMode>
MaxCommonSubstructure
(MCS) algorithms. It controls whether ring
bonds can match ring bonds only, or whether rings can be broken.McsSearchOptions.Builder.ringHandlingMode(RingHandlingMode)
Enum Constant and Description |
---|
IGNORE
This option ignores the ring/chain topology of bonds, which is the default behavior.
|
KEEP_RINGS
This option specifies that rings should not be broken.
|
MATCH_RING_BONDS
This option allows the algorithm to match a query and a target bond only if both are in rings or both are in
chains.
|
Modifier and Type | Method and Description |
---|---|
static RingHandlingMode |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static RingHandlingMode[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final RingHandlingMode IGNORE
public static final RingHandlingMode MATCH_RING_BONDS
Note that only rings smaller than a specified size limit are considered for this purpose. Bonds which are only
part of rings larger than this limit will be handled as chain bonds. See
McsSearchOptions.Builder.maxConsideredRingSize(int)
.
public static final RingHandlingMode KEEP_RINGS
Note that only rings smaller than a specified size limit are considered for this purpose. Bonds which are only
part of rings larger than this limit will be handled as chain bonds. See
McsSearchOptions.Builder.maxConsideredRingSize(int)
.
public static RingHandlingMode[] values()
for (RingHandlingMode c : RingHandlingMode.values()) System.out.println(c);
public static RingHandlingMode valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null