root/doc/html/classmepdf.html @ 219

Revision 219, 14.9 kB (checked in by smidl, 17 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: mepdf 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>mepdf Class Reference<br>
28<small>
29[<a class="el" href="group__core.html">Core BDM classes</a>]</small>
30</h1><!-- doxytag: class="mepdf" --><!-- doxytag: inherits="mpdf" -->Unconditional <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>, allows using <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> in the role of <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>. 
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 mepdf:</div>
37<div class="dynsection">
38<p><center><img src="classmepdf__inherit__graph.png" border="0" usemap="#mepdf__inherit__map" alt="Inheritance graph"></center>
39<map name="mepdf__inherit__map">
40<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="9,7,63,33"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
43Collaboration diagram for mepdf:</div>
44<div class="dynsection">
45<p><center><img src="classmepdf__coll__graph.png" border="0" usemap="#mepdf__coll__map" alt="Collaboration graph"></center>
46<map name="mepdf__coll__map">
47<area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="9,204,63,231"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="23,7,60,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="57,105,105,132"></map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
51<a href="classmepdf-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"><a class="anchor" name="0f39973ffd94c1e20e2d8aacc4adc6fa"></a><!-- doxytag: member="mepdf::mepdf" ref="0f39973ffd94c1e20e2d8aacc4adc6fa" args="(const epdf *em)" -->
55&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmepdf.html#0f39973ffd94c1e20e2d8aacc4adc6fa">mepdf</a> (const <a class="el" href="classepdf.html">epdf</a> *em)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc87d89dbc3cf5eb6a0ad7d6d572488f"></a><!-- doxytag: member="mepdf::condition" ref="bc87d89dbc3cf5eb6a0ad7d6d572488f" args="(const vec &amp;cond)" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmepdf.html#bc87d89dbc3cf5eb6a0ad7d6d572488f">condition</a> (const vec &amp;cond)</td></tr>
60
61<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>
62<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>
63
64<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>
65<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>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#b1dae6171ee39a6a05976c7b1007a3c5"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ef8a6374029d990a678782f6decebbe"></a><!-- doxytag: member="mepdf::evallogcond" ref="2ef8a6374029d990a678782f6decebbe" args="(const vec &amp;dt, const vec &amp;cond)" -->
69virtual 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>
70
71<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>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95fcff214848f66f1b489459370573fa"></a><!-- doxytag: member="mepdf::evallogcond_m" ref="95fcff214848f66f1b489459370573fa" args="(const mat &amp;Dt, const vec &amp;cond)" -->
73virtual 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>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15ef062183b1ccdf794732d5fa0b77cd"></a><!-- doxytag: member="mepdf::_rvc" ref="15ef062183b1ccdf794732d5fa0b77cd" args="() const " -->
77<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>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71256ffb5fbd08f41d650e606a5bd585"></a><!-- doxytag: member="mepdf::_rv" ref="71256ffb5fbd08f41d650e606a5bd585" args="() const " -->
81<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>
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="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mepdf::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
85<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>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mepdf::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
90<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>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mepdf::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
94<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>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mepdf::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
98<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>
99
100<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>
101</table>
102<hr><a name="_details"></a><h2>Detailed Description</h2>
103Unconditional <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>, allows using <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> in the role of <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>.
104<p>
105<hr><h2>Member Function Documentation</h2>
106<a class="anchor" name="3f172b79ec4a5ebc87898a5381141f1b"></a><!-- doxytag: member="mepdf::samplecond" ref="3f172b79ec4a5ebc87898a5381141f1b" args="(const vec &amp;cond, double &amp;ll)" -->
107<div class="memitem">
108<div class="memproto">
109      <table class="memname">
110        <tr>
111          <td class="memname">virtual vec mpdf::samplecond           </td>
112          <td>(</td>
113          <td class="paramtype">const vec &amp;&nbsp;</td>
114          <td class="paramname"> <em>cond</em>, </td>
115        </tr>
116        <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">double &amp;&nbsp;</td>
120          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
121        </tr>
122        <tr>
123          <td></td>
124          <td>)</td>
125          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
126        </tr>
127      </table>
128</div>
129<div class="memdoc">
130
131<p>
132Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
133<p>
134Returns 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>
135  <table border="0" cellspacing="2" cellpadding="0">
136    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
137    <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>
138  </table>
139</dl>
140
141<p>Reimplemented in <a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">mprod</a>.</p>
142
143<p>References <a class="el" href="libBM_8h-source.html#l00235">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00216">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
144
145<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>
146
147</div>
148</div><p>
149<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mepdf::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
150<div class="memitem">
151<div class="memproto">
152      <table class="memname">
153        <tr>
154          <td class="memname">virtual mat mpdf::samplecond_m           </td>
155          <td>(</td>
156          <td class="paramtype">const vec &amp;&nbsp;</td>
157          <td class="paramname"> <em>cond</em>, </td>
158        </tr>
159        <tr>
160          <td class="paramkey"></td>
161          <td></td>
162          <td class="paramtype">vec &amp;&nbsp;</td>
163          <td class="paramname"> <em>ll</em>, </td>
164        </tr>
165        <tr>
166          <td class="paramkey"></td>
167          <td></td>
168          <td class="paramtype">int&nbsp;</td>
169          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
170        </tr>
171        <tr>
172          <td></td>
173          <td>)</td>
174          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
175        </tr>
176      </table>
177</div>
178<div class="memdoc">
179
180<p>
181Returns.
182<p>
183<dl compact><dt><b>Parameters:</b></dt><dd>
184  <table border="0" cellspacing="2" cellpadding="0">
185    <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>
186    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
187    <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>
188  </table>
189</dl>
190
191<p>References <a class="el" href="libBM_8h-source.html#l00235">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00216">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00212">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
192
193</div>
194</div><p>
195<hr>The documentation for this class was generated from the following file:<ul>
196<li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
197</div>
198<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 4 14:42:24 2008 for mixpp by&nbsp;
199<a href="http://www.doxygen.org/index.html">
200<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
201</body>
202</html>
Note: See TracBrowser for help on using the browser.