Show
Ignore:
Timestamp:
06/08/09 18:02:55 (16 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/html/classbdm_1_1ARX.html

    r354 r368  
    8383 
    8484<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sufficient statistics. <br></td></tr> 
    85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::ARX::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" --> 
    86 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#8d5f760ac23ae2c699d212c24892ae5f">from_setting</a> (const Setting &amp;root)</td></tr> 
     86 
     87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::ARX::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
     88virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
    8789 
    8890<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    89 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::ARX::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
    90 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr> 
    91  
    92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> 
    9391<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::ARX::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    9492virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr> 
    9593 
    9694<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
     95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::ARX::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
     96virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     97 
     98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    9799<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    98100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43ed6114f04a3a8756fe2b42eaa35f98"></a><!-- doxytag: member="bdm::ARX::ARX" ref="43ed6114f04a3a8756fe2b42eaa35f98" args="(const double frg0=1.0)" --> 
    … …  
    307309<p>Reimplemented from <a class="el" href="classbdm_1_1BMEF.html#c287f4c0c1ea31b91572ec45351838f1">bdm::BMEF</a>.</p> 
    308310 
    309 <p>References <a class="el" href="arx_8h-source.html#l00076">bayes()</a>.</p> 
    310  
    311 <p>Referenced by <a class="el" href="arx_8h-source.html#l00076">bayes()</a>.</p> 
     311<p>References <a class="el" href="arx_8h-source.html#l00077">bayes()</a>.</p> 
     312 
     313<p>Referenced by <a class="el" href="arx_8h-source.html#l00077">bayes()</a>.</p> 
     314 
     315</div> 
     316</div><p> 
     317<a class="anchor" name="8d5f760ac23ae2c699d212c24892ae5f"></a><!-- doxytag: member="bdm::ARX::from_setting" ref="8d5f760ac23ae2c699d212c24892ae5f" args="(const Setting &amp;root)" --> 
     318<div class="memitem"> 
     319<div class="memproto"> 
     320      <table class="memname"> 
     321        <tr> 
     322          <td class="memname">void bdm::ARX::from_setting           </td> 
     323          <td>(</td> 
     324          <td class="paramtype">const Setting &amp;&nbsp;</td> 
     325          <td class="paramname"> <em>root</em>          </td> 
     326          <td>&nbsp;)&nbsp;</td> 
     327          <td><code> [virtual]</code></td> 
     328        </tr> 
     329      </table> 
     330</div> 
     331<div class="memdoc"> 
     332 
     333<p> 
     334<a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> estimator<p> 
     335The <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">        estimator = { 
     336                type = <span class="stringliteral">"ARX"</span>; 
     337                y = {type=<span class="stringliteral">"rv"</span>, ...}   <span class="comment">// description of output variables</span> 
     338                rgr = {type=<span class="stringliteral">"rv"</span>, ...} <span class="comment">// description of regressor variables</span> 
     339                constant = <span class="keyword">true</span>;       <span class="comment">// boolean switch if the constant term is modelled or not</span> 
     340 
     341                <span class="comment">//optional fields</span> 
     342                dV0 = [1e-3, 1e-5, 1e-5, 1e-5];  
     343                                                           <span class="comment">// default: 1e-3 for y, 1e-5 for rgr</span> 
     344                nu0 = 6;               <span class="comment">// default: rgrlen + 2</span> 
     345                <a class="code" href="classbdm_1_1BMEF.html#1331865e10fb1ccef65bb4c47fa3be64" title="forgetting factor">frg</a> = 1.0;             <span class="comment">// forgetting, default frg=1.0</span> 
     346        }; 
     347</pre></div><p> 
     348The estimator will assign names of the posterior in the form ["theta_i" and "r_i"]  
     349<p>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p> 
     350 
     351<p>References <a class="el" href="libBM_8h-source.html#l00120">bdm::RV::_dsize()</a>, <a class="el" href="libEF_8h-source.html#l00082">bdm::BMEF::frg</a>, and <a class="el" href="user__info_8h-source.html#l00249">bdm::UI::get()</a>.</p> 
    312352 
    313353</div> 
    … …  
    333373<p>Reimplemented from <a class="el" href="classbdm_1_1BM.html#50257e0c1e5b5c73153ea6e716ad8ae0">bdm::BM</a>.</p> 
    334374 
    335 <p>References <a class="el" href="libEF_8h-source.html#l00221">bdm::egiw::_nu()</a>, <a class="el" href="libEF_8h-source.html#l00219">bdm::egiw::_V()</a>, <a class="el" href="arx_8h-source.html#l00047">est</a>, <a class="el" href="libBM_8h-source.html#l00665">bdm::BM::evalll</a>, <a class="el" href="libEF_8h-source.html#l00082">bdm::BMEF::frg</a>, <a class="el" href="libEF_8h-source.html#l00084">bdm::BMEF::last_lognc</a>, <a class="el" href="libEF_8cpp-source.html#l00044">bdm::egiw::lognc()</a>, <a class="el" href="arx_8h-source.html#l00051">nu</a>, <a class="el" href="libDC_8cpp-source.html#l00058">ldmat::opupdt()</a>, <a class="el" href="libEF_8h-source.html#l00214">bdm::egiw::pow()</a>, and <a class="el" href="arx_8h-source.html#l00049">V</a>.</p> 
     375<p>References <a class="el" href="libEF_8h-source.html#l00221">bdm::egiw::_nu()</a>, <a class="el" href="libEF_8h-source.html#l00219">bdm::egiw::_V()</a>, <a class="el" href="arx_8h-source.html#l00048">est</a>, <a class="el" href="libBM_8h-source.html#l00657">bdm::BM::evalll</a>, <a class="el" href="libEF_8h-source.html#l00082">bdm::BMEF::frg</a>, <a class="el" href="libEF_8h-source.html#l00084">bdm::BMEF::last_lognc</a>, <a class="el" href="libEF_8cpp-source.html#l00044">bdm::egiw::lognc()</a>, <a class="el" href="arx_8h-source.html#l00052">nu</a>, <a class="el" href="libDC_8cpp-source.html#l00058">ldmat::opupdt()</a>, <a class="el" href="libEF_8h-source.html#l00214">bdm::egiw::pow()</a>, and <a class="el" href="arx_8h-source.html#l00050">V</a>.</p> 
    336376 
    337377</div> 
    … …  
    360400<p>Reimplemented from <a class="el" href="classbdm_1_1BM.html#598b25e3f3d96a5bc00a5faeb5b3c912">bdm::BM</a>.</p> 
    361401 
    362 <p>References <a class="el" href="libBM_8h-source.html#l00310">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h-source.html#l00047">est</a>, <a class="el" href="libEF_8cpp-source.html#l00138">bdm::egiw::mean_mat()</a>, <a class="el" href="libDC_8h-source.html#l00289">ldmat::rows()</a>, <a class="el" href="libEF_8h-source.html#l01044">bdm::mlnorm&lt; sq_T &gt;::set_parameters()</a>, and <a class="el" href="arx_8h-source.html#l00049">V</a>.</p> 
     402<p>References <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h-source.html#l00048">est</a>, <a class="el" href="libEF_8cpp-source.html#l00138">bdm::egiw::mean_mat()</a>, <a class="el" href="libDC_8h-source.html#l00289">ldmat::rows()</a>, <a class="el" href="libEF_8h-source.html#l01156">bdm::mlnorm&lt; sq_T &gt;::set_parameters()</a>, and <a class="el" href="arx_8h-source.html#l00050">V</a>.</p> 
    363403 
    364404</div> 
    … …  
    385425<dl class="return" compact><dt><b>Returns:</b></dt><dd>indeces of accepted regressors. </dd></dl> 
    386426 
    387 <p>References <a class="el" href="libBM_8h-source.html#l00310">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h-source.html#l00047">est</a>, and <a class="el" href="libEF_8cpp-source.html#l00044">bdm::egiw::lognc()</a>.</p> 
     427<p>References <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h-source.html#l00048">est</a>, and <a class="el" href="libEF_8cpp-source.html#l00044">bdm::egiw::lognc()</a>.</p> 
    388428 
    389429</div> 
    … …  
    408448<li><a class="el" href="arx_8h-source.html">arx.h</a><li>bdm/estim/arx.cpp</ul> 
    409449</div> 
    410 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:00 2009 for mixpp by&nbsp; 
     450<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp; 
    411451<a href="http://www.doxygen.org/index.html"> 
    412452<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>