1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
//
//
// 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.
//
#pragma once
#include <RDGeneral/BoostStartInclude.h>
#include <boost/dynamic_bitset.hpp>
#include <RDGeneral/BoostEndInclude.h>
#include <RDGeneral/export.h>
namespace RDKit {
class ROMol;
namespace CIPLabeler_detail {
RDKIT_CIPLABELER_EXPORT bool decrementRemainingCallCountAndCheck();
}
namespace CIPLabeler {
/*
Some very symmetrical mols can cause pseudo infinite processing
(e.g. dodecahedrane)
To avoid this a maxinum number of iterations can be set by the caller as a
parameter to assignCIPLabels.
If that maximum value is exceeded, the following error is thrown
*/
class RDKIT_CIPLABELER_EXPORT MaxIterationsExceeded
: public std::runtime_error {
public:
explicit MaxIterationsExceeded()
: std::runtime_error("Max Iterations Exceeded in CIP label calculation") {
};
};
/**
* Calculate Stereochemical labels based on an accurate implementation
* of the CIP rules.
*
* This is a C++ port of https://github.com/SiMolecule/centres, which was
* originally written by John Mayfield in Java. The original algorithm was
* described in:
*
* Hanson, R. M., Musacchio, S., Mayfield, J. W., Vainio, M. J., Yerin, A.,
* Redkin, D. Algorithmic Analysis of Cahn--Ingold--Prelog Rules of
* Stereochemistry: Proposals for Revised Rules and a Guide for Machine
* Implementation. J. Chem. Inf. Model. 2018, 58, 1755-1765.
*
* \param mol - the molecule to be labelled.
*
* \note only atoms with chiral tags and double bonds with proper
* bond directions will be labelled.
* \note Labels will be stored under the common_properties::_CIPCode
* property of the relevant atoms/bonds.
*/
RDKIT_CIPLABELER_EXPORT void assignCIPLabels(
ROMol &mol, unsigned int maxRecursiveIterations = 0);
/**
* Overload that allows selecting which atoms and/or bonds will be labeled.
*
* \param mol - the molecule to be labelled.
*
* \param atoms - bitset with the atom indexes to be labeled.
*
* \param bonds - bitset with the bond indexes to be labeled.
*
* \param maxRecursiveIterations - maximum number of iterations
* A value of 1,250,000 take about 1 second. Most structures requires
* less than 10,000 iterations. A peptide with MW~3000 took about
* 100 iterations, and a 20,000 mw protein took about 600 iterations.
*
*/
RDKIT_CIPLABELER_EXPORT void assignCIPLabels(
ROMol &mol, const boost::dynamic_bitset<> &atoms,
const boost::dynamic_bitset<> &bonds,
unsigned int maxRecursiveIterations = 0);
} // namespace CIPLabeler
} // namespace RDKit
|
