14 #include <boost/function.hpp>
23 #include <boost/dynamic_bitset.hpp>
29 namespace MolStandardize {
35 namespace TautomerScoringFunctions {
58 Tautomer() : d_numModifiedAtoms(0), d_numModifiedBonds(0), d_done(false) {}
62 d_numModifiedAtoms(a),
63 d_numModifiedBonds(b),
69 size_t d_numModifiedAtoms;
70 size_t d_numModifiedBonds;
95 return (d_it == other.d_it);
98 return !(*
this == other);
120 SmilesTautomerMap::const_iterator d_it;
124 : d_tautomers(other.d_tautomers),
125 d_status(other.d_status),
126 d_modifiedAtoms(other.d_modifiedAtoms),
127 d_modifiedBonds(other.d_modifiedBonds) {
128 fillTautomersItVec();
134 size_t size()
const {
return d_tautomers.size(); }
135 bool empty()
const {
return d_tautomers.empty(); }
137 PRECONDITION(pos < d_tautomers.size(),
"index out of bounds");
138 return d_tautomersItVec.at(pos)->second.tautomer;
142 return d_modifiedAtoms;
145 return d_modifiedBonds;
149 std::vector<ROMOL_SPTR> tautomerVec;
150 tautomerVec.reserve(d_tautomers.size());
152 d_tautomers.begin(), d_tautomers.end(), std::back_inserter(tautomerVec),
156 std::vector<ROMOL_SPTR>
operator()()
const {
return tautomers(); }
157 std::vector<std::string>
smiles()
const {
158 std::vector<std::string> smilesVec;
159 smilesVec.reserve(d_tautomers.size());
160 std::transform(d_tautomers.begin(), d_tautomers.end(),
161 std::back_inserter(smilesVec),
168 void fillTautomersItVec() {
169 for (
auto it = d_tautomers.begin(); it != d_tautomers.end(); ++it) {
170 d_tautomersItVec.push_back(it);
177 std::vector<SmilesTautomerMap::const_iterator> d_tautomersItVec;
182 boost::dynamic_bitset<> d_modifiedAtoms;
184 boost::dynamic_bitset<> d_modifiedBonds;
197 : dp_catalog(tautCat),
198 d_maxTautomers(1000),
199 d_maxTransforms(1000),
200 d_removeSp3Stereo(true),
201 d_removeBondStereo(true),
202 d_removeIsotopicHs(true),
203 d_reassignStereo(true) {}
206 : dp_catalog(other.dp_catalog),
207 d_callback(other.d_callback.get()),
208 d_maxTautomers(other.d_maxTautomers),
209 d_maxTransforms(other.d_maxTransforms),
210 d_removeSp3Stereo(other.d_removeSp3Stereo),
211 d_removeBondStereo(other.d_removeBondStereo),
212 d_removeIsotopicHs(other.d_removeIsotopicHs),
213 d_reassignStereo(other.d_reassignStereo) {}
215 if (
this == &other)
return *
this;
216 dp_catalog = other.dp_catalog;
217 d_callback.reset(other.d_callback.get());
218 d_maxTautomers = other.d_maxTautomers;
219 d_maxTransforms = other.d_maxTransforms;
220 d_removeSp3Stereo = other.d_removeSp3Stereo;
221 d_removeBondStereo = other.d_removeBondStereo;
222 d_removeIsotopicHs = other.d_removeIsotopicHs;
223 d_reassignStereo = other.d_reassignStereo;
228 d_maxTautomers = maxTautomers;
238 d_maxTransforms = maxTransforms;
250 d_removeSp3Stereo = removeSp3Stereo;
264 d_removeBondStereo = removeBondStereo;
274 d_removeIsotopicHs = removeIsotopicHs;
285 d_reassignStereo = reassignStereo;
297 d_callback.reset(callback);
327 "please use the form returning a TautomerEnumeratorResult "
328 "instead")]] std::vector<ROMOL_SPTR>
330 boost::dynamic_bitset<> *modifiedBonds =
nullptr)
const;
334 boost::function<
int(
const ROMol &mol)> scoreFunc =
341 template <
class Iterable,
342 typename std::enable_if<
343 !std::is_same<Iterable, TautomerEnumeratorResult>::value,
346 boost::function<
int(
const ROMol &mol)> scoreFunc =
349 if (tautomers.size() == 1) {
350 bestMol = *tautomers.begin();
353 int bestScore = std::numeric_limits<int>::min();
354 std::string bestSmiles =
"";
355 for (
const auto &t : tautomers) {
356 auto score = scoreFunc(*t);
357 #ifdef VERBOSE_ENUMERATION
358 std::cerr <<
" " <<
MolToSmiles(*t) <<
" " << score << std::endl;
360 if (score > bestScore) {
364 }
else if (score == bestScore) {
366 if (smiles < bestSmiles) {
374 static const bool cleanIt =
true;
375 static const bool force =
true;
395 boost::function<
int(
const ROMol &mol)> scoreFunc =
399 bool setTautomerStereoAndIsoHs(
const ROMol &mol,
ROMol &taut,
401 std::shared_ptr<TautomerCatalog> dp_catalog;
402 std::unique_ptr<TautomerEnumeratorCallback> d_callback;
403 unsigned int d_maxTautomers;
404 unsigned int d_maxTransforms;
405 bool d_removeSp3Stereo;
406 bool d_removeBondStereo;
407 bool d_removeIsotopicHs;
408 bool d_reassignStereo;
#define PRECONDITION(expr, mess)
A Catalog with a hierarchical structure.
virtual bool operator()(const ROMol &, const TautomerEnumeratorResult &)=0
virtual ~TautomerEnumeratorCallback()
TautomerEnumeratorCallback()
const_iterator operator--(int)
const ROMOL_SPTR & reference
pointer operator->() const
std::ptrdiff_t difference_type
std::bidirectional_iterator_tag iterator_category
reference operator*() const
bool operator!=(const const_iterator &other) const
const_iterator operator++(int)
bool operator==(const const_iterator &other) const
const_iterator & operator--()
const_iterator(const SmilesTautomerMap::const_iterator &it)
const_iterator & operator++()
Contains results of tautomer enumeration.
std::vector< ROMOL_SPTR > tautomers() const
const ROMOL_SPTR & operator[](size_t pos) const
std::vector< std::string > smiles() const
TautomerEnumeratorResult()
const SmilesTautomerMap & smilesTautomerMap() const
const const_iterator end() const
const boost::dynamic_bitset & modifiedBonds() const
const boost::dynamic_bitset & modifiedAtoms() const
const const_iterator begin() const
std::vector< ROMOL_SPTR > operator()() const
TautomerEnumeratorResult(const TautomerEnumeratorResult &other)
const ROMOL_SPTR & at(size_t pos) const
TautomerEnumeratorStatus status() const
void setRemoveSp3Stereo(bool removeSp3Stereo)
ROMol * canonicalize(const ROMol &mol, boost::function< int(const ROMol &mol)> scoreFunc=TautomerScoringFunctions::scoreTautomer) const
returns the canonical tautomer for a molecule
TautomerEnumerator(const CleanupParameters ¶ms=CleanupParameters())
bool getRemoveBondStereo()
void setRemoveIsotopicHs(bool removeIsotopicHs)
bool getRemoveSp3Stereo()
unsigned int getMaxTransforms()
ROMol * pickCanonical(const TautomerEnumeratorResult &tautRes, boost::function< int(const ROMol &mol)> scoreFunc=TautomerScoringFunctions::scoreTautomer) const
returns the canonical tautomer from a TautomerEnumeratorResult
TautomerEnumerator & operator=(const TautomerEnumerator &other)
bool getRemoveIsotopicHs()
TautomerEnumerator(TautomerCatalog *tautCat)
void setReassignStereo(bool reassignStereo)
void setRemoveBondStereo(bool removeBondStereo)
TautomerEnumeratorResult enumerate(const ROMol &mol) const
returns a TautomerEnumeratorResult structure for the input molecule
unsigned int getMaxTautomers()
TautomerEnumeratorCallback * getCallback() const
std::vector< ROMOL_SPTR > enumerate(const ROMol &mol, boost::dynamic_bitset<> *modifiedAtoms, boost::dynamic_bitset<> *modifiedBonds=nullptr) const
void setCallback(TautomerEnumeratorCallback *callback)
TautomerEnumerator(const TautomerEnumerator &other)
ROMol * pickCanonical(const Iterable &tautomers, boost::function< int(const ROMol &mol)> scoreFunc=TautomerScoringFunctions::scoreTautomer) const
void setMaxTransforms(unsigned int maxTransforms)
void setMaxTautomers(unsigned int maxTautomers)
Tautomer(ROMOL_SPTR t, ROMOL_SPTR k, size_t a=0, size_t b=0)
#define RDKIT_MOLSTANDARDIZE_EXPORT
RDKIT_GRAPHMOL_EXPORT void assignStereochemistry(ROMol &mol, bool cleanIt=false, bool force=false, bool flagPossibleStereoCenters=false)
Assign stereochemistry tags to atoms (i.e. R/S) and bonds (i.e. Z/E)
RDKIT_MOLSTANDARDIZE_EXPORT int scoreHeteroHs(const ROMol &mol)
int scoreTautomer(const ROMol &mol)
const std::string tautomerScoringVersion
RDKIT_MOLSTANDARDIZE_EXPORT int scoreSubstructs(const ROMol &mol)
RDKIT_MOLSTANDARDIZE_EXPORT int scoreRings(const ROMol &mol)
std::map< std::string, Tautomer > SmilesTautomerMap
TautomerEnumerator * tautomerEnumeratorFromParams(const CleanupParameters ¶ms)
RDCatalog::HierarchCatalog< TautomerCatalogEntry, TautomerCatalogParams, int > TautomerCatalog
std::pair< std::string, Tautomer > SmilesTautomerPair
RDKIT_SMILESPARSE_EXPORT std::string MolToSmiles(const ROMol &mol, const SmilesWriteParams ¶ms)
returns canonical SMILES for a molecule
boost::shared_ptr< ROMol > ROMOL_SPTR