File: classOpenBabel_1_1OBEnergyConformerScore.shtml

package info (click to toggle)
openbabel 2.3.2%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 75,308 kB
  • ctags: 41,952
  • sloc: cpp: 321,252; ansic: 89,228; python: 7,262; perl: 6,418; pascal: 793; sh: 194; xml: 97; ruby: 55; makefile: 47; java: 23
file content (266 lines) | stat: -rw-r--r-- 16,531 bytes parent folder | download | duplicates (3)
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>OBEnergyConformerScore Class Reference</title>
<link href="/site.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="search/search.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
</head>

<body>

<!--#include file="header.html" -->
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.shtml"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.shtml"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.shtml"><span>Modules</span></a></li>
      <li><a href="namespaces.shtml"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.shtml"><span>Classes</span></a></li>
      <li><a href="files.shtml"><span>Files</span></a></li>
      <li><a href="examples.shtml"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.shtml"><span>Class&#160;List</span></a></li>
      <li><a href="classes.shtml"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.shtml"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.shtml"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceOpenBabel.shtml">OpenBabel</a>      </li>
      <li class="navelem"><a class="el" href="classOpenBabel_1_1OBEnergyConformerScore.shtml">OBEnergyConformerScore</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">OBEnergyConformerScore Class Reference<div class="ingroups"><a class="el" href="group__conformer.shtml">Conformer Searching</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="OpenBabel::OBEnergyConformerScore" --><!-- doxytag: inherits="OpenBabel::OBConformerScore" -->
<p><code>#include &lt;<a class="el" href="conformersearch_8h_source.shtml">openbabel/conformersearch.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OBEnergyConformerScore:</div>
<div class="dyncontent">
<div class="center"><img src="classOpenBabel_1_1OBEnergyConformerScore__inherit__graph.png" border="0" usemap="#OBEnergyConformerScore_inherit__map" alt="Inheritance graph"/></div>
<map name="OBEnergyConformerScore_inherit__map" id="OBEnergyConformerScore_inherit__map">
<area shape="rect" id="node2" href="classOpenBabel_1_1OBConformerScore.shtml" title="Interface used by OBConformerSearch for scoring conformers." alt="" coords="28,5,180,35"/></map>
<center><span class="legend">[<a href="graph_legend.shtml">legend</a>]</span></center></div>

<p><a href="classOpenBabel_1_1OBEnergyConformerScore-members.shtml">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199">Preferred</a> { <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199a073a4c447a7027d5e628f4ff35c02ff5">HighScore</a>, 
<a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199a77a557955ebc510e6b694ad1a33ce8dc">LowScore</a>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cf">Convergence</a> { <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cfa4bf5c35ed60c6d5584981ba1688d3eca">Highest</a>, 
<a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cfaa1a11438163780169b78e0ee94e4ff31">Lowest</a>, 
<a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cfa518f6bbe779cc0085da5461c257fd8a6">Sum</a>, 
<a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cfab3c87ec2c47256239220b24e46acda7f">Average</a>
 }</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199">Preferred</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBEnergyConformerScore.shtml#acd1109a84508503c02e429be0fd3960b">GetPreferred</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cf">Convergence</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBEnergyConformerScore.shtml#a58c03d41bd16b4017639f6bf41f8de45">GetConvergence</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBEnergyConformerScore.shtml#af48ac6558d86f5b0d3e7981ee51033a8">Score</a> (<a class="el" href="classOpenBabel_1_1OBMol.shtml">OBMol</a> &amp;mol, unsigned int index, const <a class="el" href="namespaceOpenBabel.shtml#ad5ae0fb6c3d3406efb549fbc9f8c26f0">RotorKeys</a> &amp;keys, const std::vector&lt; double * &gt; &amp;conformers)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A lowest energy conformer scoring class. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>2.3 </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ae5293b2df07c4f01e42a925f954fe199"></a><!-- doxytag: member="OpenBabel::OBEnergyConformerScore::Preferred" ref="ae5293b2df07c4f01e42a925f954fe199" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199">Preferred</a><code> [inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Conformer scores can be preferably high or low. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae5293b2df07c4f01e42a925f954fe199a073a4c447a7027d5e628f4ff35c02ff5"></a><!-- doxytag: member="HighScore" ref="ae5293b2df07c4f01e42a925f954fe199a073a4c447a7027d5e628f4ff35c02ff5" args="" -->HighScore</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae5293b2df07c4f01e42a925f954fe199a77a557955ebc510e6b694ad1a33ce8dc"></a><!-- doxytag: member="LowScore" ref="ae5293b2df07c4f01e42a925f954fe199a77a557955ebc510e6b694ad1a33ce8dc" args="" -->LowScore</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a class="anchor" id="a11429dfa214276750cb761b6261485cf"></a><!-- doxytag: member="OpenBabel::OBEnergyConformerScore::Convergence" ref="a11429dfa214276750cb761b6261485cf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cf">Convergence</a><code> [inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Convergence criteria used. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a11429dfa214276750cb761b6261485cfa4bf5c35ed60c6d5584981ba1688d3eca"></a><!-- doxytag: member="Highest" ref="a11429dfa214276750cb761b6261485cfa4bf5c35ed60c6d5584981ba1688d3eca" args="" -->Highest</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a11429dfa214276750cb761b6261485cfaa1a11438163780169b78e0ee94e4ff31"></a><!-- doxytag: member="Lowest" ref="a11429dfa214276750cb761b6261485cfaa1a11438163780169b78e0ee94e4ff31" args="" -->Lowest</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a11429dfa214276750cb761b6261485cfa518f6bbe779cc0085da5461c257fd8a6"></a><!-- doxytag: member="Sum" ref="a11429dfa214276750cb761b6261485cfa518f6bbe779cc0085da5461c257fd8a6" args="" -->Sum</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a11429dfa214276750cb761b6261485cfab3c87ec2c47256239220b24e46acda7f"></a><!-- doxytag: member="Average" ref="a11429dfa214276750cb761b6261485cfab3c87ec2c47256239220b24e46acda7f" args="" -->Average</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acd1109a84508503c02e429be0fd3960b"></a><!-- doxytag: member="OpenBabel::OBEnergyConformerScore::GetPreferred" ref="acd1109a84508503c02e429be0fd3960b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#ae5293b2df07c4f01e42a925f954fe199">Preferred</a> GetPreferred </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Preferred order for subclass scoring function. </p>

<p>Implements <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a9c17ca51589a988f78ffaecd8f10f26a">OBConformerScore</a>.</p>

</div>
</div>
<a class="anchor" id="a58c03d41bd16b4017639f6bf41f8de45"></a><!-- doxytag: member="OpenBabel::OBEnergyConformerScore::GetConvergence" ref="a58c03d41bd16b4017639f6bf41f8de45" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a11429dfa214276750cb761b6261485cf">Convergence</a> GetConvergence </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Convergence criteria for subclass scoring function. </p>

<p>Implements <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a3a532c5117d7765c1159c25f5713fab1">OBConformerScore</a>.</p>

</div>
</div>
<a class="anchor" id="af48ac6558d86f5b0d3e7981ee51033a8"></a><!-- doxytag: member="OpenBabel::OBEnergyConformerScore::Score" ref="af48ac6558d86f5b0d3e7981ee51033a8" args="(OBMol &amp;mol, unsigned int index, const RotorKeys &amp;keys, const std::vector&lt; double * &gt; &amp;conformers)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double Score </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classOpenBabel_1_1OBMol.shtml">OBMol</a> &amp;&#160;</td>
          <td class="paramname"><em>mol</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="namespaceOpenBabel.shtml#ad5ae0fb6c3d3406efb549fbc9f8c26f0">RotorKeys</a> &amp;&#160;</td>
          <td class="paramname"><em>keys</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; double * &gt; &amp;&#160;</td>
          <td class="paramname"><em>conformers</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Score an individual conformer specified by index. </p>

<p>Implements <a class="el" href="classOpenBabel_1_1OBConformerScore.shtml#a49dff79670ea23af9bf3c35b15f21627">OBConformerScore</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="conformersearch_8h_source.shtml">conformersearch.h</a></li>
<li><a class="el" href="conformersearch_8cpp.shtml">conformersearch.cpp</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- end content -->

<!--#include file="footer.html" -->

<div id="footer">
<hr size="1">
<img src="http://openbabel.org/babel256.png" width="136" height="127" alt="" style="float: left;" />
<p>This file is part of the documentation for <a href="http://openbabel.org/wiki/">Open Babel</a>, version 2.3.</p>
<div class="bottom">
Documentation copyright &copy; 1998-2007, the <a href="http://openbabel.org/wiki/THANKS">Open Babel Developers</a>.<br>
Open Babel is hosted by: <a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=40728" 
width="88" height="31" border="0" alt="SourceForge Logo"></a><br>
Generated on Thu Oct 13 2011 16:08:09 by&nbsp;<a href="http://www.doxygen.org/"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5.1.
</div>

</body>
</html>