File: Bond.cpp

package info (click to toggle)
rdkit 201203-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 37,840 kB
  • sloc: cpp: 93,902; python: 51,897; java: 5,192; ansic: 3,497; xml: 2,499; sql: 1,641; yacc: 1,518; lex: 1,076; makefile: 325; fortran: 183; sh: 153; cs: 51
file content (220 lines) | stat: -rw-r--r-- 7,826 bytes parent folder | download
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
// $Id: Bond.cpp 2007 2012-03-28 07:06:44Z glandrum $
//
//  Copyright (C) 2003-2006 Rational Discovery 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.
//

#define NO_IMPORT_ARRAY
#include <boost/python.hpp>
#include <string>

#include <GraphMol/RDKitBase.h>
#include <GraphMol/QueryBond.h>
#include <GraphMol/SmilesParse/SmilesWrite.h>
#include <GraphMol/SmilesParse/SmartsWrite.h>
#include <RDGeneral/types.h>

namespace python = boost::python;
namespace RDKit{

  int BondHasProp(const Bond *bond, const char *key) {
    int res = bond->hasProp(key);
    return res;
  }

  std::string BondGetProp(const Bond *bond, const char *key) {
    if (!bond->hasProp(key)) {
      PyErr_SetString(PyExc_KeyError,key);
      throw python::error_already_set();
    }
    std::string res;
    bond->getProp(key, res);
    return res;
  }

  bool BondIsInRing(const Bond *bond){
    if(!bond->getOwningMol().getRingInfo()->isInitialized()){
      MolOps::findSSSR(bond->getOwningMol());
    }
    return bond->getOwningMol().getRingInfo()->numBondRings(bond->getIdx())!=0;

  }

  bool BondIsInRingSize(const Bond *bond,int size){
    if(!bond->getOwningMol().getRingInfo()->isInitialized()){
      MolOps::findSSSR(bond->getOwningMol());
    }
    return bond->getOwningMol().getRingInfo()->isBondInRingOfSize(bond->getIdx(),size);
    return false;
  }

  INT_VECT getBondStereoAtoms(const Bond *bond){
    return bond->getStereoAtoms();
  }

  std::string BondGetSmarts(const Bond *bond,bool allBondsExplicit){
    std::string res;
    if(bond->hasQuery()){      
      res=SmartsWrite::GetBondSmarts(static_cast<const QueryBond *>(bond));
    } else {
      res=SmilesWrite::GetBondSmiles(bond,-1,false,allBondsExplicit);
    }
    return res;
  }

  
  std::string bondClassDoc="The class to store Bonds.\n\
Note: unlike Atoms, is it currently impossible to construct Bonds from\n\
Python.\n";
struct bond_wrapper {
  static void wrap(){
    python::class_<Bond>("Bond",bondClassDoc.c_str(),python::no_init)

      .def("GetOwningMol",&Bond::getOwningMol,
	   "Returns the Mol that owns this bond.\n",
	   python::return_value_policy<python::reference_existing_object>())

      .def("GetBondType",&Bond::getBondType,
	   "Returns the type of the bond as a BondType\n")
      .def("SetBondType",&Bond::setBondType,
	   "Set the type of the bond as a BondType\n")

      .def("GetBondDir",&Bond::getBondDir,
	   "Returns the type of the bond as a BondDir\n")
      .def("SetBondDir",&Bond::setBondDir,
	   "Set the type of the bond as a BondDir\n")

      .def("GetStereo",&Bond::getStereo,
	   "Returns the CIP-classification of the bond as a BondStereo\n")
      // this is no longer exposed because it requires that stereo atoms
      // be set. This is a task that is tricky and "dangerous".
      //.def("SetStereo",&Bond::setStereo,
      //	   "Set the CIP-classification of the bond as a BondStereo\n")
      .def("GetStereoAtoms",getBondStereoAtoms,
	   "Returns the indices of the atoms setting this bond's stereochemistry.")
      .def("GetValenceContrib",
	   (double (Bond::*)(const Atom *) const)&Bond::getValenceContrib,
	   "Returns the contribution of the bond to the valence of an Atom.\n\n"
	   "  ARGUMENTS:\n\n"
	   "    - atom: the Atom to consider.\n")

      .def("GetIsAromatic",&Bond::getIsAromatic)
      .def("SetIsAromatic",&Bond::setIsAromatic)

      .def("GetIsConjugated",&Bond::getIsConjugated,
	   "Returns whether or not the bond is considered to be conjugated.")
      .def("SetIsConjugated",&Bond::setIsConjugated)

      .def("GetIdx",&Bond::getIdx,
	   "Returns the bond's index (ordering in the molecule)\n")

      .def("GetBeginAtomIdx",&Bond::getBeginAtomIdx,
	   "Returns the index of the bond's first atom.\n")
      .def("GetEndAtomIdx",&Bond::getEndAtomIdx,
	   "Returns the index of the bond's first atom.\n")
      .def("GetOtherAtomIdx",&Bond::getOtherAtomIdx,
	   "Given the index of one of the bond's atoms, returns the\n"
	   "index of the other.\n")

      .def("GetBeginAtom",&Bond::getBeginAtom,
	   python::return_value_policy<python::reference_existing_object>(),
	   "Returns the bond's first atom.\n")
      .def("GetEndAtom",&Bond::getEndAtom,
	   python::return_value_policy<python::reference_existing_object>(),
	   "Returns the bond's second atom.\n")
      .def("GetOtherAtom",&Bond::getOtherAtom,
	   python::return_value_policy<python::reference_existing_object>(),
	   "Given one of the bond's atoms, returns the other one.\n")

      // FIX: query stuff
      .def("Match",(bool (Bond::*)(const Bond *) const)&Bond::Match,
	   "Returns whether or not this bond matches another Bond.\n\n"
	   "  Each Bond (or query Bond) has a query function which is\n"
	   "  used for this type of matching.\n\n"
	   "  ARGUMENTS:\n"
	   "    - other: the other Bond to which to compare\n")

      .def("IsInRingSize",BondIsInRingSize,
	   "Returns whether or not the bond is in a ring of a particular size.\n\n"
	   "  ARGUMENTS:\n"
	   "    - size: the ring size to look for\n")
      .def("IsInRing",BondIsInRing,
	   "Returns whether or not the bond is in a ring of any size.\n\n")

      .def("HasQuery",&Bond::hasQuery,
     "Returns whether or not the bond has an associated query\n\n")

      .def("GetSmarts",BondGetSmarts,
           (python::arg("bond"),
            python::arg("allBondsExplicit")=false),
              "returns the SMARTS (or SMILES) string for a Bond")

      .def("GetProp", BondGetProp,
           "Returns the value of the property.\n\n"
	   "  ARGUMENTS:\n"
	   "    - key: the name of the property to return (a string).\n\n"
	   "  RETURNS: a string\n\n"
	   "  NOTE:\n"
	   "    - If the property has not been set, a KeyError exception will be raised.\n")

      .def("HasProp", BondHasProp,
           "Queries a Bond to see if a particular property has been assigned.\n\n"
	   "  ARGUMENTS:\n"
	   "    - key: the name of the property to check for (a string).\n")

      .def("GetPropNames",&Bond::getPropList,
	   (python::arg("self")),
           "Returns a list of the properties set on the Bond.\n\n"
           )
      
      ;

    python::enum_<Bond::BondType>("BondType")
      .value("UNSPECIFIED",Bond::UNSPECIFIED)
      .value("SINGLE",Bond::SINGLE)
      .value("DOUBLE",Bond::DOUBLE)
      .value("TRIPLE",Bond::TRIPLE)
      .value("QUADRUPLE",Bond::QUADRUPLE)
      .value("QUINTUPLE",Bond::QUINTUPLE)
      .value("HEXTUPLE",Bond::HEXTUPLE)
      .value("ONEANDAHALF",Bond::ONEANDAHALF)
      .value("TWOANDAHALF",Bond::TWOANDAHALF)
      .value("THREEANDAHALF",Bond::THREEANDAHALF)
      .value("FOURANDAHALF",Bond::FOURANDAHALF)
      .value("FIVEANDAHALF",Bond::FIVEANDAHALF)
      .value("AROMATIC",Bond::AROMATIC)
      .value("IONIC",Bond::IONIC)
      .value("HYDROGEN",Bond::HYDROGEN)
      .value("THREECENTER",Bond::THREECENTER)
      .value("DATIVEONE",Bond::DATIVEONE)
      .value("DATIVE",Bond::DATIVE)
      .value("DATIVEL",Bond::DATIVEL)
      .value("DATIVER",Bond::DATIVER)
      .value("OTHER",Bond::OTHER)
      ;
    python::enum_<Bond::BondDir>("BondDir")
      .value("NONE",Bond::NONE)
      .value("BEGINWEDGE",Bond::BEGINWEDGE)
      .value("BEGINDASH",Bond::BEGINDASH)
      .value("ENDDOWNRIGHT",Bond::ENDDOWNRIGHT)
      .value("ENDUPRIGHT",Bond::ENDUPRIGHT)
      .value("UNKNOWN",Bond::UNKNOWN)
      ;
    python::enum_<Bond::BondStereo>("BondStereo")
      .value("STEREONONE",Bond::STEREONONE)
      .value("STEREOANY",Bond::STEREOANY)
      .value("STEREOZ",Bond::STEREOZ)
      .value("STEREOE",Bond::STEREOE)
      ;
  };
  
};
}// end of namespace
void wrap_bond() {
  RDKit::bond_wrapper::wrap();
}