File: structOpenMS_1_1SimRandomNumberGenerator.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (262 lines) | stat: -rw-r--r-- 14,383 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
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
 
<HTML>
<HEAD>
<TITLE>SimRandomNumberGenerator Struct Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structOpenMS_1_1SimRandomNumberGenerator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SimRandomNumberGenerator Struct Reference<div class="ingroups"><a class="el" href="group__Simulation.html">Simulation</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Wrapper class for random number generators used by the simulation classes.  
 <a href="structOpenMS_1_1SimRandomNumberGenerator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="SimTypes_8h_source.html">OpenMS/SIMULATION/SimTypes.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aeaf0195c71752fdcda29e355b362f143"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#aeaf0195c71752fdcda29e355b362f143">SimRandomNumberGenerator</a> ()</td></tr>
<tr class="memdesc:aeaf0195c71752fdcda29e355b362f143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aeaf0195c71752fdcda29e355b362f143">More...</a><br/></td></tr>
<tr class="separator:aeaf0195c71752fdcda29e355b362f143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad93e2ec7b4e761f3b62011681589cb80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#ad93e2ec7b4e761f3b62011681589cb80">operator=</a> (const <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> &amp;source)</td></tr>
<tr class="memdesc:ad93e2ec7b4e761f3b62011681589cb80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#ad93e2ec7b4e761f3b62011681589cb80">More...</a><br/></td></tr>
<tr class="separator:ad93e2ec7b4e761f3b62011681589cb80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2411805d760c5f01bbf46ad4cae5d3ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a2411805d760c5f01bbf46ad4cae5d3ad">initialize</a> (bool biological_random, bool technical_random)</td></tr>
<tr class="memdesc:a2411805d760c5f01bbf46ad4cae5d3ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the RNGs.  <a href="#a2411805d760c5f01bbf46ad4cae5d3ad">More...</a><br/></td></tr>
<tr class="separator:a2411805d760c5f01bbf46ad4cae5d3ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr class="memitem:a22677c8c6834a881014933796a577969"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a22677c8c6834a881014933796a577969">SimRandomNumberGenerator</a> (const <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> &amp;other)</td></tr>
<tr class="memdesc:a22677c8c6834a881014933796a577969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#a22677c8c6834a881014933796a577969">More...</a><br/></td></tr>
<tr class="separator:a22677c8c6834a881014933796a577969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b9420ff81e904382d63a2f0db3bb9d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a5b9420ff81e904382d63a2f0db3bb9d7">~SimRandomNumberGenerator</a> ()</td></tr>
<tr class="memdesc:a5b9420ff81e904382d63a2f0db3bb9d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a5b9420ff81e904382d63a2f0db3bb9d7">More...</a><br/></td></tr>
<tr class="separator:a5b9420ff81e904382d63a2f0db3bb9d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8418c7661e9d110377e7160d01550954"><td class="memItemLeft" align="right" valign="top">gsl_rng *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8418c7661e9d110377e7160d01550954">biological_rng</a></td></tr>
<tr class="memdesc:a8418c7661e9d110377e7160d01550954"><td class="mdescLeft">&#160;</td><td class="mdescRight">GSL random number generator for biological variability.  <a href="#a8418c7661e9d110377e7160d01550954">More...</a><br/></td></tr>
<tr class="separator:a8418c7661e9d110377e7160d01550954"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8764fd4a009fc26b72180f667d09f1ec"><td class="memItemLeft" align="right" valign="top">gsl_rng *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8764fd4a009fc26b72180f667d09f1ec">technical_rng</a></td></tr>
<tr class="memdesc:a8764fd4a009fc26b72180f667d09f1ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">GSL random number generator for technical variability.  <a href="#a8764fd4a009fc26b72180f667d09f1ec">More...</a><br/></td></tr>
<tr class="separator:a8764fd4a009fc26b72180f667d09f1ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wrapper class for random number generators used by the simulation classes. </p>
<p>The random numbers are separated two sources of randomness:</p>
<ul>
<li>
<em>technical random numbers</em> which should represent technical sources of variability like instrument noise and  </li>
<li>
<em>biological random numbers</em> which should represent biological sources of variability (e.g. between two samples of the same composition) </li>
</ul>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aeaf0195c71752fdcda29e355b362f143"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="a22677c8c6834a881014933796a577969"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copy constructor. </p>

</div>
</div>
<a class="anchor" id="a5b9420ff81e904382d63a2f0db3bb9d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

<p>References <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8418c7661e9d110377e7160d01550954">SimRandomNumberGenerator::biological_rng</a>, and <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8764fd4a009fc26b72180f667d09f1ec">SimRandomNumberGenerator::technical_rng</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2411805d760c5f01bbf46ad4cae5d3ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void initialize </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>biological_random</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>technical_random</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initialize the RNGs. </p>

<p>References <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8418c7661e9d110377e7160d01550954">SimRandomNumberGenerator::biological_rng</a>, and <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8764fd4a009fc26b72180f667d09f1ec">SimRandomNumberGenerator::technical_rng</a>.</p>

</div>
</div>
<a class="anchor" id="ad93e2ec7b4e761f3b62011681589cb80"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html">SimRandomNumberGenerator</a> &amp;&#160;</td>
          <td class="paramname"><em>source</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Assignment operator. </p>

<p>References <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8418c7661e9d110377e7160d01550954">SimRandomNumberGenerator::biological_rng</a>, and <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a8764fd4a009fc26b72180f667d09f1ec">SimRandomNumberGenerator::technical_rng</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8418c7661e9d110377e7160d01550954"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gsl_rng* biological_rng</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GSL random number generator for biological variability. </p>

<p>Referenced by <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a2411805d760c5f01bbf46ad4cae5d3ad">SimRandomNumberGenerator::initialize()</a>, <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#ad93e2ec7b4e761f3b62011681589cb80">SimRandomNumberGenerator::operator=()</a>, and <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a5b9420ff81e904382d63a2f0db3bb9d7">SimRandomNumberGenerator::~SimRandomNumberGenerator()</a>.</p>

</div>
</div>
<a class="anchor" id="a8764fd4a009fc26b72180f667d09f1ec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gsl_rng* technical_rng</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GSL random number generator for technical variability. </p>

<p>Referenced by <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a2411805d760c5f01bbf46ad4cae5d3ad">SimRandomNumberGenerator::initialize()</a>, <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#ad93e2ec7b4e761f3b62011681589cb80">SimRandomNumberGenerator::operator=()</a>, and <a class="el" href="structOpenMS_1_1SimRandomNumberGenerator.html#a5b9420ff81e904382d63a2f0db3bb9d7">SimRandomNumberGenerator::~SimRandomNumberGenerator()</a>.</p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>