root/doc/html/classbdm_1_1mpdf.html @ 375

Revision 375, 17.7 kB (checked in by smidl, 16 years ago)

doc - \ to /

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::mpdf Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mpdf.html">mpdf</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::mpdf Class Reference</h1><!-- doxytag: class="bdm::mpdf" --><!-- doxytag: inherits="bdm::bdmroot" -->Conditional probability density, e.g. modeling some dependencies. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1mpdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mpdf::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
82virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::mpdf::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
86virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mpdf::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
90virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::mpdf::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
94virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
97<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc3f5e531994dd42447d678deb92fe48"></a><!-- doxytag: member="bdm::mpdf::mpdf" ref="dc3f5e531994dd42447d678deb92fe48" args="()" -->
99&nbsp;</td><td class="memItemRight" valign="bottom"><b>mpdf</b> ()</td></tr>
100
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7089fcbd918f201fdf4256119e31f173"></a><!-- doxytag: member="bdm::mpdf::mpdf" ref="7089fcbd918f201fdf4256119e31f173" args="(const mpdf &amp;m)" -->
102&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7089fcbd918f201fdf4256119e31f173">mpdf</a> (const <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> &amp;m)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">copy constructor does not set pointer <code>ep</code> - has to be done in offsprings! <br></td></tr>
105<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
106<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>
107
108<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_49.png">.  <a href="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
109<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>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db94784a9aacf74c65c5a014f6743530"></a><!-- doxytag: member="bdm::mpdf::condition" ref="db94784a9aacf74c65c5a014f6743530" args="(const vec &amp;cond)" -->
113virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#db94784a9aacf74c65c5a014f6743530">condition</a> (const vec &amp;cond)</td></tr>
114
115<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>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mpdf::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
117virtual 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>
118
119<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>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mpdf::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
121virtual 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>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
124<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mpdf::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
126<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
127
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mpdf::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
129<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
130
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mpdf::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
133
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mpdf::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
135int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
136
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mpdf::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
138<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
139
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mpdf::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
141<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
142
143<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mpdf::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
145void&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>
146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mpdf::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
148void&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>
149
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mpdf::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
151bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
152
153<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mpdf::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
155int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mpdf::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
159<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>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
162<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mpdf::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
163<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>
164
165<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>
166</table>
167<hr><a name="_details"></a><h2>Detailed Description</h2>
168Conditional probability density, e.g. modeling some dependencies. <hr><h2>Member Function Documentation</h2>
169<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mpdf::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
170<div class="memitem">
171<div class="memproto">
172      <table class="memname">
173        <tr>
174          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
175          <td>(</td>
176          <td class="paramtype">const vec &amp;&nbsp;</td>
177          <td class="paramname"> <em>cond</em>          </td>
178          <td>&nbsp;)&nbsp;</td>
179          <td><code> [inline, virtual]</code></td>
180        </tr>
181      </table>
182</div>
183<div class="memdoc">
184
185<p>
186Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_49.png">.
187<p>
188<dl compact><dt><b>Parameters:</b></dt><dd>
189  <table border="0" cellspacing="2" cellpadding="0">
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  </table>
192</dl>
193
194<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
195
196<p>References <a class="el" href="libBM_8h-source.html#l00345">condition()</a>, <a class="el" href="libBM_8h-source.html#l00318">ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p>
197
198<p>Referenced by <a class="el" href="libPF_8h-source.html#l00207">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>
199
200</div>
201</div><p>
202<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mpdf::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
203<div class="memitem">
204<div class="memproto">
205      <table class="memname">
206        <tr>
207          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
208          <td>(</td>
209          <td class="paramtype">const vec &amp;&nbsp;</td>
210          <td class="paramname"> <em>cond</em>, </td>
211        </tr>
212        <tr>
213          <td class="paramkey"></td>
214          <td></td>
215          <td class="paramtype">int&nbsp;</td>
216          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
217        </tr>
218        <tr>
219          <td></td>
220          <td>)</td>
221          <td></td><td></td><td><code> [inline, virtual]</code></td>
222        </tr>
223      </table>
224</div>
225<div class="memdoc">
226
227<p>
228Returns.
229<p>
230<dl compact><dt><b>Parameters:</b></dt><dd>
231  <table border="0" cellspacing="2" cellpadding="0">
232    <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_49.png">. </td></tr>
233    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
234  </table>
235</dl>
236
237<p>References <a class="el" href="libBM_8h-source.html#l00345">condition()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00318">ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p>
238
239</div>
240</div><p>
241<hr>The documentation for this class was generated from the following file:<ul>
242<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
243</div>
244<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 13:47:07 2009 for mixpp by&nbsp;
245<a href="http://www.doxygen.org/index.html">
246<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
247</body>
248</html>
Note: See TracBrowser for help on using the browser.