root/doc/html/classmpdf.html @ 143

Revision 139, 14.3 kB (checked in by smidl, 16 years ago)

Documentation update

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 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>mpdf Class Reference</h1><!-- doxytag: class="mpdf" -->Conditional probability density, e.g. modeling some dependencies. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for mpdf:</div>
33<div class="dynsection">
34<p><center><img src="classmpdf__inherit__graph.png" border="0" usemap="#mpdf__inherit__map" alt="Inheritance graph"></center>
35<map name="mpdf__inherit__map">
36<area shape="rect" href="classmEF.html" title="Exponential family model." alt="" coords="99,84,147,111"><area shape="rect" href="classmepdf.html" title="Unconditional mpdf, allows using epdf in the role of mpdf." alt="" coords="171,84,232,111"><area shape="rect" href="classmmix.html" title="Mixture of mpdfs with constant weights." alt="" coords="256,84,312,111"><area shape="rect" href="classmgamma.html" title="Gamma random walk." alt="" coords="16,161,99,188"><area shape="rect" href="classmlnorm.html" title="Normal distributed linear function with linear function of mean value;." alt="" coords="123,161,253,188"><area shape="rect" href="classmgamma__fix.html" title="Gamma random walk around a fixed point." alt="" coords="5,239,109,265"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for mpdf:</div>
40<div class="dynsection">
41<p><center><img src="classmpdf__coll__graph.png" border="0" usemap="#mpdf__coll__map" alt="Collaboration graph"></center>
42<map name="mpdf__coll__map">
43<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>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classmpdf-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">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#b0193a350c97933ddf15b15a130da352">samplecond</a> (vec &amp;cond, double &amp;ll)</td></tr>
51
52<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="#b0193a350c97933ddf15b15a130da352"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#6bf806badfdac606c847e458e8fce18c">samplecond</a> (vec &amp;cond, vec &amp;ll, int N)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.  <a href="#6bf806badfdac606c847e458e8fce18c"></a><br></td></tr>
56<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)" -->
57virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">condition</a> (const vec &amp;cond)</td></tr>
58
59<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>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80b738ece5bd4f8c4edaee4b38906f91"></a><!-- doxytag: member="mpdf::evalcond" ref="80b738ece5bd4f8c4edaee4b38906f91" args="(const vec &amp;dt, const vec &amp;cond)" -->
61virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#80b738ece5bd4f8c4edaee4b38906f91">evalcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
62
63<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>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6788be9f3a888796499c5293a318fcfb"></a><!-- doxytag: member="mpdf::~mpdf" ref="6788be9f3a888796499c5293a318fcfb" args="()" -->
65virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#6788be9f3a888796499c5293a318fcfb">~mpdf</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
68<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)" -->
69&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>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec9c850305984582548e8deb64f0ffe8"></a><!-- doxytag: member="mpdf::_rvc" ref="ec9c850305984582548e8deb64f0ffe8" args="()" -->
73<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#ec9c850305984582548e8deb64f0ffe8">_rvc</a> ()</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mpdf::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
77<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>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
80<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mpdf::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
82<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>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mpdf::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
86<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>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mpdf::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
90<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>
91
92<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>
93</table>
94<hr><a name="_details"></a><h2>Detailed Description</h2>
95Conditional probability density, e.g. modeling some dependencies. <hr><h2>Member Function Documentation</h2>
96<a class="anchor" name="b0193a350c97933ddf15b15a130da352"></a><!-- doxytag: member="mpdf::samplecond" ref="b0193a350c97933ddf15b15a130da352" args="(vec &amp;cond, double &amp;ll)" -->
97<div class="memitem">
98<div class="memproto">
99      <table class="memname">
100        <tr>
101          <td class="memname">virtual vec mpdf::samplecond           </td>
102          <td>(</td>
103          <td class="paramtype">vec &amp;&nbsp;</td>
104          <td class="paramname"> <em>cond</em>, </td>
105        </tr>
106        <tr>
107          <td class="paramkey"></td>
108          <td></td>
109          <td class="paramtype">double &amp;&nbsp;</td>
110          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
111        </tr>
112        <tr>
113          <td></td>
114          <td>)</td>
115          <td></td><td></td><td><code> [inline, virtual]</code></td>
116        </tr>
117      </table>
118</div>
119<div class="memdoc">
120
121<p>
122Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
123<p>
124Returns 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>
125  <table border="0" cellspacing="2" cellpadding="0">
126    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
127    <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>
128  </table>
129</dl>
130
131<p>Reimplemented in <a class="el" href="classmlnorm.html#decf3e3b5c8e0812e5b4dbe94fa2ae18">mlnorm&lt; sq_T &gt;</a>, and <a class="el" href="classmgamma.html#9f40dc43885085fad8e3d6652b79e139">mgamma</a>.</p>
132
133<p>References <a class="el" href="libBM_8h-source.html#l00180">condition()</a>, <a class="el" href="libBM_8h-source.html#l00163">ep</a>, <a class="el" href="classepdf.html#6aef3eca74899692503769c18add1a4c">epdf::evalpdflog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
134
135<p>Referenced by <a class="el" href="libPF_8h-source.html#l00137">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p>
136
137</div>
138</div><p>
139<a class="anchor" name="6bf806badfdac606c847e458e8fce18c"></a><!-- doxytag: member="mpdf::samplecond" ref="6bf806badfdac606c847e458e8fce18c" args="(vec &amp;cond, vec &amp;ll, int N)" -->
140<div class="memitem">
141<div class="memproto">
142      <table class="memname">
143        <tr>
144          <td class="memname">virtual mat mpdf::samplecond           </td>
145          <td>(</td>
146          <td class="paramtype">vec &amp;&nbsp;</td>
147          <td class="paramname"> <em>cond</em>, </td>
148        </tr>
149        <tr>
150          <td class="paramkey"></td>
151          <td></td>
152          <td class="paramtype">vec &amp;&nbsp;</td>
153          <td class="paramname"> <em>ll</em>, </td>
154        </tr>
155        <tr>
156          <td class="paramkey"></td>
157          <td></td>
158          <td class="paramtype">int&nbsp;</td>
159          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
160        </tr>
161        <tr>
162          <td></td>
163          <td>)</td>
164          <td></td><td></td><td><code> [inline, virtual]</code></td>
165        </tr>
166      </table>
167</div>
168<div class="memdoc">
169
170<p>
171Returns N samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
172<p>
173<dl compact><dt><b>Parameters:</b></dt><dd>
174  <table border="0" cellspacing="2" cellpadding="0">
175    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
176    <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>
177  </table>
178</dl>
179
180<p>Reimplemented in <a class="el" href="classmlnorm.html#215fb88cc8b95d64cdefd6849abdd1e8">mlnorm&lt; sq_T &gt;</a>, and <a class="el" href="classmgamma.html#e9d52749793f40aad85b70c6db4435ae">mgamma</a>.</p>
181
182<p>References <a class="el" href="libBM_8h-source.html#l00180">condition()</a>, <a class="el" href="libBM_8h-source.html#l00057">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00163">ep</a>, <a class="el" href="classepdf.html#6aef3eca74899692503769c18add1a4c">epdf::evalpdflog()</a>, <a class="el" href="libBM_8h-source.html#l00159">rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
183
184</div>
185</div><p>
186<hr>The documentation for this class was generated from the following file:<ul>
187<li>work/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
188</div>
189<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 16 11:58:55 2008 for mixpp by&nbsp;
190<a href="http://www.doxygen.org/index.html">
191<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
192</body>
193</html>
Note: See TracBrowser for help on using the browser.