Changeset 287 for doc/html/classbdm_1_1BM.html

Timestamp:

03/05/09 14:03:56 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1BM.html (modified) (8 diffs)

doc/html/classbdm_1_1BM.html

@@ -93 +93 @@
 Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities. 
 <p>
-<table border="0" cellpadding="0" cellspacing="0">
+This object represents exact or approximate evaluation of the Bayes rule: <p class="formulaDsp">
+<img class="formulaDsp" alt="\[ f(\theta_t | d_1,\ldots,d_t) = \frac{f(y_t|\theta_t,\cdot) f(\theta_t|d_1,\ldots,d_{t-1})}{f(y_t|d_1,\ldots,d_{t-1})} \]" src="form_118.png">
+<p>
+<p>
+Access to the resulting posterior density is via function <code>posterior()</code>.<p>
+As a "side-effect" it also evaluates log-likelihood of the data, which can be accessed via function _ll(). It can also evaluate predictors of future values of <img class="formulaInl" alt="$y_t$" src="form_100.png">, see functions <a class="el" href="classbdm_1_1BM.html#688d7a2aced1e06aa1c468d73a9e5eba" title="Constructs a predictive density .">epredictor()</a> and <a class="el" href="classbdm_1_1BM.html#598b25e3f3d96a5bc00a5faeb5b3c912" title="Constructs a conditional density 1-step ahead predictor.">predictor()</a>.<p>
+Alternatively, it can evaluate posterior density conditioned by a known constant, <img class="formulaInl" alt="$ c_t $" src="form_119.png">: <p class="formulaDsp">
+<img class="formulaDsp" alt="\[ f(\theta_t | c_t, d_1,\ldots,d_t) \propto f(y_t,\theta_t|c_t,\cdot, d_1,\ldots,d_{t-1}) \]" src="form_120.png">
+<p>
+<p>
+The value of <img class="formulaInl" alt="$ c_t $" src="form_119.png"> is set by function <a class="el" href="classbdm_1_1BM.html#6799f4b16a6a59ed58b1d0d6e17116f4" title="Substitute val for rvc.">condition()</a>. <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr>
+<tr><td colspan="2">This extension is useful e.g. in Marginalized Particle Filter (<a class="el" href="classbdm_1_1MPF.html">bdm::MPF</a>). Alternatively, it can be used for automated connection to <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> when the condition is observed <br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::BM::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" -->
+<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#de95c590d650b2db423d53992f0906cb">rvc</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::BM::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " -->
+const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#b5e8e016be16e4029c789063cb3f3b33">_rvc</a> () const </td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6799f4b16a6a59ed58b1d0d6e17116f4"></a><!-- doxytag: member="bdm::BM::condition" ref="6799f4b16a6a59ed58b1d0d6e17116f4" args="(const vec &amp;val)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#6799f4b16a6a59ed58b1d0d6e17116f4">condition</a> (const vec &amp;val)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr>
+<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::BM::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" -->
+ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5e0000d2c9df99b029eceff222f7d77"></a><!-- doxytag: member="bdm::BM::opt_L_bounds" ref="a5e0000d2c9df99b029eceff222f7d77" args="" -->
+bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5e0000d2c9df99b029eceff222f7d77">opt_L_bounds</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Option for logging bounds. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224dd68a83c1472b43163763fa93c477"></a><!-- doxytag: member="bdm::BM::set_options" ref="224dd68a83c1472b43163763fa93c477" args="(const string &amp;opt)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#224dd68a83c1472b43163763fa93c477">set_options</a> (const string &amp;opt)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa5d1f7e638db229403e3917bf155ee3"></a><!-- doxytag: member="bdm::BM::log_add" ref="aa5d1f7e638db229403e3917bf155ee3" args="(logger *L, const string &amp;name=&quot;&quot;)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#aa5d1f7e638db229403e3917bf155ee3">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> *L, const string &amp;name=&quot;&quot;)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add all logged variables to a <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a>. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0647606eefbf294623bf664971c7d461"></a><!-- doxytag: member="bdm::BM::logit" ref="0647606eefbf294623bf664971c7d461" args="(logger *L)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> *L)</td></tr>
+
 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 <tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
@@ -103 +147 @@
 &nbsp;</td><td class="memItemRight" valign="bottom"><b>BM</b> (const <a class="el" href="classbdm_1_1BM.html">BM</a> &amp;B)</td></tr>
 
-<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classbdm_1_1BM.html">BM</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#c0f027ff91d8459937c6f60ff8e553ff">_copy_</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classbdm_1_1BM.html">BM</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a> () const </td></tr>
 
 <tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
@@ -164 +208 @@
 </table>
 <hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="c0f027ff91d8459937c6f60ff8e553ff"></a><!-- doxytag: member="bdm::BM::_copy_" ref="c0f027ff91d8459937c6f60ff8e553ff" args="()" -->
+<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="bdm::BM::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " -->
 <div class="memitem">
 <div class="memproto">
@@ -173 +217 @@
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td><code> [inline, virtual]</code></td>
+          <td> const<code> [inline, virtual]</code></td>
         </tr>
       </table>
@@ -180 +224 @@
 
 <p>
-Copy function required in vectors, Arrays of <a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: <div class="fragment"><pre class="fragment"> BM* <a class="code" href="classbdm_1_1BM.html#c0f027ff91d8459937c6f60ff8e553ff">_copy_</a>(){<span class="keywordflow">return</span> <span class="keyword">new</span> BM(*<span class="keyword">this</span>);} 
+Copy function required in vectors, Arrays of <a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: <div class="fragment"><pre class="fragment"> BM* <a class="code" href="classbdm_1_1BM.html#40f01563651c1e4fe926189e41a6b8ab">_copy_</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">new</span> BM(*<span class="keyword">this</span>);} 
 </pre></div> 
-<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#60c40b5c6abc4c7e464b4ccae64a5a61">bdm::ARX</a>.</p>
+<p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#ca0b54c0997cfd567f49377af5def106">bdm::ARX</a>, <a class="el" href="classbdm_1_1KalmanCh.html#24ce65bdaa538d4d5153d709a929b996">bdm::KalmanCh</a>, <a class="el" href="classbdm_1_1EKF.html#fe9b2e227255ad32dc73df316b7318f4">bdm::EKF&lt; sq_T &gt;</a>, and <a class="el" href="classbdm_1_1EKFCh.html#1d1d91400e3f177de9fe7962ea17adc4">bdm::EKFCh</a>.</p>
 
 </div>
@@ -213 +257 @@
 <p>Implemented in <a class="el" href="classbdm_1_1ARX.html#8bdf2974052e8ce74eb0d4f3791c58a3">bdm::ARX</a>, <a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bdm::Kalman&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1KalmanCh.html#b41fe5540548100b08e1684c3be767b6">bdm::KalmanCh</a>, <a class="el" href="classbdm_1_1EKFfull.html#f149ae8e9ce14d9931a7bb2850736699">bdm::EKFfull</a>, <a class="el" href="classbdm_1_1EKF.html#3fb182ecc29b10ca1163cecbf3bcccfa">bdm::EKF&lt; sq_T &gt;</a>, <a class="el" href="classbdm_1_1EKFCh.html#4c8609c37290b158f88a31dae4047225">bdm::EKFCh</a>, <a class="el" href="classbdm_1_1PF.html#638946eea22d4964bf9350286bb4efd8">bdm::PF</a>, <a class="el" href="classbdm_1_1MPF.html#286d040770d08bd7ff416cea617b1b14">bdm::MPF&lt; BM_T &gt;</a>, <a class="el" href="classbdm_1_1MixEF.html#5bd7da667da183eed1577f11dff0c1f1">bdm::MixEF</a>, <a class="el" href="classbdm_1_1BMEF.html#c287f4c0c1ea31b91572ec45351838f1">bdm::BMEF</a>, <a class="el" href="classbdm_1_1multiBM.html#1e4bf41b61937fd80f34049742e23f95">bdm::multiBM</a>, <a class="el" href="classEKFfixed.html#ddf5334bc1207658fd53698fffbac028">EKFfixed</a>, <a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bdm::Kalman&lt; ldmat &gt;</a>, <a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bdm::Kalman&lt; chmat &gt;</a>, and <a class="el" href="classbdm_1_1Kalman.html#4a39330c14eff8d13179e868a1d1aa8c">bdm::Kalman&lt; fsqmat &gt;</a>.</p>
 
-<p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00229">bayesB()</a>.</p>
+<p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00239">bayesB()</a>.</p>
 
 </div>
@@ -237 +281 @@
 <p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#080a7e531e3aa06694112863b15bc6a4">bdm::ARX</a>, <a class="el" href="classbdm_1_1MixEF.html#da724da464a75e07521941e430929efa">bdm::MixEF</a>, and <a class="el" href="classbdm_1_1multiBM.html#e157b607c1e3fa91d42aeea44458e2bf">bdm::multiBM</a>.</p>
 
-<p>Referenced by <a class="el" href="libBM_8h-source.html#l00628">logpred_m()</a>.</p>
+<p>Referenced by <a class="el" href="libBM_8h-source.html#l00650">logpred_m()</a>.</p>
 
 </div>
@@ -244 +288 @@
 <li><a class="el" href="libBM_8h-source.html">libBM.h</a><li>libBM.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:39:15 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:22 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>