Files
rdkit/Code/GraphMol/Substruct/SubstructMatch.h
Greg Landrum f42f479d28 enabling infrastructure for making repeated recursive
smarts queries run faster (like vector bindings). Though there is an addition to the smarts parser
exposed here, I do not recommend using it in client code.
2010-06-03 10:02:15 +00:00

66 lines
2.0 KiB
C++
Executable File

//
// Copyright (C) 2001-2010 Greg Landrum and Rational Discovery LLC
//
// @@ All Rights Reserved @@
//
#ifndef _RD_SUBSTRUCTMATCH_H__
#define _RD_SUBSTRUCTMATCH_H__
// std bits
#include <vector>
namespace RDKit{
class ROMol;
class Atom;
class Bond;
//! \brief used to return matches from substructure searching,
//! The format is (queryAtomIdx, molAtomIdx)
typedef std::vector< std::pair<int,int> > MatchVectType;
//! Find a substructure match for a query in a molecule
/*!
\param mol The ROMol to be searched
\param query The query ROMol
\param matchVect Used to return the match
(pre-existing contents will be deleted)
\param recursionPossible flags whether or not recursive matches are allowed
\param useChirality use atomic CIP codes as part of the comparison
\param registerQuery DEPRECATED ARGUMENT
\return whether or not a match was found
*/
bool SubstructMatch(const ROMol &mol,const ROMol &query,
MatchVectType &matchVect,
bool recursionPossible=true,
bool useChirality=false,
bool registerQuery=false);
//! Find all substructure matches for a query in a molecule
/*!
\param mol The ROMol to be searched
\param query The query ROMol
\param matchVect Used to return the matches
(pre-existing contents will be deleted)
\param uniquify Toggles uniquification (by atom index) of the results
\param recursionPossible flags whether or not recursive matches are allowed
\param useChirality use atomic CIP codes as part of the comparison
\param registerQuery DEPRECATED ARGUMENT
\return the number of matches found
*/
unsigned int SubstructMatch(const ROMol &mol,const ROMol &query,
std::vector< MatchVectType > &matchVect,
bool uniquify=true,bool recursionPossible=true,
bool useChirality=false,
bool registerQuery=false);
}
#endif