Show
Ignore:
Timestamp:
06/02/09 10:24:26 (16 years ago)
Author:
smidl
Message:

doc - oprava

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classitpp_1_1Gamma__RNG.html

    r353 r354  
    6969</div> 
    7070<div class="contents"> 
    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> 
    75 Generate 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  
     71<h1>itpp::Gamma_RNG Class Reference</h1><!-- doxytag: class="itpp::Gamma_RNG" -->Gamma distribution.   
    7972<a href="#_details">More...</a> 
    8073<p> 
    81 <code>#include &lt;<a class="el" href="random_8h-source.html">random.h</a>&gt;</code> 
     74<code>#include &lt;<a class="el" href="itpp__ext_8h-source.html">itpp_ext.h</a>&gt;</code> 
    8275<p> 
    8376 
     
    8982&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> 
    9083 
    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)" --> 
    93 void&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> 
     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)" --> 
     86void&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> 
    9487 
    95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set alpha and beta. <br></td></tr> 
     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 " --> 
     90double&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> 
    9693<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98e2e65456bca33fca602b2bd607235e"></a><!-- doxytag: member="itpp::Gamma_RNG::operator()" ref="98e2e65456bca33fca602b2bd607235e" args="()" --> 
    9794double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gamma__RNG.html#98e2e65456bca33fca602b2bd607235e">operator()</a> ()</td></tr> 
     
    10299 
    103100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a sample vector. <br></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)" --> 
    105 mat&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> 
     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)" --> 
     102mat&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> 
    106103 
    107104<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="()" --> 
    109 double&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> 
    112105</table> 
    113106<hr><a name="_details"></a><h2>Detailed Description</h2> 
    114 Gamma distribution<p> 
    115 Generate 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> 
    120 For <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> 
     107Gamma 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> 
    125109</div> 
    126 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp; 
     110<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp; 
    127111<a href="http://www.doxygen.org/index.html"> 
    128112<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>