root/doc/html/classbdm_1_1mepdf.html @ 270

Revision 270, 15.0 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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: bdm::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><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1mepdf.html">mepdf</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::mepdf Class Reference</h1><!-- doxytag: class="bdm::mepdf" --><!-- doxytag: inherits="bdm::mpdf" --><code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::mepdf:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1mepdf__inherit__graph.png" border="0" usemap="#bdm_1_1mepdf__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1mepdf__inherit__map">
38<area shape="rect" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="16,84,107,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
42<a href="classbdm_1_1mepdf-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Unconditional <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>, allows using <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> in the role of <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>.
44<p>
45<table border="0" cellpadding="0" cellspacing="0">
46<tr><td></td></tr>
47<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27cc32d1a810516c25bda51ddf886376"></a><!-- doxytag: member="bdm::mepdf::mepdf" ref="27cc32d1a810516c25bda51ddf886376" args="(const epdf *em)" -->
49&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#27cc32d1a810516c25bda51ddf886376">mepdf</a> (const <a class="el" href="classbdm_1_1epdf.html">epdf</a> *em)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2b898058169e7ed9a6dc7cd4e1c147c"></a><!-- doxytag: member="bdm::mepdf::condition" ref="b2b898058169e7ed9a6dc7cd4e1c147c" args="(const vec &amp;cond)" -->
53void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#b2b898058169e7ed9a6dc7cd4e1c147c">condition</a> (const vec &amp;cond)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
56<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#f0c1db6fcbb3aae2dd6123884457a367">samplecond</a> (const vec &amp;cond)</td></tr>
58
59<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="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#afe4185b26baeb03688202e254d3b005">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mepdf::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
64virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#6336a8a72462e2a56a3989a220f18b1b">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classbdm_1_1epdf.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>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mepdf::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
68virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#0b0ed1ed663071bb7cf4a1349eb94fcb">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
71<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mepdf::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
73<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
74
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mepdf::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
76<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mepdf::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
79int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
80
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mepdf::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
82int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
83
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mepdf::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
85<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
86
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mepdf::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
88<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
89
90<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mepdf::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
92void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvc</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvc0)</td></tr>
93
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mepdf::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
96
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mepdf::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
98bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
99
100<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mepdf::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mepdf::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
106<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288">rvc</a></td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mepdf::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
110<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5eea43c56d38e4441bfb30270db949c0">ep</a></td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
113</table>
114<hr><h2>Member Function Documentation</h2>
115<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mepdf::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
116<div class="memitem">
117<div class="memproto">
118      <table class="memname">
119        <tr>
120          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
121          <td>(</td>
122          <td class="paramtype">const vec &amp;&nbsp;</td>
123          <td class="paramname"> <em>cond</em>          </td>
124          <td>&nbsp;)&nbsp;</td>
125          <td><code> [inline, virtual, inherited]</code></td>
126        </tr>
127      </table>
128</div>
129<div class="memdoc">
130
131<p>
132Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">.
133<p>
134<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  </table>
138</dl>
139
140<p>References <a class="el" href="libBM_8h-source.html#l00315">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00288">bdm::mpdf::ep</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::epdf::sample()</a>.</p>
141
142<p>Referenced by <a class="el" href="libPF_8h-source.html#l00143">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="libPF_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="libDS_8cpp-source.html#l00044">bdm::ArxDS::step()</a>.</p>
143
144</div>
145</div><p>
146<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mepdf::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
147<div class="memitem">
148<div class="memproto">
149      <table class="memname">
150        <tr>
151          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
152          <td>(</td>
153          <td class="paramtype">const vec &amp;&nbsp;</td>
154          <td class="paramname"> <em>cond</em>, </td>
155        </tr>
156        <tr>
157          <td class="paramkey"></td>
158          <td></td>
159          <td class="paramtype">int&nbsp;</td>
160          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
161        </tr>
162        <tr>
163          <td></td>
164          <td>)</td>
165          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
166        </tr>
167      </table>
168</div>
169<div class="memdoc">
170
171<p>
172Returns.
173<p>
174<dl compact><dt><b>Parameters:</b></dt><dd>
175  <table border="0" cellspacing="2" cellpadding="0">
176    <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>
177    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
178    <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>
179  </table>
180</dl>
181
182<p>References <a class="el" href="libBM_8h-source.html#l00315">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00272">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00288">bdm::mpdf::ep</a>, and <a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">bdm::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><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 Wed Feb 11 23:34:05 2009 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.