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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>OBRandom 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 Page</span></a></li>
<li><a href="pages.shtml"><span>Related 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 List</span></a></li>
<li><a href="classes.shtml"><span>Class Index</span></a></li>
<li><a href="hierarchy.shtml"><span>Class Hierarchy</span></a></li>
<li><a href="functions.shtml"><span>Class 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_1OBRandom.shtml">OBRandom</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">OBRandom Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="OpenBabel::OBRandom" -->
<p><code>#include <<a class="el" href="rand_8h_source.shtml">openbabel/rand.h</a>></code></p>
<p><a href="classOpenBabel_1_1OBRandom-members.shtml">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBRandom.shtml#aad105f775b284c16fdd4c649e227335f">OBRandom</a> (bool useSys=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBRandom.shtml#a381897e3c19642c65d3784c94f3572d8">Seed</a> (int seed)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBRandom.shtml#a74c6a2f3418f559a3c829177885c3b59">TimeSeed</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBRandom.shtml#a0fffdba613d757a821b059d7d4a26b74">NextInt</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBRandom.shtml#ae07ab97904e47280d8dfa4164ffe6bc3">NextFloat</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Random number generator. </p>
<p>The <a class="el" href="classOpenBabel_1_1OBRandom.shtml" title="Random number generator.">OBRandom</a> class can be used to facilitate cross-platform random number generation. The class can be set to specific seed states, or set to use the current time or other arbitrary data as a seed.</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classOpenBabel_1_1OBRandom.shtml#aad105f775b284c16fdd4c649e227335f" title="Constructor. useSys will use the system rand() function.">OBRandom</a> generator; <span class="comment">// Don't use system rand() functions</span>
generator.TimeSeed(); <span class="comment">// initialize from the current time</span>
cerr << <span class="stringliteral">" New Random Integer "</span> << generator.NextInt() << endl;
cerr << <span class="stringliteral">" New Random Floating-Point "</span> << generator.NextFloat() << endl;
</pre></div><p>Alternatively, <a class="el" href="classOpenBabel_1_1OBRandom.shtml" title="Random number generator.">OBRandom</a> can be used as an interface to the system random number generator.</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classOpenBabel_1_1OBRandom.shtml#aad105f775b284c16fdd4c649e227335f" title="Constructor. useSys will use the system rand() function.">OBRandom</a> generator(<span class="keyword">true</span>); <span class="comment">// Use system rand() functions</span>
generator.Seed(10246);<span class="comment">// Use a specific initial seed value for reproducing sequence</span>
</pre></div> </div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aad105f775b284c16fdd4c649e227335f"></a><!-- doxytag: member="OpenBabel::OBRandom::OBRandom" ref="aad105f775b284c16fdd4c649e227335f" args="(bool useSys=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenBabel_1_1OBRandom.shtml">OBRandom</a> </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useSys</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. <code>useSys</code> will use the system rand() function. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a381897e3c19642c65d3784c94f3572d8"></a><!-- doxytag: member="OpenBabel::OBRandom::Seed" ref="a381897e3c19642c65d3784c94f3572d8" args="(int seed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Seed </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>seed</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use <code>seed</code> for the random number generator seed. </p>
</div>
</div>
<a class="anchor" id="a74c6a2f3418f559a3c829177885c3b59"></a><!-- doxytag: member="OpenBabel::OBRandom::TimeSeed" ref="a74c6a2f3418f559a3c829177885c3b59" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeSeed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use the current time for the random number generator seed If sranddev is available (e.g., Mac OS X, BSD...) use this instead for more random seeds </p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBForceField.shtml#ae9f7de4324a4a476ca0663772c1a6bfa">OBForceField::GenerateVelocities()</a>, <a class="el" href="classOpenBabel_1_1OBForceField.shtml#a3511ce0631f467170ac6d5a9c6d5edde">OBForceField::RandomRotorSearchInitialize()</a>, <a class="el" href="classOpenBabel_1_1vector3.shtml#af2f4c0b08630beda575c1c8697b8fece">vector3::randomUnitVector()</a>, <a class="el" href="classOpenBabel_1_1OBConformerSearch.shtml#a9084f759abbf98766f3fed69c14b568a">OBConformerSearch::Setup()</a>, and <a class="el" href="classOpenBabel_1_1OBForceField.shtml#aabf7fa941ffdd2106f5f82f2afefa33f">OBForceField::WeightedRotorSearch()</a>.</p>
</div>
</div>
<a class="anchor" id="a0fffdba613d757a821b059d7d4a26b74"></a><!-- doxytag: member="OpenBabel::OBRandom::NextInt" ref="a0fffdba613d757a821b059d7d4a26b74" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NextInt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>a random integer </dd></dl>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBForceField.shtml#a3511ce0631f467170ac6d5a9c6d5edde">OBForceField::RandomRotorSearchInitialize()</a>, and <a class="el" href="classOpenBabel_1_1OBConformerSearch.shtml#a9084f759abbf98766f3fed69c14b568a">OBConformerSearch::Setup()</a>.</p>
</div>
</div>
<a class="anchor" id="ae07ab97904e47280d8dfa4164ffe6bc3"></a><!-- doxytag: member="OpenBabel::OBRandom::NextFloat" ref="ae07ab97904e47280d8dfa4164ffe6bc3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double NextFloat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>a random floating-point number between 0.0 and 1.0 </dd></dl>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBForceField.shtml#ae9f7de4324a4a476ca0663772c1a6bfa">OBForceField::GenerateVelocities()</a>, <a class="el" href="classOpenBabel_1_1matrix3x3.shtml#aff25b8b63c0aec5f2c83d0cb70ae55cb">matrix3x3::randomRotation()</a>, <a class="el" href="classOpenBabel_1_1vector3.shtml#af2f4c0b08630beda575c1c8697b8fece">vector3::randomUnitVector()</a>, and <a class="el" href="classOpenBabel_1_1OBForceField.shtml#aabf7fa941ffdd2106f5f82f2afefa33f">OBForceField::WeightedRotorSearch()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="rand_8h_source.shtml">rand.h</a></li>
<li><a class="el" href="rand_8cpp.shtml">rand.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </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 © 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:11 by <a href="http://www.doxygen.org/"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5.1.
</div>
</body>
</html>
|