root/doc/html/classeEF.html @ 255

Revision 234, 13.7 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: eEF 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><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>eEF Class Reference</h1><!-- doxytag: class="eEF" --><!-- doxytag: inherits="epdf" -->General conjugate exponential family posterior density. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for eEF:</div>
34<div class="dynsection">
35<p><center><img src="classeEF__inherit__graph.png" border="0" usemap="#eEF__inherit__map" alt="Inheritance graph"></center>
36<map name="eEF__inherit__map">
37<area shape="rect" href="classeDirich.html" title="Dirichlet posterior density." alt="" coords="5,167,69,193"><area shape="rect" href="classegamma.html" title="Gamma posterior density." alt="" coords="93,167,173,193"><area shape="rect" href="classegiw.html" title="Gauss&#45;inverse&#45;Wishart density stored in LD form." alt="" coords="197,167,245,193"><area shape="rect" href="classeigamma.html" title="Inverse&#45;Gamma posterior density." alt="" coords="269,167,352,193"><area shape="rect" href="classenorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix." alt="" coords="499,167,621,193"><area shape="rect" href="classenorm.html" title="enorm\&lt; ldmat \&gt;" alt="" coords="340,263,471,289"><area shape="rect" href="classenorm.html" title="enorm\&lt; chmat \&gt;" alt="" coords="688,263,821,289"><area shape="rect" href="classenorm.html" title="enorm\&lt; fsqmat \&gt;" alt="" coords="503,263,641,289"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="325,7,373,33"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for eEF:</div>
41<div class="dynsection">
42<p><center><img src="classeEF__coll__graph.png" border="0" usemap="#eEF__coll__map" alt="Collaboration graph"></center>
43<map name="eEF__coll__map">
44<area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="5,95,51,119"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="9,7,47,31"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classeEF-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e3c63655e8375c76bf1f421245427a7"></a><!-- doxytag: member="eEF::eEF" ref="7e3c63655e8375c76bf1f421245427a7" args="(const RV &amp;rv)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#7e3c63655e8375c76bf1f421245427a7">eEF</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69e5680dac10375d62520d26c672477d"></a><!-- doxytag: member="eEF::lognc" ref="69e5680dac10375d62520d26c672477d" args="() const =0" -->
56virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#69e5680dac10375d62520d26c672477d">lognc</a> () const =0</td></tr>
57
58<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>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a89bef8996410609004fa019b5b48964"></a><!-- doxytag: member="eEF::dupdate" ref="a89bef8996410609004fa019b5b48964" args="(mat &amp;v)" -->
60virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#a89bef8996410609004fa019b5b48964">dupdate</a> (mat &amp;v)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">TODO decide if it is really needed. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="41c70565b4d3fb424599817d008f0c71"></a><!-- doxytag: member="eEF::evallog_nn" ref="41c70565b4d3fb424599817d008f0c71" args="(const vec &amp;val) const " -->
64virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#41c70565b4d3fb424599817d008f0c71">evallog_nn</a> (const vec &amp;val) const </td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="357512dd565e199904d367294b7dd862"></a><!-- doxytag: member="eEF::evallog" ref="357512dd565e199904d367294b7dd862" args="(const vec &amp;val) const " -->
68virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#357512dd565e199904d367294b7dd862">evallog</a> (const vec &amp;val) const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability. <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cff03a658aec11b806c3e3d48f37b81f"></a><!-- doxytag: member="eEF::evallog" ref="cff03a658aec11b806c3e3d48f37b81f" args="(const mat &amp;Val) const " -->
72virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#cff03a658aec11b806c3e3d48f37b81f">evallog</a> (const mat &amp;Val) const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluate normalized log-probability for many samples. <br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f8385dd1cc9740522dc373b1dc3cbf5"></a><!-- doxytag: member="eEF::pow" ref="4f8385dd1cc9740522dc373b1dc3cbf5" args="(double p)" -->
76virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeEF.html#4f8385dd1cc9740522dc373b1dc3cbf5">pow</a> (double p)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Power of the density, used e.g. to flatten the density. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8019654e494bf5e458f6fb947e11b262"></a><!-- doxytag: member="eEF::sample" ref="8019654e494bf5e458f6fb947e11b262" args="() const =0" -->
80virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">sample</a> () const =0</td></tr>
81
82<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>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76608914c3b19e150292d5c56e93e508"></a><!-- doxytag: member="eEF::sample_m" ref="76608914c3b19e150292d5c56e93e508" args="(int N) const " -->
84virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#76608914c3b19e150292d5c56e93e508">sample_m</a> (int N) const </td></tr>
85
86<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>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2495a04bbacb9b55fe5a3a59b78affca"></a><!-- doxytag: member="eEF::evallog_m" ref="2495a04bbacb9b55fe5a3a59b78affca" args="(const mat &amp;Val) const " -->
88virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#2495a04bbacb9b55fe5a3a59b78affca">evallog_m</a> (const mat &amp;Val) const </td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e87dc8260a5c37bc1b03eb66174741a0"></a><!-- doxytag: member="eEF::condition" ref="e87dc8260a5c37bc1b03eb66174741a0" args="(const RV &amp;rv) const " -->
92virtual <a class="el" href="classmpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#e87dc8260a5c37bc1b03eb66174741a0">condition</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>) const </td></tr>
93
94<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>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38de9f59b65ee06028554f3f74b66025"></a><!-- doxytag: member="eEF::marginal" ref="38de9f59b65ee06028554f3f74b66025" args="(const RV &amp;rv) const " -->
96virtual <a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#38de9f59b65ee06028554f3f74b66025">marginal</a> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>) const </td></tr>
97
98<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>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf0a070a8f3e67a93604ca724638b870"></a><!-- doxytag: member="eEF::mean" ref="bf0a070a8f3e67a93604ca724638b870" args="() const =0" -->
100virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#bf0a070a8f3e67a93604ca724638b870">mean</a> () const =0</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29f17cea338692f4cb6d4ac9f7d89e1f"></a><!-- doxytag: member="eEF::variance" ref="29f17cea338692f4cb6d4ac9f7d89e1f" args="() const =0" -->
104virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#29f17cea338692f4cb6d4ac9f7d89e1f">variance</a> () const =0</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="eEF::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
108const <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>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="eEF::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
112void&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>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
115<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="eEF::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
117<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>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
120</table>
121<hr><a name="_details"></a><h2>Detailed Description</h2>
122General conjugate exponential family posterior density.
123<p>
124More?... <hr>The documentation for this class was generated from the following file:<ul>
125<li>work/git/mixpp/bdm/stat/<a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
126</div>
127<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:50:55 2009 for mixpp by&nbsp;
128<a href="http://www.doxygen.org/index.html">
129<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
130</body>
131</html>
Note: See TracBrowser for help on using the browser.