ROMol.h

Go to the documentation of this file.

//
//  Copyright (C) 2003-2022 Greg Landrum and other RDKit contributors
//
//   @@ All Rights Reserved @@
//  This file is part of the RDKit.
//  The contents are covered by the terms of the BSD license
//  which is included in the file license.txt, found at the root
//  of the RDKit source tree.
//
/*! \file ROMol.h
 
  \brief Defines the primary molecule class \c ROMol as well as associated
  typedefs
 
*/
 
#include <RDGeneral/export.h>
#ifndef RD_ROMOL_H
#define RD_ROMOL_H
 
/// Std stuff
#include <cstddef>
#include <iterator>
#include <utility>
#include <map>
#include <ranges>
#include <limits>
 
// boost stuff
#include <RDGeneral/BoostStartInclude.h>
#include <boost/graph/adjacency_list.hpp>
#include <boost/smart_ptr.hpp>
#include <boost/dynamic_bitset.hpp>
 
#ifdef RDK_USE_BOOST_SERIALIZATION
#include <boost/serialization/split_member.hpp>
#endif
#include <RDGeneral/BoostEndInclude.h>
 
// our stuff
#include <RDGeneral/types.h>
#include <RDGeneral/RDProps.h>
#include "Atom.h"
#include "Bond.h"
#include "Conformer.h"
#include "SubstanceGroup.h"
#include "StereoGroup.h"
#include "RingInfo.h"
 
namespace RDKit {
class SubstanceGroup;
class Atom;
class Bond;
//! This is the BGL type used to store the topology:
typedef boost::adjacency_list<boost::vecS, boost::vecS, boost::undirectedS,
                              Atom *, Bond *>
    MolGraph;
class MolPickler;
class RWMol;
class QueryAtom;
class QueryBond;
class RingInfo;
 
template <class T1, class T2>
class AtomIterator_;
class BondIterator_;
class ConstBondIterator_;
 
template <class T1, class T2>
class AromaticAtomIterator_;
template <class T1, class T2>
class HeteroatomIterator_;
template <class T1, class T2>
class QueryAtomIterator_;
template <class T1, class T2>
class MatchingAtomIterator_;
 
RDKIT_GRAPHMOL_EXPORT extern const int ci_RIGHTMOST_ATOM;
RDKIT_GRAPHMOL_EXPORT extern const int ci_LEADING_BOND;
RDKIT_GRAPHMOL_EXPORT extern const int ci_ATOM_HOLDER;
 
//! ROMol is a molecule class that is intended to have a fixed topology
/*!
  This is the primary class for most molecule operations.
 
  If you need to be manipulating the molecule (e.g. adding or deleting
  atoms or bonds, use an RWMol instead.
 
  <b>Notes:</b>
    - each ROMol maintains a Dict of \c properties:
        - Each \c property is keyed by name and can store an
          arbitrary type.
        - \c Properties can be marked as \c calculated, in which case
          they will be cleared when the \c clearComputedProps() method
          is called.
        - Because they have no impact upon chemistry, all \c property
          operations are \c const, this allows extra flexibility for
          clients who need to store extra data on ROMol objects.
 
    - each ROMol has collections of \c bookmarks for Atoms and Bonds:
        - the Atom bookmarks and Bond bookmarks are stored separately
          from each other
        - each \c bookmark, an integer, can map to more than one
          Atom or Bond
        - these are currently used in molecule construction, but
          could also be useful for reaction mapping and the like
 
    - information about rings (SSSR and the like) is stored in the
      molecule's RingInfo pointer.
 
 */
 
//! \name C++11 Iterators
 
template <class Graph, class Vertex,
          class Iterator = typename Graph::vertex_iterator,
          bool CheckedAtoms = false, bool CheckedBonds = false>
struct CXXAtomIterator {
  Graph *graph;
  Iterator vstart, vend;
 
  struct CXXAtomIter {
    using iterator_category = std::random_access_iterator_tag;
    using difference_type = std::ptrdiff_t;
    using value_type = Vertex;
    using pointer = Vertex *;
    using reference = Vertex &;
    using const_reference = Vertex const &;
 
    Graph *graph = nullptr;
    Iterator pos;
    size_t osizeAtoms{0};
    size_t osizeBonds{0};
 
    inline void checkIterator() const {
      if ((CheckedAtoms && boost::num_vertices(*graph) != osizeAtoms) ||
          (CheckedBonds && boost::num_edges(*graph) != osizeBonds)) {
        throw std::runtime_error("molecule modified during iteration");
      }
    }
 
    CXXAtomIter() {};
 
    CXXAtomIter(Graph *graph, Iterator pos) : graph(graph), pos(pos) {
      if (CheckedAtoms) {
        osizeAtoms = boost::num_vertices(*graph);
      }
      if (CheckedBonds) {
        osizeBonds = boost::num_edges(*graph);
      }
    }
 
    // we only return const references since we don't want clients modifying the
    // graph itself through these iterators
    const_reference operator*() const {
      checkIterator();
      return (*graph)[*pos];
    }
 
    // we only return const references since we don't want clients modifying the
    // graph itself through these iterators
    const_reference operator[](difference_type n) const {
      checkIterator();
      return (*graph)[*(pos + n)];
    }
 
    CXXAtomIter &operator++() {
      ++pos;
      return *this;
    }
    CXXAtomIter operator++(int) {
      CXXAtomIter tmp = *this;
      ++(*this);
      return tmp;
    }
    CXXAtomIter &operator--() {
      --pos;
      return *this;
    }
    CXXAtomIter operator+(difference_type n) const {
      return CXXAtomIter(graph, pos + n);
    }
    CXXAtomIter operator-(difference_type n) const {
      return CXXAtomIter(graph, pos - n);
    }
 
    CXXAtomIter operator--(int) {
      CXXAtomIter tmp = *this;
      --(*this);
      return tmp;
    }
    CXXAtomIter &operator+=(difference_type n) {
      pos += n;
      return *this;
    }
    CXXAtomIter &operator-=(difference_type n) {
      pos -= n;
      return *this;
    }
    difference_type operator-(const CXXAtomIter &other) const {
      return pos - other.pos;
    }
    friend CXXAtomIter operator+(difference_type n, const CXXAtomIter &it) {
      return CXXAtomIter(it.graph, it.pos + n);
    }
 
    bool operator==(const CXXAtomIter &other) const {
      return graph == other.graph && pos == other.pos;
    }
    bool operator!=(const CXXAtomIter &other) const {
      return !(*this == other);
    }
    bool operator<(const CXXAtomIter &other) const { return pos < other.pos; }
    bool operator<=(const CXXAtomIter &other) const { return pos <= other.pos; }
    bool operator>(const CXXAtomIter &other) const { return pos > other.pos; }
    bool operator>=(const CXXAtomIter &other) const { return pos >= other.pos; }
  };
 
  CXXAtomIterator(Graph *graph) : graph(graph) {
    std::tie(vstart, vend) = boost::vertices(*graph);
  }
  CXXAtomIterator(Graph *graph, Iterator start, Iterator end)
      : graph(graph), vstart(start), vend(end) {};
  CXXAtomIter begin() { return {graph, vstart}; }
  CXXAtomIter end() { return {graph, vend}; }
  size_t size() const { return vend - vstart; }
};
// clang-format off
static_assert(
    std::ranges::random_access_range<CXXAtomIterator<MolGraph, Atom *>> 
    and std::ranges::sized_range<CXXAtomIterator<MolGraph, Atom *>>
  );
// clang-format on
 
template <class Graph, class Edge,
          class Iterator = typename Graph::edge_iterator, bool Checked = false>
struct CXXBondIterator {
  Graph *graph;
  Iterator vstart, vend;
 
  struct CXXBondIter {
    using iterator_category = std::bidirectional_iterator_tag;
    using difference_type = std::ptrdiff_t;
    using value_type = Edge;
    using pointer = Edge *;
    using reference = Edge &;
    using const_reference = Edge const &;
 
    Graph *graph = nullptr;
    Iterator pos;
    size_t osize{0};
 
    CXXBondIter() {};
 
    CXXBondIter(Graph *graph, Iterator pos) : graph(graph), pos(pos) {
      if (Checked) {
        osize = boost::num_edges(*graph);
      }
    }
    // we only return const references since we don't want clients modifying the
    // graph itself through these iterators
    const_reference operator*() const {
      if (Checked) {
        if (boost::num_edges(*graph) != osize) {
          throw std::runtime_error("molecule modified during iteration");
        }
      }
      return (*graph)[*pos];
    }
    CXXBondIter &operator++() {
      ++pos;
      return *this;
    }
    CXXBondIter operator++(int) {
      CXXBondIter tmp = *this;
      ++(*this);
      return tmp;
    }
    CXXBondIter &operator--() {
      --pos;
      return *this;
    }
    CXXBondIter operator--(int) {
      CXXBondIter tmp = *this;
      --(*this);
      return tmp;
    }
    bool operator==(const CXXBondIter &other) const {
      return graph == other.graph && pos == other.pos;
    }
    bool operator!=(const CXXBondIter &other) const {
      return !(*this == other);
    }
  };
 
  CXXBondIterator(Graph *graph) : graph(graph) {
    auto vs = boost::edges(*graph);
    vstart = vs.first;
    vend = vs.second;
  }
  CXXBondIterator(Graph *graph, Iterator start, Iterator end)
      : graph(graph), vstart(start), vend(end) {};
  CXXBondIter begin() { return {graph, vstart}; }
  CXXBondIter end() { return {graph, vend}; }
  size_t size() const {
    // bond iterators aren't random access, so we can't just do vend - vstart
    // here. Instead we have to iterate through;
    size_t count = 0;
    for (auto it = vstart; it != vend; ++it) {
      ++count;
    }
    return count;
  }
};
// we don't model sized_range because size() is O(N)
static_assert(
    std::ranges::bidirectional_range<CXXBondIterator<MolGraph, Bond *>>);
 
class RDKIT_GRAPHMOL_EXPORT ROMol : public RDProps {
 public:
  friend class MolPickler;
  friend class RWMol;
 
  //! \cond TYPEDEFS
 
  //! \name typedefs
  //! @{
  typedef MolGraph::vertex_descriptor vertex_descriptor;
  typedef MolGraph::edge_descriptor edge_descriptor;
 
  typedef MolGraph::edge_iterator EDGE_ITER;
  typedef MolGraph::out_edge_iterator OEDGE_ITER;
  typedef MolGraph::vertex_iterator VERTEX_ITER;
  typedef MolGraph::adjacency_iterator ADJ_ITER;
  typedef std::pair<EDGE_ITER, EDGE_ITER> BOND_ITER_PAIR;
  typedef std::pair<OEDGE_ITER, OEDGE_ITER> OBOND_ITER_PAIR;
  typedef std::pair<VERTEX_ITER, VERTEX_ITER> ATOM_ITER_PAIR;
  typedef std::pair<ADJ_ITER, ADJ_ITER> ADJ_ITER_PAIR;
 
  typedef std::vector<Atom *> ATOM_PTR_VECT;
  typedef ATOM_PTR_VECT::iterator ATOM_PTR_VECT_I;
  typedef ATOM_PTR_VECT::const_iterator ATOM_PTR_VECT_CI;
  typedef std::vector<Bond *> BOND_PTR_VECT;
  typedef BOND_PTR_VECT::iterator BOND_PTR_VECT_I;
  typedef BOND_PTR_VECT::const_iterator BOND_PTR_VECT_CI;
 
  typedef std::list<Atom *> ATOM_PTR_LIST;
  typedef ATOM_PTR_LIST::iterator ATOM_PTR_LIST_I;
  typedef ATOM_PTR_LIST::const_iterator ATOM_PTR_LIST_CI;
  typedef std::list<Bond *> BOND_PTR_LIST;
  typedef BOND_PTR_LIST::iterator BOND_PTR_LIST_I;
  typedef BOND_PTR_LIST::const_iterator BOND_PTR_LIST_CI;
 
  // list of conformations
  typedef std::list<CONFORMER_SPTR> CONF_SPTR_LIST;
  typedef CONF_SPTR_LIST::iterator CONF_SPTR_LIST_I;
  typedef CONF_SPTR_LIST::const_iterator CONF_SPTR_LIST_CI;
  typedef std::pair<CONF_SPTR_LIST_I, CONF_SPTR_LIST_I> CONFS_I_PAIR;
 
  // ROFIX: these will need to be readonly somehow?
  typedef std::map<int, ATOM_PTR_LIST> ATOM_BOOKMARK_MAP;
  typedef std::map<int, BOND_PTR_LIST> BOND_BOOKMARK_MAP;
 
  typedef class AtomIterator_<Atom, ROMol> AtomIterator;
  typedef class AtomIterator_<const Atom, const ROMol> ConstAtomIterator;
  typedef class BondIterator_ BondIterator;
  typedef class ConstBondIterator_ ConstBondIterator;
  typedef class AromaticAtomIterator_<Atom, ROMol> AromaticAtomIterator;
  typedef class AromaticAtomIterator_<const Atom, const ROMol>
      ConstAromaticAtomIterator;
  typedef class HeteroatomIterator_<Atom, ROMol> HeteroatomIterator;
  typedef class HeteroatomIterator_<const Atom, const ROMol>
      ConstHeteroatomIterator;
  typedef class QueryAtomIterator_<Atom, ROMol> QueryAtomIterator;
  typedef class QueryAtomIterator_<const Atom, const ROMol>
      ConstQueryAtomIterator;
  typedef class MatchingAtomIterator_<Atom, ROMol> MatchingAtomIterator;
  typedef class MatchingAtomIterator_<const Atom, const ROMol>
      ConstMatchingAtomIterator;
 
  typedef CONF_SPTR_LIST_I ConformerIterator;
  typedef CONF_SPTR_LIST_CI ConstConformerIterator;
 
  //! @}
  //! \endcond
 
  //! C++11 Range iterator
  /*!
    <b>Usage</b>
    \code
      for(auto atom : mol.atoms()) {
         atom->getIdx();
      };
    \endcode
   */
 
  CXXAtomIterator<MolGraph, Atom *> atoms() { return {&d_graph}; }
 
  CXXAtomIterator<const MolGraph, Atom *const> atoms() const {
    return {&d_graph};
  }
  // returns an iterator that will throw if the number of atoms changes during
  // iteration
  CXXAtomIterator<MolGraph, Atom *, MolGraph::vertex_iterator, true>
  checkedAtoms() {
    return {&d_graph};
  }
  // \overload
  CXXAtomIterator<const MolGraph, Atom *const, MolGraph::vertex_iterator, true>
  checkedAtoms() const {
    return {&d_graph};
  }
 
  CXXAtomIterator<const MolGraph, Atom *const, MolGraph::adjacency_iterator>
  atomNeighbors(Atom const *at) const {
    auto pr = getAtomNeighbors(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  CXXAtomIterator<MolGraph, Atom *, MolGraph::adjacency_iterator> atomNeighbors(
      Atom const *at) {
    auto pr = getAtomNeighbors(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  CXXBondIterator<const MolGraph, Bond *const, MolGraph::out_edge_iterator>
  atomBonds(Atom const *at) const {
    auto pr = getAtomBonds(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  CXXBondIterator<MolGraph, Bond *, MolGraph::out_edge_iterator> atomBonds(
      Atom const *at) {
    auto pr = getAtomBonds(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  // returns an iterator that will throw if the number of atoms or bonds changes
  // during iteration
  CXXAtomIterator<const MolGraph, Atom *const, MolGraph::adjacency_iterator,
                  true, true>
  checkedAtomNeighbors(Atom const *at) const {
    auto pr = getAtomNeighbors(at);
    return {&d_graph, pr.first, pr.second};
  }
  // \overload
  CXXAtomIterator<MolGraph, Atom *, MolGraph::adjacency_iterator, true, true>
  checkedAtomNeighbors(Atom const *at) {
    auto pr = getAtomNeighbors(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  // returns an iterator that will throw if the number of bonds changes during
  // iteration
  CXXBondIterator<const MolGraph, Bond *const, MolGraph::out_edge_iterator,
                  true>
  checkedAtomBonds(Atom const *at) const {
    auto pr = getAtomBonds(at);
    return {&d_graph, pr.first, pr.second};
  }
  // \overload
  CXXBondIterator<MolGraph, Bond *, MolGraph::out_edge_iterator, true>
  checkedAtomBonds(Atom const *at) {
    auto pr = getAtomBonds(at);
    return {&d_graph, pr.first, pr.second};
  }
 
  /*!
  <b>Usage</b>
  \code
    for(auto bond : mol.bonds()) {
       bond->getIdx();
    };
  \endcode
 */
 
  CXXBondIterator<MolGraph, Bond *> bonds() { return {&d_graph}; }
 
  CXXBondIterator<const MolGraph, Bond *const> bonds() const {
    return {&d_graph};
  }
  // returns an iterator that will throw if the number of bonds changes during
  // iteration
  CXXBondIterator<MolGraph, Bond *, MolGraph::edge_iterator, true>
  checkedBonds() {
    return {&d_graph};
  }
  // \overload
  CXXBondIterator<const MolGraph, Bond *const, MolGraph::edge_iterator, true>
  checkedBonds() const {
    return {&d_graph};
  }
 
  ROMol() : RDProps() { initMol(); }
 
  //! copy constructor with a twist
  /*!
    \param other     the molecule to be copied
    \param quickCopy (optional) if this is true, the resulting ROMol will not
         copy any of the properties or bookmarks and conformers from \c other.
    This can
         make the copy substantially faster (thus the name).
    \param confId (optional) if this is >=0, the resulting ROMol will contain
    only
         the specified conformer from \c other.
  */
  ROMol(const ROMol &other, bool quickCopy = false, int confId = -1)
      : RDProps() {
    dp_ringInfo = nullptr;
    initFromOther(other, quickCopy, confId);
    numBonds = rdcast<unsigned int>(boost::num_edges(d_graph));
  }
  //! construct a molecule from a pickle string
  ROMol(const std::string &binStr);
  //! construct a molecule from a pickle string
  ROMol(const std::string &binStr, unsigned int propertyFlags);
 
  ROMol(ROMol &&o) noexcept
      : RDProps(std::move(o)),
        d_graph(std::move(o.d_graph)),
        d_atomBookmarks(std::move(o.d_atomBookmarks)),
        d_bondBookmarks(std::move(o.d_bondBookmarks)),
        d_confs(std::move(o.d_confs)),
        d_sgroups(std::move(o.d_sgroups)),
        d_stereo_groups(std::move(o.d_stereo_groups)),
        numBonds(o.numBonds) {
    for (auto atom : atoms()) {
      atom->setOwningMol(this);
    }
    for (auto bond : bonds()) {
      bond->setOwningMol(this);
    }
    for (auto conf : d_confs) {
      conf->setOwningMol(this);
    }
    for (auto &sg : d_sgroups) {
      sg.setOwningMol(this);
    }
    o.d_graph.clear();
    o.numBonds = 0;
    dp_ringInfo = std::exchange(o.dp_ringInfo, nullptr);
    dp_delAtoms = std::exchange(o.dp_delAtoms, nullptr);
    dp_delBonds = std::exchange(o.dp_delBonds, nullptr);
  }
  ROMol &operator=(ROMol &&o) noexcept {
    if (this == &o) {
      return *this;
    }
    RDProps::operator=(std::move(o));
    d_graph = std::move(o.d_graph);
    d_atomBookmarks = std::move(o.d_atomBookmarks);
    d_bondBookmarks = std::move(o.d_bondBookmarks);
    if (dp_ringInfo) {
      delete dp_ringInfo;
    }
    dp_ringInfo = std::exchange(o.dp_ringInfo, nullptr);
 
    d_confs = std::move(o.d_confs);
    d_sgroups = std::move(o.d_sgroups);
    d_stereo_groups = std::move(o.d_stereo_groups);
    dp_delAtoms = std::exchange(o.dp_delAtoms, nullptr);
    dp_delBonds = std::exchange(o.dp_delBonds, nullptr);
    numBonds = o.numBonds;
    o.numBonds = 0;
 
    for (auto atom : atoms()) {
      atom->setOwningMol(this);
    }
    for (auto bond : bonds()) {
      bond->setOwningMol(this);
    }
    for (auto conf : d_confs) {
      conf->setOwningMol(this);
    }
    for (auto &sg : d_sgroups) {
      sg.setOwningMol(this);
    }
 
    o.d_graph.clear();
    return *this;
  }
 
  ROMol &operator=(const ROMol &) =
      delete;  // disable assignment, RWMol's support assignment
 
  virtual ~ROMol() { destroy(); }
 
  //! @}
  //! \name Atoms
  //! @{
 
  //! returns our number of atoms
  inline unsigned int getNumAtoms() const {
    return rdcast<unsigned int>(boost::num_vertices(d_graph));
  }
  unsigned int getNumAtoms(bool onlyExplicit) const;
  //! returns our number of heavy atoms (atomic number > 1)
  unsigned int getNumHeavyAtoms() const;
  //! returns a pointer to a particular Atom
  Atom *getAtomWithIdx(unsigned int idx);
  //! \overload
  const Atom *getAtomWithIdx(unsigned int idx) const;
  //! \overload
  template <class U>
  Atom *getAtomWithIdx(const U idx) {
    return getAtomWithIdx(rdcast<unsigned int>(idx));
  }
  //! \overload
  template <class U>
  const Atom *getAtomWithIdx(const U idx) const {
    return getAtomWithIdx(rdcast<unsigned int>(idx));
  }
  //! returns the degree (number of neighbors) of an Atom in the graph
  unsigned int getAtomDegree(const Atom *at) const;
  //! @}
 
  //! \name Bonds
  //! @{
 
  //! returns our number of Bonds
  unsigned int getNumBonds(bool onlyHeavy = 1) const;
  //! returns a pointer to a particular Bond
  Bond *getBondWithIdx(unsigned int idx);
  //! \overload
  const Bond *getBondWithIdx(unsigned int idx) const;
  //! \overload
  template <class U>
  Bond *getBondWithIdx(const U idx) {
    return getBondWithIdx(rdcast<unsigned int>(idx));
  }
  //! \overload
  template <class U>
  const Bond *getBondWithIdx(const U idx) const {
    return getBondWithIdx(rdcast<unsigned int>(idx));
  }
  //! returns a pointer to the bond between two atoms, Null on failure
  Bond *getBondBetweenAtoms(unsigned int idx1, unsigned int idx2);
  //! \overload
  const Bond *getBondBetweenAtoms(unsigned int idx1, unsigned int idx2) const;
  //! \overload
  template <class U, class V>
  Bond *getBondBetweenAtoms(const U idx1, const V idx2) {
    return getBondBetweenAtoms(rdcast<unsigned int>(idx1),
                               rdcast<unsigned int>(idx2));
  }
  //! \overload
  template <class U, class V>
  const Bond *getBondBetweenAtoms(const U idx1, const V idx2) const {
    return getBondBetweenAtoms(rdcast<unsigned int>(idx1),
                               rdcast<unsigned int>(idx2));
  }
 
  //! @}
 
  //! \name Bookmarks
  //! @{
 
  //! associates an Atom pointer with a bookmark
  void setAtomBookmark(Atom *at, int mark) {
    d_atomBookmarks[mark].push_back(at);
  }
  //! associates an Atom pointer with a bookmark
  void replaceAtomBookmark(Atom *at, int mark) {
    d_atomBookmarks[mark].clear();
    d_atomBookmarks[mark].push_back(at);
  }
  //! returns the first Atom associated with the \c bookmark provided
  Atom *getAtomWithBookmark(int mark);
  //! returns the Atom associated with the \c bookmark provided
  //! a check is made to ensure it is the only atom with that bookmark
  Atom *getUniqueAtomWithBookmark(int mark);
  //! returns all Atoms associated with the \c bookmark provided
  ATOM_PTR_LIST &getAllAtomsWithBookmark(int mark);
  //! removes a \c bookmark from our collection
  void clearAtomBookmark(int mark);
  //! removes a particular Atom from the list associated with the \c bookmark
  void clearAtomBookmark(int mark, const Atom *atom);
 
  //! blows out all atomic \c bookmarks
  void clearAllAtomBookmarks() { d_atomBookmarks.clear(); }
  //! queries whether or not any atoms are associated with a \c bookmark
  bool hasAtomBookmark(int mark) const { return d_atomBookmarks.count(mark); }
  //! returns a pointer to all of our atom \c bookmarks
  ATOM_BOOKMARK_MAP *getAtomBookmarks() { return &d_atomBookmarks; }
 
  //! associates a Bond pointer with a bookmark
  void setBondBookmark(Bond *bond, int mark) {
    d_bondBookmarks[mark].push_back(bond);
  }
  //! returns the first Bond associated with the \c bookmark provided
  Bond *getBondWithBookmark(int mark);
  //! returns the Bond associated with the \c bookmark provided
  //! a check is made to ensure it is the only bond with that bookmark
  Bond *getUniqueBondWithBookmark(int mark);
  //! returns all bonds associated with the \c bookmark provided
  BOND_PTR_LIST &getAllBondsWithBookmark(int mark);
  //! removes a \c bookmark from our collection
  void clearBondBookmark(int mark);
  //! removes a particular Bond from the list associated with the \c bookmark
  void clearBondBookmark(int mark, const Bond *bond);
 
  //! blows out all bond \c bookmarks
  void clearAllBondBookmarks() { d_bondBookmarks.clear(); }
  //! queries whether or not any bonds are associated with a \c bookmark
  bool hasBondBookmark(int mark) const { return d_bondBookmarks.count(mark); }
  //! returns a pointer to all of our bond \c bookmarks
  BOND_BOOKMARK_MAP *getBondBookmarks() { return &d_bondBookmarks; }
 
  //! @}
 
  //! \name Conformers
  //! @{
 
  //! return the conformer with a specified ID
  //! if the ID is negative the first conformation will be returned
  const Conformer &getConformer(int id = -1) const;
 
  //! return the conformer with a specified ID
  //! if the ID is negative the first conformation will be returned
  Conformer &getConformer(int id = -1);
 
  //! Delete the conformation with the specified ID
  void removeConformer(unsigned int id);
 
  //! Clear all the conformations on the molecule
  void clearConformers() { d_confs.clear(); }
 
  //! Add a new conformation to the molecule
  /*!
    \param conf - conformation to be added to the molecule, this molecule takes
    ownership
                  of the conformer
    \param assignId - a unique ID will be assigned to the conformation if
    true
                      otherwise it is assumed that the conformation already has
    an (unique) ID set
  */
  unsigned int addConformer(Conformer *conf, bool assignId = false);
 
  inline unsigned int getNumConformers() const {
    return rdcast<unsigned int>(d_confs.size());
  }
 
  //! \name Topology
  //! @{
 
  //! returns a pointer to our RingInfo structure
  //! <b>Note:</b> the client should not delete this.
  RingInfo *getRingInfo() const { return dp_ringInfo; }
 
  //! provides access to all neighbors around an Atom
  /*!
    \param at the atom whose neighbors we are looking for
 
    <b>Usage</b>
    \code
      ... mol is a const ROMol & ...
      ... atomPtr is a const Atom * ...
      ... requires #include <boost/range/iterator_range.hpp>
      for (const auto &nbri :
           boost::make_iterator_range(m.getAtomNeighbors(atomPtr))) {
        const auto &nbr = (*m)[nbri];
        // nbr is an atom pointer
      }
 
    \endcode
 
  */
  ADJ_ITER_PAIR getAtomNeighbors(Atom const *at) const;
 
  //! provides access to all Bond objects connected to an Atom
  /*!
    \param at the atom whose neighbors we are looking for
 
    <b>Usage</b>
    \code
      ... mol is a const ROMol & ...
      ... atomPtr is a const Atom * ...
      ... requires #include <boost/range/iterator_range.hpp>
      for (const auto &nbri :
           boost::make_iterator_range(m.getAtomBonds(atomPtr))) {
        const auto &nbr = (*m)[nbri];
        // nbr is a bond pointer
      }
    \endcode
    or, if you need a non-const Bond *:
    \code
      ... mol is a const ROMol & ...
      ... atomPtr is a const Atom * ...
      ... requires #include <boost/range/iterator_range.hpp>
      for (const auto &nbri :
           boost::make_iterator_range(m.getAtomBonds(atomPtr))) {
        auto nbr = (*m)[nbri];
        // nbr is a bond pointer
      }
    \endcode
 
 
  */
  OBOND_ITER_PAIR getAtomBonds(Atom const *at) const;
 
  //! returns an iterator pair for looping over all Atoms
  /*!
 
    <b>Usage</b>
    \code
 
      ROMol::VERTEX_ITER atBegin,atEnd;
      boost::tie(atBegin,atEnd) = mol.getVertices();
      while(atBegin!=atEnd){
        ATOM_SPTR at2=mol[*atBegin];
        ... do something with the Atom ...
        ++atBegin;
      }
    \endcode
  */
  ATOM_ITER_PAIR getVertices();
  //! returns an iterator pair for looping over all Bonds
  /*!
 
    <b>Usage</b>
    \code
 
      ROMol::EDGE_ITER firstB,lastB;
      boost::tie(firstB,lastB) = mol.getEdges();
      while(firstB!=lastB){
        BOND_SPTR bond = mol[*firstB];
        ... do something with the Bond ...
        ++firstB;
      }
    \endcode
  */
  BOND_ITER_PAIR getEdges();
  //! \overload
  ATOM_ITER_PAIR getVertices() const;
  //! \overload
  BOND_ITER_PAIR getEdges() const;
 
  //! brief returns a pointer to our underlying BGL object
  /*!
      This can be useful if you need to call other BGL algorithms:
 
      Here's an example:
      \code
         ... mol is a const ROMol ...
         ... mapping is an INT_VECT ...
         mapping.resize(mol.getNumAtoms());
         const MolGraph &G_p = mol.getTopology();
         int res = boost::connected_components(G_p,&mapping[0]);
      \endcode
   */
  MolGraph const &getTopology() const { return d_graph; }
  //! @}
 
  //! \name Iterators
  //! @{
 
  //! get an AtomIterator pointing at our first Atom
  AtomIterator beginAtoms();
  //! \overload
  ConstAtomIterator beginAtoms() const;
  //! get an AtomIterator pointing at the end of our Atoms
  AtomIterator endAtoms();
  //! \overload
  ConstAtomIterator endAtoms() const;
  //! get a BondIterator pointing at our first Bond
  BondIterator beginBonds();
  //! \overload
  ConstBondIterator beginBonds() const;
  //! get a BondIterator pointing at the end of our Bonds
  BondIterator endBonds();
  //! \overload
  ConstBondIterator endBonds() const;
 
  //! get an AtomIterator pointing at our first aromatic Atom
  AromaticAtomIterator beginAromaticAtoms();
  //! \overload
  ConstAromaticAtomIterator beginAromaticAtoms() const;
  //! get an AtomIterator pointing at the end of our Atoms
  AromaticAtomIterator endAromaticAtoms();
  //! \overload
  ConstAromaticAtomIterator endAromaticAtoms() const;
 
  //! get an AtomIterator pointing at our first hetero Atom
  HeteroatomIterator beginHeteros();
  //! \overload
  ConstHeteroatomIterator beginHeteros() const;
  //! get an AtomIterator pointing at the end of our Atoms
  HeteroatomIterator endHeteros();
  //! \overload
  ConstHeteroatomIterator endHeteros() const;
 
  //! if the Mol has any Query atoms or bonds
  bool hasQuery() const;
 
  //! get an AtomIterator pointing at our first Atom that matches \c query
  QueryAtomIterator beginQueryAtoms(QueryAtom const *query);
  //! \overload
  ConstQueryAtomIterator beginQueryAtoms(QueryAtom const *) const;
  //! get an AtomIterator pointing at the end of our Atoms
  QueryAtomIterator endQueryAtoms();
  //! \overload
  ConstQueryAtomIterator endQueryAtoms() const;
 
  //! get an AtomIterator pointing at our first Atom that matches \c query
  MatchingAtomIterator beginMatchingAtoms(bool (*query)(Atom *));
  //! \overload
  ConstMatchingAtomIterator beginMatchingAtoms(
      bool (*query)(const Atom *)) const;
  //! get an AtomIterator pointing at the end of our Atoms
  MatchingAtomIterator endMatchingAtoms();
  //! \overload
  ConstMatchingAtomIterator endMatchingAtoms() const;
 
  inline ConformerIterator beginConformers() { return d_confs.begin(); }
 
  inline ConformerIterator endConformers() { return d_confs.end(); }
 
  inline ConstConformerIterator beginConformers() const {
    return d_confs.begin();
  }
 
  inline ConstConformerIterator endConformers() const { return d_confs.end(); }
 
  //! @}
 
  //! \name Properties
  //! @{
 
  //! clears all of our \c computed \c properties
  void clearComputedProps(bool includeRings = true) const;
  //! calculates any of our lazy \c properties
  /*!
    <b>Notes:</b>
       - this calls \c updatePropertyCache() on each of our Atoms and Bonds
  */
  void updatePropertyCache(bool strict = true);
 
  bool needsUpdatePropertyCache() const;
  void clearPropertyCache();
 
  //! @}
 
  //! \name Misc
  //! @{
  //! sends some debugging info to a stream
  void debugMol(std::ostream &str) const;
  //! @}
 
  Atom *operator[](const vertex_descriptor &v) { return d_graph[v]; }
  const Atom *operator[](const vertex_descriptor &v) const {
    return d_graph[v];
  }
 
  Bond *operator[](const edge_descriptor &e) { return d_graph[e]; }
  const Bond *operator[](const edge_descriptor &e) const { return d_graph[e]; }
 
  //! Gets a reference to the groups of atoms with relative stereochemistry
  /*!
    Stereo groups are also called enhanced stereochemistry in the SDF/Mol3000
    file format.
  */
  const std::vector<StereoGroup> &getStereoGroups() const {
    return d_stereo_groups;
  }
 
  //! Sets groups of atoms with relative stereochemistry
  /*!
    \param stereo_groups the new set of stereo groups. All will be replaced.
 
    Stereo groups are also called enhanced stereochemistry in the SDF/Mol3000
    file format. stereo_groups should be std::move()ed into this function.
  */
  void setStereoGroups(std::vector<StereoGroup> stereo_groups);
 
#ifdef RDK_USE_BOOST_SERIALIZATION
  //! \name boost::serialization support
  //! @{
  template <class Archive>
  void save(Archive &ar, const unsigned int version) const;
  template <class Archive>
  void load(Archive &ar, const unsigned int version);
  BOOST_SERIALIZATION_SPLIT_MEMBER()
  //! @}
#endif
 
 private:
  MolGraph d_graph;
  ATOM_BOOKMARK_MAP d_atomBookmarks;
  BOND_BOOKMARK_MAP d_bondBookmarks;
  RingInfo *dp_ringInfo = nullptr;
  CONF_SPTR_LIST d_confs;
  std::vector<SubstanceGroup> d_sgroups;
  std::vector<StereoGroup> d_stereo_groups;
  std::unique_ptr<boost::dynamic_bitset<>> dp_delAtoms = nullptr;
  std::unique_ptr<boost::dynamic_bitset<>> dp_delBonds = nullptr;
 
  friend RDKIT_GRAPHMOL_EXPORT std::vector<SubstanceGroup> &getSubstanceGroups(
      ROMol &);
  friend RDKIT_GRAPHMOL_EXPORT const std::vector<SubstanceGroup> &
  getSubstanceGroups(const ROMol &);
  void clearSubstanceGroups() { d_sgroups.clear(); }
 
 protected:
  unsigned int numBonds{0};
#ifndef WIN32
 
 private:
#endif
  void initMol();
  virtual void destroy();
  //! adds an Atom to our collection
  /*!
    \param atom          pointer to the Atom to add
    \param updateLabel   (optional) if this is true, the new Atom will be
                         our \c activeAtom
    \param takeOwnership (optional) if this is true, we take ownership of \c
    atom
                         instead of copying it.
 
    \return the index of the new atom
  */
  unsigned int addAtom(Atom *atom, bool updateLabel = true,
                       bool takeOwnership = false);
  //! adds a Bond to our collection
  /*!
    \param bond          pointer to the Bond to add
    \param takeOwnership (optional) if this is true, we take ownership of \c
    bond
                         instead of copying it.
 
    \return the new number of bonds
  */
  unsigned int addBond(Bond *bond, bool takeOwnership = false);
 
  //! adds a Bond to our collection
  /*!
    \param bond          pointer to the Bond to add
 
    \return the new number of bonds
 
    <b>Note:</b> since this is using a smart pointer, we don't need to worry
    about
    issues of ownership.
  */
  void initFromOther(const ROMol &other, bool quickCopy, int confId);
};
 
typedef std::vector<ROMol> MOL_VECT;
typedef boost::shared_ptr<ROMol> ROMOL_SPTR;
typedef std::vector<ROMol *> MOL_PTR_VECT;
typedef std::vector<ROMOL_SPTR> MOL_SPTR_VECT;
 
typedef MOL_PTR_VECT::const_iterator MOL_PTR_VECT_CI;
typedef MOL_PTR_VECT::iterator MOL_PTR_VECT_I;
};  // namespace RDKit
#endif