Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated JavaDoc to explicitly state that g2 must be a substructure of g1

Signed-off-by: Rajarshi  Guha <rajarshi.guha@gmail.com>
  • Loading branch information...
commit 2660aca243568129d39486d0a5e7f9855be209ea 1 parent 3d18a73
@egonw authored rajarshi committed
View
10 src/main/org/openscience/cdk/isomorphism/UniversalIsomorphismTester.java
@@ -272,11 +272,12 @@ public static boolean isIsomorph(IAtomContainer g1, IAtomContainer g2) throws C
/**
- * Returns all subgraph 'atom mappings' found for g2 in g1.
+ * Returns all subgraph 'atom mappings' found for g2 in g1, where g2 must be a substructure
+ * of g1. If it is not a substructure, null will be returned.
* This is an {@link List} of {@link List}s of {@link RMap} objects.
*
* @param g1 first molecule. Must not be an {@link IQueryAtomContainer}.
- * @param g2 second molecule. May be an {@link IQueryAtomContainer}.
+ * @param g2 substructure to be mapped. May be an {@link IQueryAtomContainer}.
* @return all subgraph atom mappings found projected on g1. This is a
* {@link List} of {@link RMap} objects containing Ids of matching atoms.
*/
@@ -296,10 +297,11 @@ public static boolean isIsomorph(IAtomContainer g1, IAtomContainer g2) throws C
}
/**
- * Returns the first subgraph 'atom mapping' found for g2 in g1.
+ * Returns the first subgraph 'atom mapping' found for g2 in g1, where g2 must be a substructure
+ * of g1. If it is not a substructure, null will be returned.
*
* @param g1 first molecule. Must not be an {@link IQueryAtomContainer}.
- * @param g2 second molecule. May be an {@link IQueryAtomContainer}.
+ * @param g2 substructure to be mapped. May be an {@link IQueryAtomContainer}.
* @return the first subgraph atom mapping found projected on g1.
* This is a {@link List} of {@link RMap} objects containing Ids of matching atoms.
*/
Please sign in to comment.
Something went wrong with that request. Please try again.