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

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/html/classbdm_1_1PF.html

    r280 r287  
    8989Posterior density is represented by a weighted empirical density (<code><a class="el" href="classbdm_1_1eEmp.html" title="Weighted empirical density.">eEmp</a></code> ). <table border="0" cellpadding="0" cellspacing="0"> 
    9090<tr><td></td></tr> 
     91<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr> 
     92<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> 
     93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::PF::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " --> 
     94const <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> 
     95 
     96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6799f4b16a6a59ed58b1d0d6e17116f4"></a><!-- doxytag: member="bdm::PF::condition" ref="6799f4b16a6a59ed58b1d0d6e17116f4" args="(const vec &amp;val)" --> 
     98virtual 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> 
     99 
     100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr> 
     101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::PF::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" --> 
     102<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> 
     103 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr> 
     105<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr> 
     106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa5d1f7e638db229403e3917bf155ee3"></a><!-- doxytag: member="bdm::PF::log_add" ref="aa5d1f7e638db229403e3917bf155ee3" args="(logger *L, const string &amp;name=&quot;&quot;)" --> 
     107void&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> 
     108 
     109<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> 
     110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0647606eefbf294623bf664971c7d461"></a><!-- doxytag: member="bdm::PF::logit" ref="0647606eefbf294623bf664971c7d461" args="(logger *L)" --> 
     111void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> *L)</td></tr> 
     112 
     113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::PF::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" --> 
     114ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr> 
     115 
     116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers. <br></td></tr> 
     117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5e0000d2c9df99b029eceff222f7d77"></a><!-- doxytag: member="bdm::PF::opt_L_bounds" ref="a5e0000d2c9df99b029eceff222f7d77" args="" --> 
     118bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5e0000d2c9df99b029eceff222f7d77">opt_L_bounds</a></td></tr> 
     119 
     120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Option for logging bounds. <br></td></tr> 
    91121<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    92 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#6f1988db4c3f602d187a6c15ec89cb1e">set_est</a> (const <a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;epdf0)</td></tr> 
     122<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#bf104b869b5df8dd4a14bbe430d40488">set_options</a> (const string &amp;opt)</td></tr> 
    93123 
    94124<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#638946eea22d4964bf9350286bb4efd8">bayes</a> (const vec &amp;dt)</td></tr> 
    … …  
    103133&nbsp;</td><td class="memItemRight" valign="bottom"><b>PF</b> ()</td></tr> 
    104134 
    105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b9fdf0d1e712392bfcad5a26c727d44"></a><!-- doxytag: member="bdm::PF::PF" ref="3b9fdf0d1e712392bfcad5a26c727d44" args="(mpdf *par0, mpdf *obs0, epdf *epdf0, int n0)" --> 
    106 &nbsp;</td><td class="memItemRight" valign="bottom"><b>PF</b> (<a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *par0, <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *obs0, <a class="el" href="classbdm_1_1epdf.html">epdf</a> *epdf0, int n0)</td></tr> 
    107  
    108 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6d63c627cd1600eb0a88294d0ff6ca3"></a><!-- doxytag: member="bdm::PF::set_parameters" ref="e6d63c627cd1600eb0a88294d0ff6ca3" args="(mpdf *par0, mpdf *obs0, int n0)" --> 
    109 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (<a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *par0, <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *obs0, int n0)</td></tr> 
     135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80b9b6b0506797c41b50b9bd236bc856"></a><!-- doxytag: member="bdm::PF::set_parameters" ref="80b9b6b0506797c41b50b9bd236bc856" args="(mpdf *par0, mpdf *obs0, int n0, RESAMPLING_METHOD rm=SYSTEMATIC)" --> 
     136void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (<a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *par0, <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *obs0, int n0, RESAMPLING_METHOD rm=SYSTEMATIC)</td></tr> 
    110137 
    111138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9830cb311f67e8276d3f2b167ab681b9"></a><!-- doxytag: member="bdm::PF::set_statistics" ref="9830cb311f67e8276d3f2b167ab681b9" args="(const vec w0, epdf *epdf0)" --> 
    … …  
    113140 
    114141<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    115 <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> 
     142<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> 
    116143 
    117144<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr> 
    … …  
    181208 
    182209<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observation model. <br></td></tr> 
     210<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9932c7c5865954ef9a438afcbe944e52"></a><!-- doxytag: member="bdm::PF::resmethod" ref="9932c7c5865954ef9a438afcbe944e52" args="" --> 
     211RESAMPLING_METHOD&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#9932c7c5865954ef9a438afcbe944e52">resmethod</a></td></tr> 
     212 
     213<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">which resampling method will be used <br></td></tr> 
    183214<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c400357e37d27a4834b2b1d9211009ed"></a><!-- doxytag: member="bdm::PF::drv" ref="c400357e37d27a4834b2b1d9211009ed" args="" --> 
    184215<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#c400357e37d27a4834b2b1d9211009ed">drv</a></td></tr> 
    … …  
    193224 
    194225<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> 
     226<tr><td colspan="2"><div class="groupHeader">Options</div></td></tr> 
     227<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98ef9ff80c394fafd28680b7a3f831b1"></a><!-- doxytag: member="bdm::PF::opt_L_smp" ref="98ef9ff80c394fafd28680b7a3f831b1" args="" --> 
     228bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#98ef9ff80c394fafd28680b7a3f831b1">opt_L_smp</a></td></tr> 
     229 
     230<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Log all samples. <br></td></tr> 
     231<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a49463a88ee80771a464861df845ff6"></a><!-- doxytag: member="bdm::PF::opt_L_wei" ref="5a49463a88ee80771a464861df845ff6" args="" --> 
     232bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1PF.html#5a49463a88ee80771a464861df845ff6">opt_L_wei</a></td></tr> 
     233 
     234<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Log all samples. <br></td></tr> 
    195235</table> 
    196236<hr><h2>Member Function Documentation</h2> 
    197 <a class="anchor" name="6f1988db4c3f602d187a6c15ec89cb1e"></a><!-- doxytag: member="bdm::PF::set_est" ref="6f1988db4c3f602d187a6c15ec89cb1e" args="(const epdf &amp;epdf0)" --> 
     237<a class="anchor" name="bf104b869b5df8dd4a14bbe430d40488"></a><!-- doxytag: member="bdm::PF::set_options" ref="bf104b869b5df8dd4a14bbe430d40488" args="(const string &amp;opt)" --> 
    198238<div class="memitem"> 
    199239<div class="memproto"> 
    200240      <table class="memname"> 
    201241        <tr> 
    202           <td class="memname">void bdm::PF::set_est           </td> 
     242          <td class="memname">void bdm::PF::set_options           </td> 
    203243          <td>(</td> 
    204           <td class="paramtype">const <a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td> 
    205           <td class="paramname"> <em>epdf0</em>          </td> 
     244          <td class="paramtype">const string &amp;&nbsp;</td> 
     245          <td class="paramname"> <em>opt</em>          </td> 
    206246          <td>&nbsp;)&nbsp;</td> 
    207           <td></td> 
     247          <td><code> [inline]</code></td> 
    208248        </tr> 
    209249      </table> 
    … …  
    213253<p> 
    214254Set posterior density by sampling from epdf0  
    215 <p>Reimplemented in <a class="el" href="classbdm_1_1MPF.html#dcecdaf2acbbee51acf3018a70989a7e">bdm::MPF&lt; BM_T &gt;</a>.</p> 
    216  
    217 <p>References <a class="el" href="libPF_8h-source.html#l00036">_samples</a>, <a class="el" href="libPF_8h-source.html#l00030">n</a>, and <a class="el" href="libBM_8h-source.html#l00242">bdm::epdf::sample()</a>.</p> 
    218  
    219 <p>Referenced by <a class="el" href="libPF_8h-source.html#l00137">bdm::MPF&lt; BM_T &gt;::set_est()</a>.</p> 
     255<p>Reimplemented from <a class="el" href="classbdm_1_1BM.html#224dd68a83c1472b43163763fa93c477">bdm::BM</a>.</p> 
     256 
     257<p>Reimplemented in <a class="el" href="classbdm_1_1MPF.html#2e95498dec734088ab9f4878ff404144">bdm::MPF&lt; BM_T &gt;</a>.</p> 
     258 
     259<p>References <a class="el" href="libPF_8h-source.html#l00049">opt_L_smp</a>, <a class="el" href="libPF_8h-source.html#l00051">opt_L_wei</a>, and <a class="el" href="libBM_8h-source.html#l00690">bdm::BM::set_options()</a>.</p> 
     260 
     261<p>Referenced by <a class="el" href="libPF_8h-source.html#l00197">bdm::MPF&lt; BM_T &gt;::set_options()</a>.</p> 
    220262 
    221263</div> 
    … …  
    250292<p>Reimplemented in <a class="el" href="classbdm_1_1MPF.html#286d040770d08bd7ff416cea617b1b14">bdm::MPF&lt; BM_T &gt;</a>.</p> 
    251293 
    252 <p>References <a class="el" href="libBM_8h-source.html#l00342">bdm::mpdf::_e()</a>, <a class="el" href="libPF_8h-source.html#l00036">_samples</a>, <a class="el" href="libPF_8h-source.html#l00034">_w</a>, <a class="el" href="libPF_8h-source.html#l00032">est</a>, <a class="el" href="libBM_8h-source.html#l00246">bdm::epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00327">bdm::mpdf::evallogcond()</a>, <a class="el" href="libPF_8h-source.html#l00030">n</a>, <a class="el" href="libPF_8h-source.html#l00040">obs</a>, <a class="el" href="libPF_8h-source.html#l00038">par</a>, <a class="el" href="libEF_8cpp-source.html#l00185">bdm::eEmp::resample()</a>, and <a class="el" href="libBM_8h-source.html#l00311">bdm::mpdf::samplecond()</a>.</p> 
     294<p>References <a class="el" href="libBM_8h-source.html#l00347">bdm::mpdf::_e()</a>, <a class="el" href="libPF_8h-source.html#l00036">_samples</a>, <a class="el" href="libPF_8h-source.html#l00034">_w</a>, <a class="el" href="libPF_8h-source.html#l00032">est</a>, <a class="el" href="libBM_8h-source.html#l00246">bdm::epdf::evallog()</a>, <a class="el" href="libBM_8h-source.html#l00332">bdm::mpdf::evallogcond()</a>, <a class="el" href="libPF_8h-source.html#l00030">n</a>, <a class="el" href="libPF_8h-source.html#l00040">obs</a>, <a class="el" href="libPF_8h-source.html#l00038">par</a>, <a class="el" href="libEF_8cpp-source.html#l00185">bdm::eEmp::resample()</a>, <a class="el" href="libPF_8h-source.html#l00043">resmethod</a>, and <a class="el" href="libBM_8h-source.html#l00316">bdm::mpdf::samplecond()</a>.</p> 
    253295 
    254296</div> 
    255297</div><p> 
    256 <a class="anchor" name="c0f027ff91d8459937c6f60ff8e553ff"></a><!-- doxytag: member="bdm::PF::_copy_" ref="c0f027ff91d8459937c6f60ff8e553ff" args="()" --> 
     298<a class="anchor" name="40f01563651c1e4fe926189e41a6b8ab"></a><!-- doxytag: member="bdm::PF::_copy_" ref="40f01563651c1e4fe926189e41a6b8ab" args="() const " --> 
    257299<div class="memitem"> 
    258300<div class="memproto"> 
    … …  
    263305          <td class="paramname">          </td> 
    264306          <td>&nbsp;)&nbsp;</td> 
    265           <td><code> [inline, virtual, inherited]</code></td> 
     307          <td> const<code> [inline, virtual, inherited]</code></td> 
    266308        </tr> 
    267309      </table> 
    … …  
    270312 
    271313<p> 
    272 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>);}  
     314Copy 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>);}  
    273315</pre></div>  
    274 <p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#60c40b5c6abc4c7e464b4ccae64a5a61">bdm::ARX</a>.</p> 
     316<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> 
    275317 
    276318</div> 
    … …  
    296338<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> 
    297339 
    298 <p>Referenced by <a class="el" href="libBM_8h-source.html#l00628">bdm::BM::logpred_m()</a>.</p> 
     340<p>Referenced by <a class="el" href="libBM_8h-source.html#l00650">bdm::BM::logpred_m()</a>.</p> 
    299341 
    300342</div> 
    … …  
    303345<li><a class="el" href="libPF_8h-source.html">libPF.h</a><li>libPF.cpp</ul> 
    304346</div> 
    305 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 18 17:39:05 2009 for mixpp by&nbsp; 
     347<hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:20 2009 for mixpp by&nbsp; 
    306348<a href="http://www.doxygen.org/index.html"> 
    307349<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>