Changeset 661 for library/doc/html/classbdm_1_1mexBM.html

Timestamp:

10/15/09 00:10:19 (15 years ago)

Author:

smidl

Message:

doc

Files:

• library/doc/html/classbdm_1_1mexBM.html (modified) (8 diffs)

library/doc/html/classbdm_1_1mexBM.html

@@ -72 +72 @@
 <div class="contents">
 <h1>bdm::mexBM Class Reference</h1><!-- doxytag: class="bdm::mexBM" --><!-- doxytag: inherits="bdm::BM" -->
+<p><a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> with functions implemented in matlab.  
+<a href="#_details">More...</a></p>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p><a class="el" href="classbdm_1_1BM.html" title="Bayesian Model of a system, i.e. all uncertainty is modeled by probabilities.">BM</a> with functions implemented in matlab. </p>
+
+<p><code>#include &lt;<a class="el" href="mex__BM_8h_source.html">mex_BM.h</a>&gt;</code></p>
+
 <p><a href="classbdm_1_1mexBM-members.html">List of all members.</a></p>
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a35ffc1eedee492e54c031623fd72a8"></a><!-- doxytag: member="bdm::mexBM::get_data" ref="a4a35ffc1eedee492e54c031623fd72a8" args="()" -->
-mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_data</b> ()</td></tr>
+mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#a4a35ffc1eedee492e54c031623fd72a8">get_data</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">duplicate internal data pointer? <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dc5937132e070894ca6002b05512afd"></a><!-- doxytag: member="bdm::mexBM::from_setting" ref="a1dc5937132e070894ca6002b05512afd" args="(const Setting &amp;S)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#a1dc5937132e070894ca6002b05512afd">from_setting</a> (const Setting &amp;S)</td></tr>
@@ -83 +91 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Incremental Bayes rule.  <a href="#aa99452b52f731f561b01029af18c68f7"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76b0e1e8f86a90a829e6821d013d7683"></a><!-- doxytag: member="bdm::mexBM::posterior" ref="a76b0e1e8f86a90a829e6821d013d7683" args="() const " -->
-const <a class="el" href="classbdm_1_1mexEpdf.html">mexEpdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>posterior</b> () const </td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad781cb2f1e32cea252da3935df442dd5"></a><!-- doxytag: member="bdm::mexBM::_e" ref="ad781cb2f1e32cea252da3935df442dd5" args="() const " -->
-const <a class="el" href="classbdm_1_1mexEpdf.html">mexEpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> () const </td></tr>
+const <a class="el" href="classbdm_1_1mexEpdf.html">mexEpdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#a76b0e1e8f86a90a829e6821d013d7683">posterior</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return correctly typed posterior (covariant return) <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mexBM::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
@@ -117 +124 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs conditional density of 1-step ahead predictor <img class="formulaInl" alt="$ f(d_{t+1} |d_{t+h-1}, \ldots d_{t}) $" src="form_21.png"/>. <br/></td></tr>
 <tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
-<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p>
+<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> access function </p>
 <br/><br/></div></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff2d8755ba0b3def927d31305c03b09c"></a><!-- doxytag: member="bdm::mexBM::_drv" ref="aff2d8755ba0b3def927d31305c03b09c" args="() const " -->
 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_drv</b> () const </td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af135ae6dce7e9f30c9f88229c7930b96"></a><!-- doxytag: member="bdm::mexBM::set_drv" ref="af135ae6dce7e9f30c9f88229c7930b96" args="(const RV &amp;rv)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_drv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#af135ae6dce7e9f30c9f88229c7930b96">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab38d92f17620813ad872d86e01a26e5e"></a><!-- doxytag: member="bdm::mexBM::set_rv" ref="ab38d92f17620813ad872d86e01a26e5e" args="(const RV &amp;rv)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#ab38d92f17620813ad872d86e01a26e5e">set_rv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access to rv of the posterior <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5be65d37dedfe33a3671e7065f523a70"></a><!-- doxytag: member="bdm::mexBM::_ll" ref="a5be65d37dedfe33a3671e7065f523a70" args="() const " -->
-double&nbsp;</td><td class="memItemRight" valign="bottom"><b>_ll</b> () const </td></tr>
+double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a5be65d37dedfe33a3671e7065f523a70">_ll</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return internal log-likelihood of the last data vector <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a236b3abbcc93594fc97cd86d82c1a83f"></a><!-- doxytag: member="bdm::mexBM::set_evalll" ref="a236b3abbcc93594fc97cd86d82c1a83f" args="(bool evl0)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_evalll</b> (bool evl0)</td></tr>
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a236b3abbcc93594fc97cd86d82c1a83f">set_evalll</a> (bool evl0)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">switch evaluation of log-likelihood on/off <br/></td></tr>
 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61122bf54322e51a965ce3eacb9ee3ac"></a><!-- doxytag: member="bdm::mexBM::name" ref="a61122bf54322e51a965ce3eacb9ee3ac" args="" -->
-string&nbsp;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
+string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#a61122bf54322e51a965ce3eacb9ee3ac">name</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">prefix of matlab functions <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfaf13987bb1263bc32426da8bc94496"></a><!-- doxytag: member="bdm::mexBM::est" ref="adfaf13987bb1263bc32426da8bc94496" args="" -->
-<a class="el" href="classbdm_1_1mexEpdf.html">mexEpdf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>est</b></td></tr>
+<a class="el" href="classbdm_1_1mexEpdf.html">mexEpdf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#adfaf13987bb1263bc32426da8bc94496">est</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal estimator <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3f5f0313085c2f8db8249414644a62f"></a><!-- doxytag: member="bdm::mexBM::data" ref="af3f5f0313085c2f8db8249414644a62f" args="" -->
-mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
+mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexBM.html#af3f5f0313085c2f8db8249414644a62f">data</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mxArray with attributes of this object <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac400357e37d27a4834b2b1d9211009ed"></a><!-- doxytag: member="bdm::mexBM::drv" ref="ac400357e37d27a4834b2b1d9211009ed" 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#ac400357e37d27a4834b2b1d9211009ed">drv</a></td></tr>
@@ -164 +178 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string, recognized are: "logbounds,logll". <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2298ca6af9b13a78a4c9e18ab43f1827"></a><!-- doxytag: member="bdm::mexBM::log_add" ref="a2298ca6af9b13a78a4c9e18ab43f1827" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a2298ca6af9b13a78a4c9e18ab43f1827">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr>
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#a2298ca6af9b13a78a4c9e18ab43f1827">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;<a class="el" href="classbdm_1_1mexBM.html#a61122bf54322e51a965ce3eacb9ee3ac">name</a>=&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" align="right" valign="top"><a class="anchor" id="ab517e1679eaa94e803ea4cd0b8efbcd7"></a><!-- doxytag: member="bdm::mexBM::logit" ref="ab517e1679eaa94e803ea4cd0b8efbcd7" args="(logger &amp;L)" -->
@@ -197 +211 @@
 <p>Reimplemented in <a class="el" href="classbdm_1_1ARX.html#aca0b54c0997cfd567f49377af5def106">bdm::ARX</a>, <a class="el" href="classbdm_1_1ARXfrg.html#a420f3f195d231723f2f2329ec900de60">bdm::ARXfrg</a>, <a class="el" href="classbdm_1_1KalmanFull.html#ab77ade422273f60b8955122b81abf3c1">bdm::KalmanFull</a>, <a class="el" href="classbdm_1_1KalmanCh.html#a24ce65bdaa538d4d5153d709a929b996">bdm::KalmanCh</a>, <a class="el" href="classbdm_1_1EKFCh.html#a1d1d91400e3f177de9fe7962ea17adc4">bdm::EKFCh</a>, and <a class="el" href="classbdm_1_1BMEF.html#a62d2e4691bed41a1efa6b9c2e35e5c67">bdm::BMEF</a>.</p>
 
+<p>Referenced by <a class="el" href="particles_8h_source.html#l00316">bdm::MPF::set_BM()</a>.</p>
+
 </div>
 </div>
@@ -225 +241 @@
 <p>Implements <a class="el" href="classbdm_1_1BM.html#a60b1779a577367c369a932cabd3a6188">bdm::BM</a>.</p>
 
+<p>References <a class="el" href="mex__BM_8h_source.html#l00053">data</a>, and <a class="el" href="mex__BM_8h_source.html#l00049">name</a>.</p>
+
 </div>
 </div>
@@ -248 +266 @@
 <p>References <a class="el" href="bdmerror_8h_source.html#l00051">bdm_error</a>.</p>
 
-<p>Referenced by <a class="el" href="bdmbase_8h_source.html#l01098">bdm::BM::logpred_m()</a>.</p>
+<p>Referenced by <a class="el" href="bdmbase_8h_source.html#l01102">bdm::BM::logpred_m()</a>.</p>
 
 </div>
@@ -256 +274 @@
 </ul>
 </div>
-<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Oct 12 19:37:21 2009 for mixpp by&nbsp;
+<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:50 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>