root/doc/html/classmepdf.html @ 234

Revision 234, 15.2 kB (checked in by smidl, 15 years ago)

doc

RevLine 
[33]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">
[139]3<title>mixpp: mepdf Class Reference</title>
[33]4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
[139]7<!-- Generated by Doxygen 1.5.6 -->
[91]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>
[219]13      <li><a href="modules.html"><span>Modules</span></a></li>
[91]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>
[33]25</div>
[91]26<div class="contents">
[219]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>. 
[33]31<a href="#_details">More...</a>
32<p>
[139]33<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
[33]34<p>
35<div class="dynheader">
[139]36Inheritance diagram for mepdf:</div>
[33]37<div class="dynsection">
[139]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>
[33]41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
[139]43Collaboration diagram for mepdf:</div>
[33]44<div class="dynsection">
[139]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>
[33]48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
[139]51<a href="classmepdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
[33]52<tr><td></td></tr>
53<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
[210]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>
[33]56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
[210]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>
[162]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>
[33]63
[234]64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.  <a href="#3f172b79ec4a5ebc87898a5381141f1b"></a><br></td></tr>
[219]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>
[139]66
[219]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>
[33]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>
[219]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>
[33]74
[219]75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
[210]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
[33]79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[210]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>
[162]82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[139]84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="mepdf::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
[33]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>
[234]88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75ded3b0f657cd7da6590691a810963c"></a><!-- doxytag: member="mepdf::_e" ref="75ded3b0f657cd7da6590691a810963c" args="()" -->
89<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#75ded3b0f657cd7da6590691a810963c">_e</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[33]92<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
[139]93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="mepdf::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
[33]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>
[139]97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="mepdf::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
[33]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>
[139]101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="mepdf::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
[33]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>
[139]107Unconditional <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>.
[33]108<p>
[210]109<hr><h2>Member Function Documentation</h2>
[162]110<a class="anchor" name="3f172b79ec4a5ebc87898a5381141f1b"></a><!-- doxytag: member="mepdf::samplecond" ref="3f172b79ec4a5ebc87898a5381141f1b" args="(const vec &amp;cond, double &amp;ll)" -->
[33]111<div class="memitem">
112<div class="memproto">
113      <table class="memname">
114        <tr>
115          <td class="memname">virtual vec mpdf::samplecond           </td>
116          <td>(</td>
[162]117          <td class="paramtype">const vec &amp;&nbsp;</td>
[33]118          <td class="paramname"> <em>cond</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">double &amp;&nbsp;</td>
124          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
125        </tr>
126        <tr>
127          <td></td>
128          <td>)</td>
[139]129          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
[33]130        </tr>
131      </table>
132</div>
133<div class="memdoc">
134
135<p>
[234]136Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
[33]137<p>
[234]138<dl compact><dt><b>Parameters:</b></dt><dd>
[33]139  <table border="0" cellspacing="2" cellpadding="0">
140    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
141    <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>
142  </table>
143</dl>
144
[210]145<p>Reimplemented in <a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">mprod</a>.</p>
[33]146
[234]147<p>References <a class="el" href="libBM_8h-source.html#l00239">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00222">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>
[171]148
[234]149<p>Referenced by <a class="el" href="libPF_8h-source.html#l00147">MPF&lt; BM_T &gt;::bayes()</a>, and <a class="el" href="libPF_8cpp-source.html#l00007">PF::bayes()</a>.</p>
[91]150
[33]151</div>
152</div><p>
[219]153<a class="anchor" name="b1dae6171ee39a6a05976c7b1007a3c5"></a><!-- doxytag: member="mepdf::samplecond_m" ref="b1dae6171ee39a6a05976c7b1007a3c5" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
[139]154<div class="memitem">
155<div class="memproto">
156      <table class="memname">
157        <tr>
[219]158          <td class="memname">virtual mat mpdf::samplecond_m           </td>
[139]159          <td>(</td>
[162]160          <td class="paramtype">const vec &amp;&nbsp;</td>
[139]161          <td class="paramname"> <em>cond</em>, </td>
162        </tr>
163        <tr>
164          <td class="paramkey"></td>
165          <td></td>
166          <td class="paramtype">vec &amp;&nbsp;</td>
167          <td class="paramname"> <em>ll</em>, </td>
168        </tr>
169        <tr>
170          <td class="paramkey"></td>
171          <td></td>
172          <td class="paramtype">int&nbsp;</td>
173          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
174        </tr>
175        <tr>
176          <td></td>
177          <td>)</td>
178          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
179        </tr>
180      </table>
181</div>
182<div class="memdoc">
183
184<p>
[145]185Returns.
[139]186<p>
187<dl compact><dt><b>Parameters:</b></dt><dd>
188  <table border="0" cellspacing="2" cellpadding="0">
[145]189    <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>
[139]190    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
191    <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>
192  </table>
193</dl>
194
[234]195<p>References <a class="el" href="libBM_8h-source.html#l00239">mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00077">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00222">mpdf::ep</a>, <a class="el" href="classepdf.html#e1996af1da1fa1214270066a96ca113e">epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00218">mpdf::rv</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
[139]196
197</div>
198</div><p>
[33]199<hr>The documentation for this class was generated from the following file:<ul>
[145]200<li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
[91]201</div>
[234]202<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:51:19 2009 for mixpp by&nbsp;
[33]203<a href="http://www.doxygen.org/index.html">
[139]204<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
[33]205</body>
206</html>
Note: See TracBrowser for help on using the browser.