root/doc/html/classegamma.html @ 171

Revision 171, 13.1 kB (checked in by smidl, 16 years ago)

New documentation

RevLine 
[32]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: egamma Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
[139]7<!-- Generated by Doxygen 1.5.6 -->
[91]8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
[32]24</div>
[91]25<div class="contents">
[32]26<h1>egamma Class Reference</h1><!-- doxytag: class="egamma" --><!-- doxytag: inherits="eEF" -->Gamma posterior density. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for egamma:</div>
33<div class="dynsection">
34<p><center><img src="classegamma__inherit__graph.png" border="0" usemap="#egamma__inherit__map" alt="Inheritance graph"></center>
35<map name="egamma__inherit__map">
[91]36<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="19,82,64,106"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="19,7,64,31"></map>
[32]37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for egamma:</div>
40<div class="dynsection">
41<p><center><img src="classegamma__coll__graph.png" border="0" usemap="#egamma__coll__map" alt="Collaboration graph"></center>
42<map name="egamma__coll__map">
[91]43<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="19,172,64,196"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="19,95,64,119"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="23,7,60,31"></map>
[32]44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classegamma-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b1d34f3b244ea51a58ec10c468788c1"></a><!-- doxytag: member="egamma::egamma" ref="4b1d34f3b244ea51a58ec10c468788c1" args="(const RV &amp;rv)" -->
[33]51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#4b1d34f3b244ea51a58ec10c468788c1">egamma</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
[32]52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e348b89be82b70471fe8c5630f61339"></a><!-- doxytag: member="egamma::set_parameters" ref="8e348b89be82b70471fe8c5630f61339" args="(const vec &amp;a, const vec &amp;b)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#8e348b89be82b70471fe8c5630f61339">set_parameters</a> (const vec &amp;a, const vec &amp;b)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets parameters. <br></td></tr>
[171]58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e10c0021b5dfdd9cb62c6959b5ef425"></a><!-- doxytag: member="egamma::sample" ref="8e10c0021b5dfdd9cb62c6959b5ef425" args="() const " -->
59vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#8e10c0021b5dfdd9cb62c6959b5ef425">sample</a> () const </td></tr>
[32]60
[171]61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
[33]62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de84faac8f9799dfe2777ddbedf997ef"></a><!-- doxytag: member="egamma::evalpdflog" ref="de84faac8f9799dfe2777ddbedf997ef" args="(const vec &amp;val) const " -->
63double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#de84faac8f9799dfe2777ddbedf997ef">evalpdflog</a> (const vec &amp;val) const </td></tr>
[32]64
[139]65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO: is it used anywhere? <br></td></tr>
[99]66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6dbbdb72360f9e54d64501f80318bb6"></a><!-- doxytag: member="egamma::lognc" ref="d6dbbdb72360f9e54d64501f80318bb6" args="() const " -->
67double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#d6dbbdb72360f9e54d64501f80318bb6">lognc</a> () const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">logarithm of the normalizing constant, <img class="formulaInl" alt="$\mathcal{I}$" src="form_60.png"> <br></td></tr>
[32]70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44445c56e60b91b377f207f8d5089790"></a><!-- doxytag: member="egamma::_param" ref="44445c56e60b91b377f207f8d5089790" args="(vec *&amp;a, vec *&amp;b)" -->
71void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#44445c56e60b91b377f207f8d5089790">_param</a> (vec *&amp;a, vec *&amp;b)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns poiter to alpha and beta. Potentially dengerous: use with care! <br></td></tr>
[33]74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ab5ba56f7cdb2e5921c3e77524fa50a"></a><!-- doxytag: member="egamma::mean" ref="6ab5ba56f7cdb2e5921c3e77524fa50a" args="() const " -->
75vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#6ab5ba56f7cdb2e5921c3e77524fa50a">mean</a> () const </td></tr>
[32]76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
[171]78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a89bef8996410609004fa019b5b48964"></a><!-- doxytag: member="egamma::dupdate" ref="a89bef8996410609004fa019b5b48964" args="(mat &amp;v)" -->
79virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#a89bef8996410609004fa019b5b48964">dupdate</a> (mat &amp;v)</td></tr>
[32]80
[33]81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
[171]82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48cdd33d0e20d1a1aa45683c956bc61c"></a><!-- doxytag: member="egamma::evalpdflog_nn" ref="48cdd33d0e20d1a1aa45683c956bc61c" args="(const vec &amp;val) const " -->
83virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#48cdd33d0e20d1a1aa45683c956bc61c">evalpdflog_nn</a> (const vec &amp;val) const </td></tr>
[32]84
[171]85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c71faf4b2d153efda14bf1f87dca1507"></a><!-- doxytag: member="egamma::evalpdflog" ref="c71faf4b2d153efda14bf1f87dca1507" args="(const mat &amp;Val) const " -->
87virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#c71faf4b2d153efda14bf1f87dca1507">evalpdflog</a> (const mat &amp;Val) const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f8385dd1cc9740522dc373b1dc3cbf5"></a><!-- doxytag: member="egamma::pow" ref="4f8385dd1cc9740522dc373b1dc3cbf5" args="(double p)" -->
91virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#4f8385dd1cc9740522dc373b1dc3cbf5">pow</a> (double p)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr>
[139]94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54d7dd53a641b618771cd9bee135181f"></a><!-- doxytag: member="egamma::sampleN" ref="54d7dd53a641b618771cd9bee135181f" args="(int N) const " -->
95virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#54d7dd53a641b618771cd9bee135181f">sampleN</a> (int N) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
[33]98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ea597362e11a0040fe7c990269d072c"></a><!-- doxytag: member="egamma::eval" ref="3ea597362e11a0040fe7c990269d072c" args="(const vec &amp;val) const " -->
99virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ea597362e11a0040fe7c990269d072c">eval</a> (const vec &amp;val) const </td></tr>
[32]100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
[171]102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="egamma::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
103const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#ca0d32aabb4cbba347e0c37fe8607562">_rv</a> () const </td></tr>
[32]104
[162]105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
[171]106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="egamma::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#7fb94ce90d1ac7077d29f7d6a6c3e0a5">_renewrv</a> (const <a class="el" href="classRV.html">RV</a> &amp;in_rv)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
[32]110<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="376cebd8932546c440f21b182910b01b"></a><!-- doxytag: member="egamma::alpha" ref="376cebd8932546c440f21b182910b01b" args="" -->
[33]112vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#376cebd8932546c440f21b182910b01b">alpha</a></td></tr>
[32]113
[33]114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\alpha$" src="form_15.png">. <br></td></tr>
[32]115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfc5f136467488a421ab22f886323790"></a><!-- doxytag: member="egamma::beta" ref="cfc5f136467488a421ab22f886323790" args="" -->
[33]116vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classegamma.html#cfc5f136467488a421ab22f886323790">beta</a></td></tr>
[32]117
[33]118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector <img class="formulaInl" alt="$\beta$" src="form_16.png">. <br></td></tr>
[32]119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="egamma::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
[33]120<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a></td></tr>
[32]121
[33]122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
[32]123</table>
124<hr><a name="_details"></a><h2>Detailed Description</h2>
125Gamma posterior density.
126<p>
[171]127Multivariate Gamma density as product of independent univariate densities. <p class="formulaDsp">
[33]128<img class="formulaDsp" alt="\[ f(x|\alpha,\beta) = \prod f(x_i|\alpha_i,\beta_i) \]" src="form_8.png">
[32]129<p>
[171]130 <hr>The documentation for this class was generated from the following files:<ul>
[145]131<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a><li>work/git/mixpp/bdm/stat/libEF.cpp</ul>
[91]132</div>
[171]133<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:50 2008 for mixpp by&nbsp;
[32]134<a href="http://www.doxygen.org/index.html">
[139]135<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
[32]136</body>
137</html>
Note: See TracBrowser for help on using the browser.