Show
Ignore:
Timestamp:
03/05/09 14:03:56 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1EKFful__unQR.html

    r280 r287  
    6969</div> 
    7070<div class="contents"> 
    71 <h1>bdm::EKFful_unQR Class Reference</h1><!-- doxytag: class="bdm::EKFful_unQR" --><!-- doxytag: inherits="bdm::EKFfull,bdm::BMcond" --><code>#include &lt;<a class="el" href="ekf__templ_8h-source.html">ekf_templ.h</a>&gt;</code> 
     71<h1>bdm::EKFful_unQR Class Reference</h1><!-- doxytag: class="bdm::EKFful_unQR" --><!-- doxytag: inherits="bdm::EKFfull" --><code>#include &lt;<a class="el" href="ekf__templ_8h-source.html">ekf_templ.h</a>&gt;</code> 
    7272<p> 
    7373<div class="dynheader"> 
     
    7878<map name="bdm::EKFful_unQR_map"> 
    7979<area href="classbdm_1_1EKFfull.html" alt="bdm::EKFfull" shape="rect" coords="64,112,182,136"> 
    80 <area href="classbdm_1_1BMcond.html" alt="bdm::BMcond" shape="rect" coords="256,112,374,136"> 
    8180<area href="classbdm_1_1KalmanFull.html" alt="bdm::KalmanFull" shape="rect" coords="0,56,118,80"> 
    8281<area href="classbdm_1_1BM.html" alt="bdm::BM" shape="rect" coords="128,56,246,80"> 
    83 <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="256,56,374,80"> 
    8482<area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="128,0,246,24"> 
    8583</map> 
     
    9088Extended <a class="el" href="classbdm_1_1Kalman.html" title="Kalman filter with covariance matrices in square root form.">Kalman</a> filter with unknown <code>Q</code> and <code>R</code>. <table border="0" cellpadding="0" cellspacing="0"> 
    9189<tr><td></td></tr> 
     90<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr> 
     91<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> 
     92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::EKFful_unQR::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " --> 
     93const <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> 
     94 
     95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::EKFful_unQR::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" --> 
     97<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> 
     98 
     99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr> 
     100<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr> 
     101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224dd68a83c1472b43163763fa93c477"></a><!-- doxytag: member="bdm::EKFful_unQR::set_options" ref="224dd68a83c1472b43163763fa93c477" args="(const string &amp;opt)" --> 
     102void&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> 
     103 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string. <br></td></tr> 
     105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa5d1f7e638db229403e3917bf155ee3"></a><!-- doxytag: member="bdm::EKFful_unQR::log_add" ref="aa5d1f7e638db229403e3917bf155ee3" args="(logger *L, const string &amp;name=&quot;&quot;)" --> 
     106void&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> 
     107 
     108<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> 
     109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0647606eefbf294623bf664971c7d461"></a><!-- doxytag: member="bdm::EKFful_unQR::logit" ref="0647606eefbf294623bf664971c7d461" args="(logger *L)" --> 
     110void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> *L)</td></tr> 
     111 
     112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::EKFful_unQR::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" --> 
     113ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr> 
     114 
     115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers. <br></td></tr> 
     116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5e0000d2c9df99b029eceff222f7d77"></a><!-- doxytag: member="bdm::EKFful_unQR::opt_L_bounds" ref="a5e0000d2c9df99b029eceff222f7d77" args="" --> 
     117bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5e0000d2c9df99b029eceff222f7d77">opt_L_bounds</a></td></tr> 
     118 
     119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Option for logging bounds. <br></td></tr> 
    92120<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    93 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="538923d568db236bf5cd7120ae35b22d"></a><!-- doxytag: member="bdm::EKFful_unQR::EKFful_unQR" ref="538923d568db236bf5cd7120ae35b22d" args="()" --> 
    94 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EKFful__unQR.html#538923d568db236bf5cd7120ae35b22d">EKFful_unQR</a> ()</td></tr> 
    95  
    96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr> 
    97121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17a98c06f5efe38e0da0beb96d6f9584"></a><!-- doxytag: member="bdm::EKFful_unQR::condition" ref="17a98c06f5efe38e0da0beb96d6f9584" args="(const vec &amp;QR0)" --> 
    98122void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1EKFful__unQR.html#17a98c06f5efe38e0da0beb96d6f9584">condition</a> (const vec &amp;QR0)</td></tr> 
     
    121145const mat&nbsp;</td><td class="memItemRight" valign="bottom"><b>_R</b> ()</td></tr> 
    122146 
    123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7506910f93250b44fea505ec4ffb19dc"></a><!-- doxytag: member="bdm::EKFful_unQR::_rvc" ref="7506910f93250b44fea505ec4ffb19dc" args="() const " --> 
    124 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> 
    125  
    126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    127147<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    128 <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> 
     148<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> 
    129149 
    130150<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr> 
     
    230250 
    231251<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Random variable of the data (optional). <br></td></tr> 
    232 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1164a90f782a2a323b1ee17242100b39"></a><!-- doxytag: member="bdm::EKFful_unQR::dimc" ref="1164a90f782a2a323b1ee17242100b39" args="" --> 
    233 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMcond.html#1164a90f782a2a323b1ee17242100b39">dimc</a></td></tr> 
    234  
    235 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the conditioning variable <br></td></tr> 
    236 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a12750776d977408aada06a70093297"></a><!-- doxytag: member="bdm::EKFful_unQR::rvc" ref="9a12750776d977408aada06a70093297" args="" --> 
    237 <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> 
    238  
    239 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identificator of the conditioning variable. <br></td></tr> 
    240252<tr><td colspan="2"><br><h2>Friends</h2></td></tr> 
    241253<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86ba216243ed95bb46d80d88775d16af"></a><!-- doxytag: member="bdm::EKFful_unQR::operator&lt;&lt;" ref="86ba216243ed95bb46d80d88775d16af" args="(std::ostream &amp;os, const KalmanFull &amp;kf)" --> 
     
    245257</table> 
    246258<hr><h2>Member Function Documentation</h2> 
    247 <a class="anchor" name="c0f027ff91d8459937c6f60ff8e553ff"></a><!-- doxytag: member="bdm::EKFful_unQR::_copy_" ref="c0f027ff91d8459937c6f60ff8e553ff" args="()" --> 
     259<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="bdm::EKFful_unQR::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " --> 
    248260<div class="memitem"> 
    249261<div class="memproto"> 
     
    254266          <td class="paramname">          </td> 
    255267          <td>&nbsp;)&nbsp;</td> 
    256           <td><code> [inline, virtual, inherited]</code></td> 
     268          <td> const<code> [inline, virtual, inherited]</code></td> 
    257269        </tr> 
    258270      </table> 
     
    261273 
    262274<p> 
    263 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>);}  
     275Copy 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>);}  
    264276</pre></div>  
    265 <p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#60c40b5c6abc4c7e464b4ccae64a5a61">bdm::ARX</a>.</p> 
     277<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> 
    266278 
    267279</div> 
     
    287299<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> 
    288300 
    289 <p>Referenced by <a class="el" href="libBM_8h-source.html#l00628">bdm::BM::logpred_m()</a>.</p> 
     301<p>Referenced by <a class="el" href="libBM_8h-source.html#l00650">bdm::BM::logpred_m()</a>.</p> 
    290302 
    291303</div> 
     
    294306<li><a class="el" href="ekf__templ_8h-source.html">ekf_templ.h</a></ul> 
    295307</div> 
    296 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:38:59 2009 for mixpp by&nbsp; 
     308<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:19 2009 for mixpp by&nbsp; 
    297309<a href="http://www.doxygen.org/index.html"> 
    298310<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>