Files
rdkit/Code/GraphMol/Substruct/SubstructMatch.h
Greg Landrum 75a79b6327 initial import
2006-05-06 22:20:08 +00:00

92 lines
2.8 KiB
C++
Executable File

//
// Copyright (C) 2001-2006 Greg Landrum and Rational Discovery LLC
//
// @@ All Rights Reserved @@
//
#ifndef _RD_SUBSTRUCTMATCH_H__
#define _RD_SUBSTRUCTMATCH_H__
// std bits
#include <vector>
// vflib bits
#include <argraph.h>
#include <vf_mono_state.h>
#include <vf2_mono_state.h>
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;
//typedef VFMonoState MatcherState;
typedef VF2MonoState MatcherState;
typedef ARGraph<const Atom, const Bond> AR_MOLGRAPH;
//! Internal Use Only
AR_MOLGRAPH *getMolGraph(const ROMol &mol);
//! 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
\return whether or not a match was found
*/
bool SubstructMatch(const ROMol &mol,const ROMol &query,
MatchVectType &matchVect,
bool recursionPossible=true);
//! \overload
bool SubstructMatch(AR_MOLGRAPH *molG,const ROMol &query,
MatchVectType &matchVect,
bool recursionPossible=true);
//! 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
\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);
//! \overload
unsigned int SubstructMatch(AR_MOLGRAPH *molG,const ROMol &query,
std::vector< MatchVectType > &matchVect,
bool uniquify=true,bool recursionPossible=true);
//! \brief Returns a copy of an ROMol with the atoms and bonds that
//! match a pattern removed.
/*!
\param mol the ROMol of interest
\param query the query ROMol
\param onlyFrags if this is set, only matches that correspond to an
entire fragment will be removed. This is useful for
salt removal
\return a copy of \c mol with the matching atoms and bonds (if any)
removed.
*/
ROMol *deleteSubstructs(const ROMol &mol, const ROMol &query,
bool onlyFrags=0);
}
#endif