root/doc/html/classeDirich.html @ 181

Revision 181, 15.4 kB (checked in by smidl, 16 years ago)

Regenerated doc

RevLine 
[171]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: eDirich 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>
7<!-- Generated by Doxygen 1.5.6 -->
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>
24</div>
25<div class="contents">
26<h1>eDirich Class Reference</h1><!-- doxytag: class="eDirich" --><!-- doxytag: inherits="eEF" -->Dirichlet 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 eDirich:</div>
33<div class="dynsection">
34<p><center><img src="classeDirich__inherit__graph.png" border="0" usemap="#eDirich__inherit__map" alt="Inheritance graph"></center>
35<map name="eDirich__inherit__map">
36<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="16,84,59,111"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="13,7,61,33"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for eDirich:</div>
40<div class="dynsection">
41<p><center><img src="classeDirich__coll__graph.png" border="0" usemap="#eDirich__coll__map" alt="Collaboration graph"></center>
42<map name="eDirich__coll__map">
43<area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="16,183,59,209"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="13,103,61,129"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="19,7,56,33"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classeDirich-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="ac7e6116f3575c3860d07355e96cd4af"></a><!-- doxytag: member="eDirich::eDirich" ref="ac7e6116f3575c3860d07355e96cd4af" args="(const RV &amp;rv, const vec &amp;beta0)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#ac7e6116f3575c3860d07355e96cd4af">eDirich</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>, const vec &amp;beta0)</td></tr>
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="55cccbc5eb44764dce722567acf5fd58"></a><!-- doxytag: member="eDirich::eDirich" ref="55cccbc5eb44764dce722567acf5fd58" args="(const eDirich &amp;D0)" -->
55&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#55cccbc5eb44764dce722567acf5fd58">eDirich</a> (const <a class="el" href="classeDirich.html">eDirich</a> &amp;D0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23dff79110822e9639343fe8e177fd80"></a><!-- doxytag: member="eDirich::sample" ref="23dff79110822e9639343fe8e177fd80" args="() const " -->
59vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#23dff79110822e9639343fe8e177fd80">sample</a> () const </td></tr>
60
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>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4206e1da149d51ff3b663c9241096b73"></a><!-- doxytag: member="eDirich::mean" ref="4206e1da149d51ff3b663c9241096b73" args="() const " -->
63vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#4206e1da149d51ff3b663c9241096b73">mean</a> () const </td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="688a24f04be6d80d4769cf0e4ded7acc"></a><!-- doxytag: member="eDirich::evalpdflog_nn" ref="688a24f04be6d80d4769cf0e4ded7acc" args="(const vec &amp;val) const " -->
67double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#688a24f04be6d80d4769cf0e4ded7acc">evalpdflog_nn</a> (const vec &amp;val) const </td></tr>
68
[180]69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">In this instance, val is ... <br></td></tr>
[171]70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ce60be7119ffc639ede4e583c1f6e77"></a><!-- doxytag: member="eDirich::lognc" ref="7ce60be7119ffc639ede4e583c1f6e77" args="() const " -->
71double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#7ce60be7119ffc639ede4e583c1f6e77">lognc</a> () const </td></tr>
72
73<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>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6409d0362143a23976b43641ff19e53a"></a><!-- doxytag: member="eDirich::_beta" ref="6409d0362143a23976b43641ff19e53a" args="()" -->
75vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#6409d0362143a23976b43641ff19e53a">_beta</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[180]78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c842acb2e1cce5cc9000769ff06c086d"></a><!-- doxytag: member="eDirich::set_parameters" ref="c842acb2e1cce5cc9000769ff06c086d" args="(const vec &amp;beta0)" -->
79void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#c842acb2e1cce5cc9000769ff06c086d">set_parameters</a> (const vec &amp;beta0)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set internal parameters. <br></td></tr>
[171]82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a89bef8996410609004fa019b5b48964"></a><!-- doxytag: member="eDirich::dupdate" ref="a89bef8996410609004fa019b5b48964" args="(mat &amp;v)" -->
83virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#a89bef8996410609004fa019b5b48964">dupdate</a> (mat &amp;v)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6466e8d4aa9dd64698ed288cbb1afc03"></a><!-- doxytag: member="eDirich::evalpdflog" ref="6466e8d4aa9dd64698ed288cbb1afc03" args="(const vec &amp;val) const " -->
87virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#6466e8d4aa9dd64698ed288cbb1afc03">evalpdflog</a> (const vec &amp;val) const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c71faf4b2d153efda14bf1f87dca1507"></a><!-- doxytag: member="eDirich::evalpdflog" ref="c71faf4b2d153efda14bf1f87dca1507" args="(const mat &amp;Val) const " -->
91virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#c71faf4b2d153efda14bf1f87dca1507">evalpdflog</a> (const mat &amp;Val) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f8385dd1cc9740522dc373b1dc3cbf5"></a><!-- doxytag: member="eDirich::pow" ref="4f8385dd1cc9740522dc373b1dc3cbf5" args="(double p)" -->
95virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#4f8385dd1cc9740522dc373b1dc3cbf5">pow</a> (double p)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54d7dd53a641b618771cd9bee135181f"></a><!-- doxytag: member="eDirich::sampleN" ref="54d7dd53a641b618771cd9bee135181f" args="(int N) const " -->
99virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#54d7dd53a641b618771cd9bee135181f">sampleN</a> (int N) const </td></tr>
100
101<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>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ea597362e11a0040fe7c990269d072c"></a><!-- doxytag: member="eDirich::eval" ref="3ea597362e11a0040fe7c990269d072c" args="(const vec &amp;val) const " -->
103virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ea597362e11a0040fe7c990269d072c">eval</a> (const vec &amp;val) const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
[180]106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cebbdd7a85e6328f7358fc0ba8eee06c"></a><!-- doxytag: member="eDirich::evalpdflog_m" ref="cebbdd7a85e6328f7358fc0ba8eee06c" args="(const mat &amp;Val) const " -->
107virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#cebbdd7a85e6328f7358fc0ba8eee06c">evalpdflog_m</a> (const mat &amp;Val) const </td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
[181]110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ba08c0e788deff22134c049b9269666"></a><!-- doxytag: member="eDirich::condition" ref="3ba08c0e788deff22134c049b9269666" args="(const RV &amp;rv)" -->
111<a class="el" href="classmpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ba08c0e788deff22134c049b9269666">condition</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return conditional density on the given <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>, the remaining rvs will be in conditioning. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc0c171b6dafacd78d26263913b1d0c0"></a><!-- doxytag: member="eDirich::marginal" ref="bc0c171b6dafacd78d26263913b1d0c0" args="(const RV &amp;rv)" -->
115<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#bc0c171b6dafacd78d26263913b1d0c0">marginal</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>, the remainig rvs are intergrated out. <br></td></tr>
[171]118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="eDirich::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
119const <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>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="eDirich::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
123void&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>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
126<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15e6b65e9595eedc8a1286c6cecd36d7"></a><!-- doxytag: member="eDirich::beta" ref="15e6b65e9595eedc8a1286c6cecd36d7" args="" -->
128vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeDirich.html#15e6b65e9595eedc8a1286c6cecd36d7">beta</a></td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sufficient statistics <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="eDirich::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
132<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>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
135</table>
136<hr><a name="_details"></a><h2>Detailed Description</h2>
137Dirichlet posterior density.
138<p>
139Continuous Dirichlet density of <img class="formulaInl" alt="$n$" src="form_73.png">-dimensional variable <img class="formulaInl" alt="$x$" src="form_28.png"> <p class="formulaDsp">
140<img class="formulaDsp" alt="\[ f(x|\beta) = \frac{\Gamma[\gamma]}{\prod_{i=1}^{n}\Gamma(\beta_i)} \prod_{i=1}^{n}x_i^{\beta_i-1} \]" src="form_76.png">
141<p>
142 where <img class="formulaInl" alt="$\gamma=\sum_i \beta_i$" src="form_77.png">. <hr>The documentation for this class was generated from the following file:<ul>
143<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
144</div>
[181]145<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:13 2008 for mixpp by&nbsp;
[171]146<a href="http://www.doxygen.org/index.html">
147<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
148</body>
149</html>
Note: See TracBrowser for help on using the browser.