root/doc/html/classmpdf.html @ 219

Revision 219, 15.6 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: mpdf 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>mpdf Class Reference<br>
28<small>
29[<a class="el" href="group__core.html">Core BDM classes</a>]</small>
30</h1><!-- doxytag: class="mpdf" -->Conditional probability density, e.g. modeling some dependencies. 
31<a href="#_details">More...</a>
32<p>
33<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
34<p>
35<div class="dynheader">
36Inheritance diagram for mpdf:</div>
37<div class="dynsection">
38<p><center><img src="classmpdf__inherit__graph.png" border="0" usemap="#mpdf__inherit__map" alt="Inheritance graph"></center>
39<map name="mpdf__inherit__map">
40<area shape="rect" href="classmEF.html" title="Exponential family model." alt="" coords="164,87,212,113"><area shape="rect" href="classmepdf.html" title="Unconditional mpdf, allows using epdf in the role of mpdf." alt="" coords="236,87,297,113"><area shape="rect" href="classmmix.html" title="Mixture of mpdfs with constant weights, all mpdfs are of equal type." alt="" coords="321,87,377,113"><area shape="rect" href="classmprod.html" title="Chain rule decomposition of epdf." alt="" coords="401,87,465,113"><area shape="rect" href="classmratio.html" title="Class representing ratio of two densities which arise e.g. by applying the Bayes..." alt="" coords="489,87,553,113"><area shape="rect" href="classmgamma.html" title="Gamma random walk." alt="" coords="16,167,99,193"><area shape="rect" href="classmlnorm.html" title="Normal distributed linear function with linear function of mean value;." alt="" coords="123,167,253,193"><area shape="rect" href="classmlnorm.html" title="mlnorm\&lt; ldmat \&gt;" alt="" coords="177,263,316,289"><area shape="rect" href="classmgamma__fix.html" title="Gamma random walk around a fixed point." alt="" coords="5,263,109,289"><area shape="rect" href="classmlstudent.html" title="mlstudent" alt="" coords="204,343,289,369"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
43Collaboration diagram for mpdf:</div>
44<div class="dynsection">
45<p><center><img src="classmpdf__coll__graph.png" border="0" usemap="#mpdf__coll__map" alt="Collaboration graph"></center>
46<map name="mpdf__coll__map">
47<area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="17,7,55,31"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="51,96,96,120"></map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
51<a href="classmpdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
52<tr><td></td></tr>
53<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#3f172b79ec4a5ebc87898a5381141f1b">samplecond</a> (const vec &amp;cond, double &amp;ll)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.  <a href="#3f172b79ec4a5ebc87898a5381141f1b"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#b1dae6171ee39a6a05976c7b1007a3c5">samplecond_m</a> (const vec &amp;cond, vec &amp;ll, int N)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#b1dae6171ee39a6a05976c7b1007a3c5"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f95a0cc6ab40611f46804682446ed83"></a><!-- doxytag: member="mpdf::condition" ref="0f95a0cc6ab40611f46804682446ed83" args="(const vec &amp;cond)" -->
61virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">condition</a> (const vec &amp;cond)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ef8a6374029d990a678782f6decebbe"></a><!-- doxytag: member="mpdf::evallogcond" ref="2ef8a6374029d990a678782f6decebbe" args="(const vec &amp;dt, const vec &amp;cond)" -->
65virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#2ef8a6374029d990a678782f6decebbe">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. In some cases, this operation can be implemented efficiently. <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95fcff214848f66f1b489459370573fa"></a><!-- doxytag: member="mpdf::evallogcond_m" ref="95fcff214848f66f1b489459370573fa" args="(const mat &amp;Dt, const vec &amp;cond)" -->
69virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#95fcff214848f66f1b489459370573fa">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6788be9f3a888796499c5293a318fcfb"></a><!-- doxytag: member="mpdf::~mpdf" ref="6788be9f3a888796499c5293a318fcfb" args="()" -->
73virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#6788be9f3a888796499c5293a318fcfb">~mpdf</a> ()</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="581ecf362185d37c08bb31cb9d046d6f"></a><!-- doxytag: member="mpdf::mpdf" ref="581ecf362185d37c08bb31cb9d046d6f" args="(const RV &amp;rv0, const RV &amp;rvc0)" -->
77&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#581ecf362185d37c08bb31cb9d046d6f">mpdf</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv0, const <a class="el" href="classRV.html">RV</a> &amp;rvc0)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15ef062183b1ccdf794732d5fa0b77cd"></a><!-- doxytag: member="mpdf::_rvc" ref="15ef062183b1ccdf794732d5fa0b77cd" args="() const " -->
81<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#15ef062183b1ccdf794732d5fa0b77cd">_rvc</a> () const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71256ffb5fbd08f41d650e606a5bd585"></a><!-- doxytag: member="mpdf::_rv" ref="71256ffb5fbd08f41d650e606a5bd585" args="() const " -->
85<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#71256ffb5fbd08f41d650e606a5bd585">_rv</a> () const </td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mpdf::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
89<a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#e17780ee5b2cfe05922a6c56af1462f8">_epdf</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
92<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mpdf::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
94<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a></td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mpdf::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
98<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a></td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mpdf::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
102<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#7aa894208a32f3487827df6d5054424c">ep</a></td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
105</table>
106<hr><a name="_details"></a><h2>Detailed Description</h2>
107Conditional probability density, e.g. modeling some dependencies. <hr><h2>Member Function Documentation</h2>
108<a class="anchor" name="3f172b79ec4a5ebc87898a5381141f1b"></a><!-- doxytag: member="mpdf::samplecond" ref="3f172b79ec4a5ebc87898a5381141f1b" args="(const vec &amp;cond, double &amp;ll)" -->
109<div class="memitem">
110<div class="memproto">
111      <table class="memname">
112        <tr>
113          <td class="memname">virtual vec mpdf::samplecond           </td>
114          <td>(</td>
115          <td class="paramtype">const vec &amp;&nbsp;</td>
116          <td class="paramname"> <em>cond</em>, </td>
117        </tr>
118        <tr>
119          <td class="paramkey"></td>
120          <td></td>
121          <td class="paramtype">double &amp;&nbsp;</td>
122          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
123        </tr>
124        <tr>
125          <td></td>
126          <td>)</td>
127          <td></td><td></td><td><code> [inline, virtual]</code></td>
128        </tr>
129      </table>
130</div>
131<div class="memdoc">
132
133<p>
134Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
135<p>
136Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
137  <table border="0" cellspacing="2" cellpadding="0">
138    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
139    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
140  </table>
141</dl>
142
143<p>Reimplemented in <a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">mprod</a>.</p>
144
145<p>References <a class="el" href="libBM_8h-source.html#l00235">condition()</a>, <a class="el" href="libBM_8h-source.html#l00216">ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
146
147<p>Referenced by <a class="el" href="libPF_8h-source.html#l00138">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p>
148
149</div>
150</div><p>
151<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mpdf::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
152<div class="memitem">
153<div class="memproto">
154      <table class="memname">
155        <tr>
156          <td class="memname">virtual mat mpdf::samplecond_m           </td>
157          <td>(</td>
158          <td class="paramtype">const vec &amp;&nbsp;</td>
159          <td class="paramname"> <em>cond</em>, </td>
160        </tr>
161        <tr>
162          <td class="paramkey"></td>
163          <td></td>
164          <td class="paramtype">vec &amp;&nbsp;</td>
165          <td class="paramname"> <em>ll</em>, </td>
166        </tr>
167        <tr>
168          <td class="paramkey"></td>
169          <td></td>
170          <td class="paramtype">int&nbsp;</td>
171          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
172        </tr>
173        <tr>
174          <td></td>
175          <td>)</td>
176          <td></td><td></td><td><code> [inline, virtual]</code></td>
177        </tr>
178      </table>
179</div>
180<div class="memdoc">
181
182<p>
183Returns.
184<p>
185<dl compact><dt><b>Parameters:</b></dt><dd>
186  <table border="0" cellspacing="2" cellpadding="0">
187    <tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">. </td></tr>
188    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
189    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
190  </table>
191</dl>
192
193<p>References <a class="el" href="libBM_8h-source.html#l00235">condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00216">ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00212">rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
194
195</div>
196</div><p>
197<hr>The documentation for this class was generated from the following file:<ul>
198<li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
199</div>
200<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 4 14:42:26 2008 for mixpp by&nbsp;
201<a href="http://www.doxygen.org/index.html">
202<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
203</body>
204</html>
Note: See TracBrowser for help on using the browser.