Show
Ignore:
Timestamp:
09/24/08 13:08:07 (16 years ago)
Author:
smidl
Message:

New documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classKalman.html

    r162 r171  
    6868 
    6969<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Here dt = [yt;ut] of appropriate dimensions. <br></td></tr> 
    70 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a213c57aef55b2645e550bed81cfc0d4"></a><!-- doxytag: member="Kalman::_epdf" ref="a213c57aef55b2645e550bed81cfc0d4" args="()" --> 
    71 <a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKalman.html#a213c57aef55b2645e550bed81cfc0d4">_epdf</a> ()</td></tr> 
     70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67cccaf1c4dcdcd1df110e15ef326bfe"></a><!-- doxytag: member="Kalman::_epdf" ref="67cccaf1c4dcdcd1df110e15ef326bfe" args="() const " --> 
     71const <a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKalman.html#67cccaf1c4dcdcd1df110e15ef326bfe">_epdf</a> () const </td></tr> 
    7272 
    7373<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     
    8080 
    8181<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87b07867fd4c133aa89a18543f68d9f9"></a><!-- doxytag: member="Kalman::bayes" ref="87b07867fd4c133aa89a18543f68d9f9" args="(mat Dt)" --> 
    83 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#87b07867fd4c133aa89a18543f68d9f9">bayes</a> (mat Dt)</td></tr> 
     82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0186270f75189677f390fe088a9947e9"></a><!-- doxytag: member="Kalman::bayesB" ref="0186270f75189677f390fe088a9947e9" args="(const mat &amp;Dt)" --> 
     83virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#0186270f75189677f390fe088a9947e9">bayesB</a> (const mat &amp;Dt)</td></tr> 
    8484 
    8585<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Batch Bayes rule (columns of Dt are observations). <br></td></tr> 
     86<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#8a8ce6df431689964c41cc6c849cfd06">logpred</a> (const vec &amp;dt) const </td></tr> 
     87 
    8688<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="126bd2595c48e311fc2a7ab72876092a"></a><!-- doxytag: member="Kalman::_rv" ref="126bd2595c48e311fc2a7ab72876092a" args="() const " --> 
    8789const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#126bd2595c48e311fc2a7ab72876092a">_rv</a> () const </td></tr> 
     
    9294 
    9395<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="1ffa9f23669aabecc3760c06c6987522"></a><!-- doxytag: member="Kalman::set_evalll" ref="1ffa9f23669aabecc3760c06c6987522" args="(bool evl0)" --> 
     97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#1ffa9f23669aabecc3760c06c6987522">set_evalll</a> (bool evl0)</td></tr> 
     98 
     99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     100<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classBM.html">BM</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#eb58c81d6a7b75b05fc6f276eed78887">_copy_</a> (bool changerv=false)</td></tr> 
     101 
    94102<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    95103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7501230c2fafa3655887d2da23b3184c"></a><!-- doxytag: member="Kalman::rvy" ref="7501230c2fafa3655887d2da23b3184c" args="" --> 
     
    176184bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBM.html#bf6fb59b30141074f8ee1e2f43d03129">evalll</a></td></tr> 
    177185 
    178 <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 time. <br></td></tr> 
     186<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> 
    179187</table> 
    180188<hr><a name="_details"></a><h2>Detailed Description</h2> 
     
    190198<img class="formulaDsp" alt="\[ y_t = C x_{t-1} + C u_t + Q^{1/2} w_t. \]" src="form_7.png"> 
    191199<p> 
    192  Where $e_t$ and $w_t$ are independent vectors Normal(0,1)-distributed disturbances. <hr>The documentation for this class was generated from the following file:<ul> 
     200 Where $e_t$ and $w_t$ are independent vectors Normal(0,1)-distributed disturbances. <hr><h2>Member Function Documentation</h2> 
     201<a class="anchor" name="8a8ce6df431689964c41cc6c849cfd06"></a><!-- doxytag: member="Kalman::logpred" ref="8a8ce6df431689964c41cc6c849cfd06" args="(const vec &amp;dt) const " --> 
     202<div class="memitem"> 
     203<div class="memproto"> 
     204      <table class="memname"> 
     205        <tr> 
     206          <td class="memname">virtual double BM::logpred           </td> 
     207          <td>(</td> 
     208          <td class="paramtype">const vec &amp;&nbsp;</td> 
     209          <td class="paramname"> <em>dt</em>          </td> 
     210          <td>&nbsp;)&nbsp;</td> 
     211          <td> const<code> [inline, virtual, inherited]</code></td> 
     212        </tr> 
     213      </table> 
     214</div> 
     215<div class="memdoc"> 
     216 
     217<p> 
     218Evaluates predictive log-likelihood of the given data record I.e. marginal likelihood of the data with the posterior integrated out.  
     219<p>Reimplemented in <a class="el" href="classARX.html#e7f9e7823aec9bf7ddc3b42d9b3304c4">ARX</a>, <a class="el" href="classMixEF.html#424ca64f36d4e41de7a7e7ae921d35ea">MixEF</a>, and <a class="el" href="classmultiBM.html#13e26a61757278981fd8cac9a7ef91eb">multiBM</a>.</p> 
     220 
     221</div> 
     222</div><p> 
     223<a class="anchor" name="eb58c81d6a7b75b05fc6f276eed78887"></a><!-- doxytag: member="Kalman::_copy_" ref="eb58c81d6a7b75b05fc6f276eed78887" args="(bool changerv=false)" --> 
     224<div class="memitem"> 
     225<div class="memproto"> 
     226      <table class="memname"> 
     227        <tr> 
     228          <td class="memname">virtual <a class="el" href="classBM.html">BM</a>* BM::_copy_           </td> 
     229          <td>(</td> 
     230          <td class="paramtype">bool&nbsp;</td> 
     231          <td class="paramname"> <em>changerv</em> = <code>false</code>          </td> 
     232          <td>&nbsp;)&nbsp;</td> 
     233          <td><code> [inline, virtual, inherited]</code></td> 
     234        </tr> 
     235      </table> 
     236</div> 
     237<div class="memdoc"> 
     238 
     239<p> 
     240Copy function required in vectors, Arrays of <a class="el" href="classBM.html" title="Bayesian Model of the world, i.e. all uncertainty is modeled by probabilities.">BM</a> etc. Have to be DELETED manually! Prototype: BM* <a class="el" href="classBM.html#eb58c81d6a7b75b05fc6f276eed78887">_copy_()</a>{<a class="el" href="classBM.html" title="Bayesian Model of the world, i.e. all uncertainty is modeled by probabilities.">BM</a> Tmp*=new Tmp(this*); return Tmp; }  
     241<p>Reimplemented in <a class="el" href="classARX.html#d2751057811c6fb8f4ff86e1648bcddc">ARX</a>.</p> 
     242 
     243<p>Referenced by <a class="el" href="mixef_8cpp-source.html#l00007">MixEF::MixEF()</a>.</p> 
     244 
     245</div> 
     246</div><p> 
     247<hr>The documentation for this class was generated from the following file:<ul> 
    193248<li>work/git/mixpp/bdm/estim/<a class="el" href="libKF_8h-source.html">libKF.h</a></ul> 
    194249</div> 
    195 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 4 19:28:10 2008 for mixpp by&nbsp; 
     250<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:52 2008 for mixpp by&nbsp; 
    196251<a href="http://www.doxygen.org/index.html"> 
    197252<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>