Files
rdkit/Code/GraphMol/CIPLabeler/Sort.cpp
Ric d54e77e375 Add new CIP labelling algorithm (#3234)
* add port of centres

* Several changes:
    - Added a test based on RDKit issue 2984
        (default RDKit fails it, this gets it right)
    - Use bond directions for bond stereo (label is no longer required)
    - Fix bugs in rules 4b and 5new
    - Fix some mem errors
    - clang-formatted
    - some other minor cleanups

* Several changes and some improvements:
    - Added LGPL license, as well as a mention in the doc.
    - Fix/update/add some comments
    - Fix typo/bug in Mancude calculation
    - Fix bug in rules 4b, 5New
    - Fix Sp2 Bond dir reference
    - Re clang-format
    - other minor changes suggested by Dan

* Another bunch of changes:
  - require integer-order bonds; kekulize when required
  - fix fraction comparison
  - rename sq Cis/Trans e/z
  - replace queues with vectors
  - update copyright notices
  - revert LGPL changes
  - fix Asymmetric typo

* move to separate lib/mod, add python validation test

* Moving away from the original implementation:
    - Rename to CIPLabeler
    - Remove the abstraction layer
    - Remove some stats stuff
    - Push some CIPMol functions down to Node
    - Use RDKit's isotope info

* Another bundle of changes. The most relevant ones:
    - fix parity translation
    - use cis trans as bond reference -- breaks #2984 test
    - kill a lot of unused code
    - use lists for queues
    - store nodes and edges in digraph
    - add prefixes to class data member names
    - update changeRoot() test
    - use fastFindRings() for mancude rings
    - update docs
    - add references to the scientific paper
    - Document the Mancude functions
    - Fix Mancude atom types and their comments
    - remove mol data member from SequenceRule
    - replace Fraction with boost::rational
    - update comments, docstrings and the doc

* fix building the test

* Changes here include:
    - adding bitset overload for the labeling function
    - python wrap of the overload
    - handling trigonal pyramids with implicit H
    - setting bond labels sets stereo atoms, cis/trans
    - nix LEFT/RIGHT/TOGETHER/OPPOSITE constants
    - don't use GLOB in cmake
    - a decent amount of refactoring

* Minor edits to new_CIP_labeling (#6)

* Some changes for clarity

Added some documentation and changed some variable names to match
my understanding. Also a ran clang-tidy to ensure that all blocks
were brace-enclosed.

* Return a reference instead of a copy for performance

This is called many times and showed up after some light
profiling. This change bumped throughput by about 20%

* move out of Graphmol

* move .hpp headers to .h

* update documentation; add label set of atoms test

* Address comments:
    - Added references to centres to CIPLabeler.h and Python Wrap.
    - Update validation test to skip sanitization.
    - Document mancude fractional atomic number calculation.
    - Use unittest assertions in python test.
    - Update mancude docstrings to 'resonance' instad of 'tautomers'.
    - Rename prioritise() to prioritize().
    - Add postcondition to check carriers size in Tetrahedral.cpp.
    - Use getNeighbors() in Tetrahedral.cpp.
    - Move findStereoAtoms to Chirality namespace.
    - Move code back into GraphMol.
    - Fix typos and reformat doc.

* More comments:
    - Mention why we use boost's unordered map rather than the std one.
    - Fix include in Python wrapper.

* Addressed second batch of comments:
    - fix the bug in rule 4b
    - fix docstring for rule 2
    - move atomic mass calculation from rule 2 to node
    - addressed some build warnings
    - simplify sp2bond::label(comp)
    - add start/end atoms to Sp2Bond constructor
    - update system/local includes

Co-authored-by: Dan N <dan.nealschneider@schrodinger.com>
2020-07-07 20:34:33 +02:00

93 lines
2.2 KiB
C++

//
//
// Copyright (C) 2020 Schrödinger, LLC
//
// @@ 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.
//
#include "Sort.h"
#include "rules/SequenceRule.h"
namespace RDKit {
namespace CIPLabeler {
Sort::Sort(const SequenceRule *comparator) : d_rules{comparator} {}
Sort::Sort(std::vector<const SequenceRule *> comparators)
: d_rules{std::move(comparators)} {}
const std::vector<const SequenceRule *> &Sort::getRules() const {
return d_rules;
}
Priority Sort::prioritize(const Node *node, std::vector<Edge *> &edges,
bool deep) const {
bool unique = true;
int numPseudoAsym = 0;
for (auto i = 0u; i < edges.size(); ++i)
for (auto j = i; j > 0; --j) {
int cmp = compareSubstituents(node, edges[j - 1], edges[j], deep);
if (cmp < -1 || cmp > +1) {
++numPseudoAsym;
}
if (cmp < 0) {
std::swap(edges[j], edges[j - 1]);
} else {
if (cmp == 0) {
unique = false;
}
break;
}
}
return {unique, numPseudoAsym == 1};
}
int Sort::compareSubstituents(const Node *node, const Edge *a, const Edge *b,
bool deep) const {
// ensure 'out' edges are moved to the front
if (!a->isBeg(node) && b->isBeg(node)) {
return +1;
} else if (a->isBeg(node) && !b->isBeg(node)) {
return -1;
}
for (const auto &rule : d_rules) {
int cmp = rule->getComparision(a, b, deep);
if (cmp != 0) {
return cmp;
}
}
return 0;
}
std::vector<std::vector<Edge *>>
Sort::getGroups(const std::vector<Edge *> &sorted) const {
// would be nice to have this integrated whilst sorting - may provide a
// small speed increase but as most of our lists are small we take use
// ugly sort then group approach
std::vector<std::vector<Edge *>> groups;
Edge *prev = nullptr;
for (auto *edge : sorted) {
if (prev == nullptr ||
compareSubstituents(prev->getBeg(), prev, edge, true) != 0) {
groups.emplace_back();
}
prev = edge;
groups.back().push_back(edge);
}
return groups;
}
} // namespace CIPLabeler
} // namespace RDKit