root/library/doc/html/classbdm_1_1mEF.html @ 486

Revision 472, 18.8 kB (checked in by mido, 15 years ago)

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

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::mEF 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.9 -->
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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mEF.html">mEF</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::mEF Class Reference</h1><!-- doxytag: class="bdm::mEF" --><!-- doxytag: inherits="bdm::mpdf" -->Exponential family model. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1mEF-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd7caad7026b778af66e34480eec6f9e"></a><!-- doxytag: member="bdm::mEF::mEF" ref="dd7caad7026b778af66e34480eec6f9e" args="()" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mEF.html#dd7caad7026b778af66e34480eec6f9e">mEF</a> ()</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">from_setting</a> (const Setting &amp;set)</td></tr>
85
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mEF::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
87virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mEF::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
91virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mEF::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
95virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
98<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
99<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#b024f2e636e5507c755de4a6df1f1e99">samplecond</a> (const vec &amp;cond)</td></tr>
100
101<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_11.png">.  <a href="#b024f2e636e5507c755de4a6df1f1e99"></a><br></td></tr>
102<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#6e497d501331057309d2fddf63259d1a">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#6e497d501331057309d2fddf63259d1a"></a><br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db94784a9aacf74c65c5a014f6743530"></a><!-- doxytag: member="bdm::mEF::condition" ref="db94784a9aacf74c65c5a014f6743530" args="(const vec &amp;cond)" -->
106virtual 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>
107
108<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>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfcbb897bf42015a7979b17d891fd9b5"></a><!-- doxytag: member="bdm::mEF::evallogcond" ref="cfcbb897bf42015a7979b17d891fd9b5" args="(const vec &amp;dt, const vec &amp;cond)" -->
110virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#cfcbb897bf42015a7979b17d891fd9b5">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
111
112<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>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f97c61ecfb1f44ef6f08dee7bc15eab3"></a><!-- doxytag: member="bdm::mEF::evallogcond_m" ref="f97c61ecfb1f44ef6f08dee7bc15eab3" args="(const mat &amp;Dt, const vec &amp;cond)" -->
114virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#f97c61ecfb1f44ef6f08dee7bc15eab3">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d7d3c23e3273e97c12c396dcc06b606"></a><!-- doxytag: member="bdm::mEF::evallogcond_m" ref="2d7d3c23e3273e97c12c396dcc06b606" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" -->
118virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#2d7d3c23e3273e97c12c396dcc06b606">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr>
121<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mEF::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
123<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
124
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mEF::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
126<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
127
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mEF::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
129int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
130
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mEF::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
133
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c2d7d3d1d75cca84993e77867d1ffbe"></a><!-- doxytag: member="bdm::mEF::e" ref="4c2d7d3d1d75cca84993e77867d1ffbe" args="()" -->
135<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>e</b> ()</td></tr>
136
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ba1b384c9c1cb18422a8ba32a5d019"></a><!-- doxytag: member="bdm::mEF::set_ep" ref="a4ba1b384c9c1cb18422a8ba32a5d019" args="(shared_ptr&lt; epdf &gt; ep)" -->
138void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_ep</b> (<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1epdf.html">epdf</a> &gt; ep)</td></tr>
139
140<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mEF::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
142void&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>
143
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mEF::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
145void&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>
146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mEF::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
148bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
149
150<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mEF::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
152int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mEF::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
156<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>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
159</table>
160<hr><a name="_details"></a><h2>Detailed Description</h2>
161Exponential family model.
162<p>
163More?... <hr><h2>Member Function Documentation</h2>
164<a class="anchor" name="30a0bceb948e287d497c578e371b1667"></a><!-- doxytag: member="bdm::mEF::from_setting" ref="30a0bceb948e287d497c578e371b1667" args="(const Setting &amp;set)" -->
165<div class="memitem">
166<div class="memproto">
167      <table class="memname">
168        <tr>
169          <td class="memname">void bdm::mpdf::from_setting           </td>
170          <td>(</td>
171          <td class="paramtype">const Setting &amp;&nbsp;</td>
172          <td class="paramname"> <em>set</em>          </td>
173          <td>&nbsp;)&nbsp;</td>
174          <td><code> [virtual, inherited]</code></td>
175        </tr>
176      </table>
177</div>
178<div class="memdoc">
179
180<p>
181Load from structure with elements: <div class="fragment"><pre class="fragment"> { rv = {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable</span>
182   <a class="code" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a>= {<span class="keyword">class</span>=<span class="stringliteral">"RV"</span>, names=(...),}; <span class="comment">// RV describing meaning of random variable in condition</span>
183   <span class="comment">// elements of offsprings</span>
184 }
185</pre></div> 
186<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
187
188<p>Reimplemented in <a class="el" href="classbdm_1_1mepdf.html#27ef18a3e3b1b5de02739d1324bf25fb">bdm::mepdf</a>, <a class="el" href="classbdm_1_1mprod.html#bfa7478f8df1de6d8cd4c349db512831">bdm::mprod</a>, <a class="el" href="classbdm_1_1mlnorm.html#8582928555c309a2865f385dd0441fd1">bdm::mlnorm&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1mgnorm.html#d717dacc6a9eb967f8410994dc6dc6f9">bdm::mgnorm&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1mgamma.html#da2af0f327e5452bee71d1bf97452ae4">bdm::mgamma</a>, <a class="el" href="classbdm_1_1migamma__ref.html#9e7e0f7d2aa9ecca8ec1af8cbcb5ef1d">bdm::migamma_ref</a>, <a class="el" href="classbdm_1_1mlognorm.html#49e45ea13a869da607ef9be7a229128a">bdm::mlognorm</a>, <a class="el" href="classbdm_1_1mlnorm.html#8582928555c309a2865f385dd0441fd1">bdm::mlnorm&lt; chmat &gt;</a>, and <a class="el" href="classbdm_1_1mlnorm.html#8582928555c309a2865f385dd0441fd1">bdm::mlnorm&lt; ldmat &gt;</a>.</p>
189
190</div>
191</div><p>
192<a class="anchor" name="b024f2e636e5507c755de4a6df1f1e99"></a><!-- doxytag: member="bdm::mEF::samplecond" ref="b024f2e636e5507c755de4a6df1f1e99" args="(const vec &amp;cond)" -->
193<div class="memitem">
194<div class="memproto">
195      <table class="memname">
196        <tr>
197          <td class="memname">vec bdm::mpdf::samplecond           </td>
198          <td>(</td>
199          <td class="paramtype">const vec &amp;&nbsp;</td>
200          <td class="paramname"> <em>cond</em>          </td>
201          <td>&nbsp;)&nbsp;</td>
202          <td><code> [virtual, inherited]</code></td>
203        </tr>
204      </table>
205</div>
206<div class="memdoc">
207
208<p>
209Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_11.png">.
210<p>
211<dl compact><dt><b>Parameters:</b></dt><dd>
212  <table border="0" cellspacing="2" cellpadding="0">
213    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
214  </table>
215</dl>
216
217<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
218
219<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>.</p>
220
221<p>Referenced by <a class="el" href="particles_8h_source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="particles_8cpp_source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="datasources_8cpp_source.html#l00043">bdm::ArxDS::step()</a>.</p>
222
223</div>
224</div><p>
225<a class="anchor" name="6e497d501331057309d2fddf63259d1a"></a><!-- doxytag: member="bdm::mEF::samplecond_m" ref="6e497d501331057309d2fddf63259d1a" args="(const vec &amp;cond, int N)" -->
226<div class="memitem">
227<div class="memproto">
228      <table class="memname">
229        <tr>
230          <td class="memname">mat bdm::mpdf::samplecond_m           </td>
231          <td>(</td>
232          <td class="paramtype">const vec &amp;&nbsp;</td>
233          <td class="paramname"> <em>cond</em>, </td>
234        </tr>
235        <tr>
236          <td class="paramkey"></td>
237          <td></td>
238          <td class="paramtype">int&nbsp;</td>
239          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
240        </tr>
241        <tr>
242          <td></td>
243          <td>)</td>
244          <td></td><td></td><td><code> [virtual, inherited]</code></td>
245        </tr>
246      </table>
247</div>
248<div class="memdoc">
249
250<p>
251Returns.
252<p>
253<dl compact><dt><b>Parameters:</b></dt><dd>
254  <table border="0" cellspacing="2" cellpadding="0">
255    <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_11.png">. </td></tr>
256    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
257  </table>
258</dl>
259
260<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>.</p>
261
262</div>
263</div><p>
264<hr>The documentation for this class was generated from the following file:<ul>
265<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></ul>
266</div>
267<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:07:01 2009 for mixpp by&nbsp;
268<a href="http://www.doxygen.org/index.html">
269<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
270</body>
271</html>
Note: See TracBrowser for help on using the browser.