Changeset 287 for doc/html/classbdm_1_1KFcondR.html

Timestamp:

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

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1KFcondR.html (modified) (9 diffs)

doc/html/classbdm_1_1KFcondR.html

@@ -69 +69 @@
 </div>
 <div class="contents">
-<h1>bdm::KFcondR Class Reference</h1><!-- doxytag: class="bdm::KFcondR" --><!-- doxytag: inherits="Kalman&lt; ldmat &gt;,bdm::BMcond" --><code>#include &lt;<a class="el" href="libKF_8h-source.html">libKF.h</a>&gt;</code>
+<h1>bdm::KFcondR Class Reference</h1><!-- doxytag: class="bdm::KFcondR" --><!-- doxytag: inherits="Kalman&lt; ldmat &gt;" --><code>#include &lt;<a class="el" href="libKF_8h-source.html">libKF.h</a>&gt;</code>
 <p>
 <div class="dynheader">
@@ -78 +78 @@
 <map name="bdm::KFcondR_map">
 <area href="classbdm_1_1Kalman.html" alt="bdm::Kalman< ldmat >" shape="rect" coords="0,112,135,136">
-<area href="classbdm_1_1BMcond.html" alt="bdm::BMcond" shape="rect" coords="145,112,280,136">
 <area href="classbdm_1_1BM.html" alt="bdm::BM" shape="rect" coords="0,56,135,80">
-<area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="145,56,280,80">
 <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,135,24">
 </map>
@@ -89 +87 @@
 <a class="el" href="classbdm_1_1Kalman.html" title="Kalman filter with covariance matrices in square root form.">Kalman</a> Filter with conditional diagonal matrices R and Q. <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="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::KFcondR::_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="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::KFcondR::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 colspan="2"><br><h2>Logging of results</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224dd68a83c1472b43163763fa93c477"></a><!-- doxytag: member="bdm::KFcondR::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::KFcondR::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::KFcondR::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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::KFcondR::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::KFcondR::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 colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f11639d79f10b1e7dad16a0d8233450d"></a><!-- doxytag: member="bdm::KFcondR::KFcondR" ref="f11639d79f10b1e7dad16a0d8233450d" args="()" -->
@@ -94 +122 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6086f02541f8f3bc8351990abf5cd538"></a><!-- doxytag: member="bdm::KFcondR::condition" ref="6086f02541f8f3bc8351990abf5cd538" args="(const vec &amp;R)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1KFcondR.html#6086f02541f8f3bc8351990abf5cd538">condition</a> (const vec &amp;<a class="el" href="classbdm_1_1Kalman.html#475b088287cdfbba4dc60a3d027728b7">R</a>)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d42a421acbdcf9b610a5682ee5fb9a8"></a><!-- doxytag: member="bdm::KFcondR::condition" ref="7d42a421acbdcf9b610a5682ee5fb9a8" args="(const vec &amp;R0)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1KFcondR.html#7d42a421acbdcf9b610a5682ee5fb9a8">condition</a> (const vec &amp;R0)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr>
@@ -125 +153 @@
 
 <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="7506910f93250b44fea505ec4ffb19dc"></a><!-- doxytag: member="bdm::KFcondR::_rvc" ref="7506910f93250b44fea505ec4ffb19dc" 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_1BMcond.html#7506910f93250b44fea505ec4ffb19dc">_rvc</a> () const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
 <tr><td colspan="2"><div class="groupHeader">Constructors</div></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>
@@ -252 +276 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If true, the filter will compute likelihood of the data record and store it in <code>ll</code> . Set to false if you want to save computational time. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1164a90f782a2a323b1ee17242100b39"></a><!-- doxytag: member="bdm::KFcondR::dimc" ref="1164a90f782a2a323b1ee17242100b39" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#1164a90f782a2a323b1ee17242100b39">dimc</a></td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the conditioning variable <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a12750776d977408aada06a70093297"></a><!-- doxytag: member="bdm::KFcondR::rvc" ref="9a12750776d977408aada06a70093297" args="" -->
-<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#9a12750776d977408aada06a70093297">rvc</a></td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identificator of the conditioning variable. <br></td></tr>
 </table>
 <hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="c0f027ff91d8459937c6f60ff8e553ff"></a><!-- doxytag: member="bdm::KFcondR::_copy_" ref="c0f027ff91d8459937c6f60ff8e553ff" args="()" -->
+<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="bdm::KFcondR::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " -->
 <div class="memitem">
 <div class="memproto">
@@ -271 +287 @@
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td><code> [inline, virtual, inherited]</code></td>
+          <td> const<code> [inline, virtual, inherited]</code></td>
         </tr>
       </table>
@@ -278 +294 @@
 
 <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>
@@ -304 +320 @@
 <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">bdm::BM::logpred_m()</a>.</p>
+<p>Referenced by <a class="el" href="libBM_8h-source.html#l00650">bdm::BM::logpred_m()</a>.</p>
 
 </div>
 </div><p>
-<hr>The documentation for this class was generated from the following files:<ul>
-<li><a class="el" href="libKF_8h-source.html">libKF.h</a><li>libKF.cpp</ul>
-</div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:39:04 2009 for mixpp by&nbsp;
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="libKF_8h-source.html">libKF.h</a></ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:20 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>