Show
Ignore:
Timestamp:
06/02/09 10:08:06 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classitpp_1_1Gamma__RNG.html

    r323 r353  
    6969</div> 
    7070<div class="contents"> 
    71 <h1>itpp::Gamma_RNG Class Reference</h1><!-- doxytag: class="itpp::Gamma_RNG" -->Gamma distribution.   
     71<h1>itpp::Gamma_RNG Class Reference<br> 
     72<small> 
     73[<a class="el" href="group__randgen.html">Random Number Generation</a>]</small> 
     74</h1><!-- doxytag: class="itpp::Gamma_RNG" -->Gamma distribution<p> 
     75Generate samples from Gamma(alpha,beta) density, according to the following equation: <p class="formulaDsp"> 
     76<img class="formulaDsp" alt="\[ x \sim \Gamma(\alpha,\beta) = \frac{\beta^\alpha}{\Gamma(\alpha)}x^{\alpha-1} \exp(-\beta x) \]" src="form_184.png"> 
     77<p> 
     78 
    7279<a href="#_details">More...</a> 
    7380<p> 
    74 <code>#include &lt;<a class="el" href="itpp__ext_8h-source.html">itpp_ext.h</a>&gt;</code> 
     81<code>#include &lt;<a class="el" href="random_8h-source.html">random.h</a>&gt;</code> 
    7582<p> 
    7683 
     
    8289&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#e132860f825f427d63652edd02c25b54">Gamma_RNG</a> (double a=1.0, double b=1.0)</td></tr> 
    8390 
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor. Set lambda. <br></td></tr> 
    85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfaae19411e39aa87e1f72e409b6babe"></a><!-- doxytag: member="itpp::Gamma_RNG::setup" ref="dfaae19411e39aa87e1f72e409b6babe" args="(double a0, double b0)" --> 
    86 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#dfaae19411e39aa87e1f72e409b6babe">setup</a> (double a0, double b0)</td></tr> 
     91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, which sets alpha (a) and beta (b). <br></td></tr> 
     92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cced56e9bb421619b7ff32fbf794d501"></a><!-- doxytag: member="itpp::Gamma_RNG::setup" ref="cced56e9bb421619b7ff32fbf794d501" args="(double a, double b)" --> 
     93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#cced56e9bb421619b7ff32fbf794d501">setup</a> (double a, double b)</td></tr> 
    8794 
    88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set lambda. <br></td></tr> 
    89 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e666953249038f262cece2d3ed952d6"></a><!-- doxytag: member="itpp::Gamma_RNG::get_setup" ref="8e666953249038f262cece2d3ed952d6" args="() const " --> 
    90 double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#8e666953249038f262cece2d3ed952d6">get_setup</a> () const </td></tr> 
    91  
    92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get lambda <br></td></tr> 
     95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set alpha and beta. <br></td></tr> 
    9396<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98e2e65456bca33fca602b2bd607235e"></a><!-- doxytag: member="itpp::Gamma_RNG::operator()" ref="98e2e65456bca33fca602b2bd607235e" args="()" --> 
    9497double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#98e2e65456bca33fca602b2bd607235e">operator()</a> ()</td></tr> 
     
    99102 
    100103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample vector. <br></td></tr> 
    101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b82b9d6c35579ab04f1a86a17571b47"></a><!-- doxytag: member="itpp::Gamma_RNG::operator()" ref="7b82b9d6c35579ab04f1a86a17571b47" args="(int h, int w)" --> 
    102 mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#7b82b9d6c35579ab04f1a86a17571b47">operator()</a> (int h, int w)</td></tr> 
     104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="394c84c73fe7e507c04fe6a9f64067ac"></a><!-- doxytag: member="itpp::Gamma_RNG::operator()" ref="394c84c73fe7e507c04fe6a9f64067ac" args="(int r, int c)" --> 
     105mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#394c84c73fe7e507c04fe6a9f64067ac">operator()</a> (int r, int c)</td></tr> 
    103106 
    104107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample matrix. <br></td></tr> 
     108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d79da7d042746e5aeb1a5b03976dda75"></a><!-- doxytag: member="itpp::Gamma_RNG::sample" ref="d79da7d042746e5aeb1a5b03976dda75" args="()" --> 
     109double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#d79da7d042746e5aeb1a5b03976dda75">sample</a> ()</td></tr> 
     110 
     111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample. <br></td></tr> 
    105112</table> 
    106113<hr><a name="_details"></a><h2>Detailed Description</h2> 
    107 Gamma distribution. <hr>The documentation for this class was generated from the following files:<ul> 
    108 <li><a class="el" href="itpp__ext_8h-source.html">itpp_ext.h</a><li>itpp_ext.cpp</ul> 
     114Gamma distribution<p> 
     115Generate samples from Gamma(alpha,beta) density, according to the following equation: <p class="formulaDsp"> 
     116<img class="formulaDsp" alt="\[ x \sim \Gamma(\alpha,\beta) = \frac{\beta^\alpha}{\Gamma(\alpha)}x^{\alpha-1} \exp(-\beta x) \]" src="form_184.png"> 
     117<p> 
     118.  
     119<p> 
     120For <img class="formulaInl" alt="$\alpha=1$" src="form_185.png"> the Gamma distribution is equivalent to the Exponential distribution.<p> 
     121<dl class="note" compact><dt><b>Note:</b></dt><dd>The implementation of the <a class="el" href="classitpp_1_1Gamma__RNG.html#d79da7d042746e5aeb1a5b03976dda75" title="Get a sample.">sample()</a> function was adapted from the R statistical language. </dd></dl> 
     122<dl class="author" compact><dt><b>Author:</b></dt><dd>Vasek Smidl </dd></dl> 
     123<hr>The documentation for this class was generated from the following files:<ul> 
     124<li><a class="el" href="random_8h-source.html">random.h</a><li><a class="el" href="random_8cpp.html">random.cpp</a></ul> 
    109125</div> 
    110 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:46 2009 for mixpp by&nbsp; 
     126<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp; 
    111127<a href="http://www.doxygen.org/index.html"> 
    112128<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>