root/doc/html/classitpp_1_1Normal__RNG.html @ 353

Revision 353, 9.4 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::Normal_RNG Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1Normal__RNG.html">Normal_RNG</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Normal_RNG Class Reference<br>
72<small>
73[<a class="el" href="group__randgen.html">Random Number Generation</a>]</small>
74</h1><!-- doxytag: class="itpp::Normal_RNG" -->Normal distribution<p>
75Normal (Gaussian) random variables, using a simplified Ziggurat method. 
76<a href="#_details">More...</a>
77<p>
78<code>#include &lt;<a class="el" href="random_8h-source.html">random.h</a>&gt;</code>
79<p>
80
81<p>
82<a href="classitpp_1_1Normal__RNG-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
83<tr><td></td></tr>
84<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd55ffa72d3f5eb0995ab54894e08c8d"></a><!-- doxytag: member="itpp::Normal_RNG::Normal_RNG" ref="dd55ffa72d3f5eb0995ab54894e08c8d" args="(double meanval, double variance)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#dd55ffa72d3f5eb0995ab54894e08c8d">Normal_RNG</a> (double meanval, double variance)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. Set mean and variance. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a64c4c84526ad74d6ecde287149dd63f"></a><!-- doxytag: member="itpp::Normal_RNG::Normal_RNG" ref="a64c4c84526ad74d6ecde287149dd63f" args="()" -->
90&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#a64c4c84526ad74d6ecde287149dd63f">Normal_RNG</a> ()</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. Set mean and variance. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c50b4c9b0bb07c69c9fbf16b9f01521"></a><!-- doxytag: member="itpp::Normal_RNG::setup" ref="9c50b4c9b0bb07c69c9fbf16b9f01521" args="(double meanval, double variance)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#9c50b4c9b0bb07c69c9fbf16b9f01521">setup</a> (double meanval, double variance)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set mean, and variance. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93a1030543e425b82862c23467cb360a"></a><!-- doxytag: member="itpp::Normal_RNG::get_setup" ref="93a1030543e425b82862c23467cb360a" args="(double &amp;meanval, double &amp;variance) const " -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#93a1030543e425b82862c23467cb360a">get_setup</a> (double &amp;meanval, double &amp;variance) const </td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get mean and variance. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98cb5f1d64fe9c1bdc4e97b136d6a8c3"></a><!-- doxytag: member="itpp::Normal_RNG::operator()" ref="98cb5f1d64fe9c1bdc4e97b136d6a8c3" args="()" -->
102double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#98cb5f1d64fe9c1bdc4e97b136d6a8c3">operator()</a> ()</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get one sample. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80d83d4d528cb3b4b788b7b479181a45"></a><!-- doxytag: member="itpp::Normal_RNG::operator()" ref="80d83d4d528cb3b4b788b7b479181a45" args="(int n)" -->
106vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#80d83d4d528cb3b4b788b7b479181a45">operator()</a> (int n)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample vector. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fe784c0dc8ccb689dd0ba8c4fa66dd2"></a><!-- doxytag: member="itpp::Normal_RNG::operator()" ref="6fe784c0dc8ccb689dd0ba8c4fa66dd2" args="(int h, int w)" -->
110mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#6fe784c0dc8ccb689dd0ba8c4fa66dd2">operator()</a> (int h, int w)</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample matrix. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10bf6949c45e781a36e967d9c8448614"></a><!-- doxytag: member="itpp::Normal_RNG::sample" ref="10bf6949c45e781a36e967d9c8448614" args="()" -->
114double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#10bf6949c45e781a36e967d9c8448614">sample</a> ()</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a Normal distributed (0,1) sample. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03e547de2b7ed75be013ab665a07c4e8"></a><!-- doxytag: member="itpp::Normal_RNG::sample_vector" ref="03e547de2b7ed75be013ab665a07c4e8" args="(int size, vec &amp;out)" -->
118void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#03e547de2b7ed75be013ab665a07c4e8">sample_vector</a> (int size, vec &amp;out)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a Normal distributed (0,1) vector. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dab2664826b5e3e57c4087a50201bfd"></a><!-- doxytag: member="itpp::Normal_RNG::sample_matrix" ref="7dab2664826b5e3e57c4087a50201bfd" args="(int rows, int cols, mat &amp;out)" -->
122void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Normal__RNG.html#7dab2664826b5e3e57c4087a50201bfd">sample_matrix</a> (int rows, int cols, mat &amp;out)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a Normal distributed (0,1) matrix. <br></td></tr>
125</table>
126<hr><a name="_details"></a><h2>Detailed Description</h2>
127Normal distribution<p>
128Normal (Gaussian) random variables, using a simplified Ziggurat method.
129<p>
130For details see the following arcticle: George Marsaglia, Wai Wan Tsang, "The Ziggurat Method for Generating Random Variables", Journal of Statistical Software, vol. 5 (2000), no. 8<p>
131This implementation is based on the generator written by Jochen Voss found at <a href="http://seehuhn.de/comp/ziggurat/,">http://seehuhn.de/comp/ziggurat/,</a> which is also included in the GSL library (randlist/gauss.c). <hr>The documentation for this class was generated from the following files:<ul>
132<li><a class="el" href="random_8h-source.html">random.h</a><li><a class="el" href="random_8cpp.html">random.cpp</a></ul>
133</div>
134<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
135<a href="http://www.doxygen.org/index.html">
136<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
137</body>
138</html>
Note: See TracBrowser for help on using the browser.