root/library/doc/html/classbdm_1_1ARX.html @ 536

Revision 472, 36.2 kB (checked in by mido, 15 years ago)

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: bdm::ARX Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1ARX.html">ARX</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::ARX Class Reference</h1><!-- doxytag: class="bdm::ARX" --><!-- doxytag: inherits="bdm::BMEF" -->Linear Autoregressive model with Gaussian noise. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="arx_8h_source.html">arx.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1ARX-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="539f9d0127423c94b912708d390e67b8"></a><!-- doxytag: member="bdm::ARX::set_statistics" ref="539f9d0127423c94b912708d390e67b8" args="(const BMEF *BM0)" -->
81void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#539f9d0127423c94b912708d390e67b8">set_statistics</a> (const <a class="el" href="classbdm_1_1BMEF.html">BMEF</a> *BM0)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set sufficient statistics. <br></td></tr>
84<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#9637412df898048bafaefee9dc7e9f6c">from_setting</a> (const Setting &amp;set)</td></tr>
85
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::ARX::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
87virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::ARX::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
91virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::ARX::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
95virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
98<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
99<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)" -->
100&nbsp;</td><td class="memItemRight" valign="bottom"><b>ARX</b> (const double frg0=1.0)</td></tr>
101
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73a55a3d66bfbeeee4df6c2ae40920ed"></a><!-- doxytag: member="bdm::ARX::ARX" ref="73a55a3d66bfbeeee4df6c2ae40920ed" args="(const ARX &amp;A0)" -->
103&nbsp;</td><td class="memItemRight" valign="bottom"><b>ARX</b> (const <a class="el" href="classbdm_1_1ARX.html">ARX</a> &amp;A0)</td></tr>
104
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0b54c0997cfd567f49377af5def106"></a><!-- doxytag: member="bdm::ARX::_copy_" ref="ca0b54c0997cfd567f49377af5def106" args="() const " -->
106<a class="el" href="classbdm_1_1ARX.html">ARX</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#ca0b54c0997cfd567f49377af5def106">_copy_</a> () const </td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flatten the posterior as if to keep nu0 data. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aef6fe827f15427d534e6fb2c220e04"></a><!-- doxytag: member="bdm::ARX::set_parameters" ref="7aef6fe827f15427d534e6fb2c220e04" args="(double frg0)" -->
110void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_parameters</b> (double frg0)</td></tr>
111
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f859f53eab269845a9064bbd92f841af"></a><!-- doxytag: member="bdm::ARX::set_statistics" ref="f859f53eab269845a9064bbd92f841af" args="(int dimx0, const ldmat V0, double nu0=&#45;1.0)" -->
113void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_statistics</b> (int dimx0, const <a class="el" href="classldmat.html">ldmat</a> V0, double nu0=-1.0)</td></tr>
114
115<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17e7fe14654ab3c449846c3f43e66169"></a><!-- doxytag: member="bdm::ARX::bayes" ref="17e7fe14654ab3c449846c3f43e66169" args="(const vec &amp;dt, const double w)" -->
117void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#17e7fe14654ab3c449846c3f43e66169">bayes</a> (const vec &amp;dt, const double w)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Weighted Bayes <img class="formulaInl" alt="$ dt = [y_t psi_t] $" src="form_28.png">. <br></td></tr>
120<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#8bdf2974052e8ce74eb0d4f3791c58a3">bayes</a> (const vec &amp;dt)</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Incremental Bayes rule.  <a href="#8bdf2974052e8ce74eb0d4f3791c58a3"></a><br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#080a7e531e3aa06694112863b15bc6a4">logpred</a> (const vec &amp;dt) const </td></tr>
124
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e86ab499b116b837d3163ec852961eca"></a><!-- doxytag: member="bdm::ARX::flatten" ref="e86ab499b116b837d3163ec852961eca" args="(const BMEF *B)" -->
126void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#e86ab499b116b837d3163ec852961eca">flatten</a> (const <a class="el" href="classbdm_1_1BMEF.html">BMEF</a> *B)</td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flatten the posterior according to the given <a class="el" href="classbdm_1_1BMEF.html" title="Estimator for Exponential family.">BMEF</a> (of the same type!). <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="749827323c034f11bec61b6e2fc3d42a"></a><!-- doxytag: member="bdm::ARX::epredictor" ref="749827323c034f11bec61b6e2fc3d42a" args="(const vec &amp;rgr) const " -->
130<a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; <a class="el" href="classldmat.html">ldmat</a> &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#749827323c034f11bec61b6e2fc3d42a">epredictor</a> (const vec &amp;rgr) const </td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conditioned version of the predictor. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cdf5e2a7d3480ec31f6247ed4289b15"></a><!-- doxytag: member="bdm::ARX::epredictor" ref="4cdf5e2a7d3480ec31f6247ed4289b15" args="() const " -->
134<a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; <a class="el" href="classldmat.html">ldmat</a> &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#4cdf5e2a7d3480ec31f6247ed4289b15">epredictor</a> () const </td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Predictor for empty regressor. <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbdm_1_1mlnorm.html">mlnorm</a>&lt; <a class="el" href="classldmat.html">ldmat</a> &gt; *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#74fe8ae2d88bee8639510fd0eaf73513">predictor</a> () const </td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">conditional version of the predictor  <a href="#74fe8ae2d88bee8639510fd0eaf73513"></a><br></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6a2428a46407fe45b4c7a99069c0801"></a><!-- doxytag: member="bdm::ARX::predictor_student" ref="c6a2428a46407fe45b4c7a99069c0801" args="() const " -->
141<a class="el" href="classbdm_1_1mlstudent.html">mlstudent</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>predictor_student</b> () const </td></tr>
142
143<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#16b02ae03316751664c22d59d90c1e34">structure_est</a> (<a class="el" href="classbdm_1_1egiw.html">egiw</a> Eg0)</td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Brute force structure estimation.  <a href="#16b02ae03316751664c22d59d90c1e34"></a><br></td></tr>
146<tr><td colspan="2"><div class="groupHeader">Access attributes</div></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab2c55205a324e9d698fbd8ac229ad4f"></a><!-- doxytag: member="bdm::ARX::_e" ref="ab2c55205a324e9d698fbd8ac229ad4f" args="() const " -->
148const <a class="el" href="classbdm_1_1egiw.html">egiw</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> () const </td></tr>
149
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a96a50d212648f049122a31d9553618"></a><!-- doxytag: member="bdm::ARX::posterior" ref="5a96a50d212648f049122a31d9553618" args="() const " -->
151const <a class="el" href="classbdm_1_1egiw.html">egiw</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>posterior</b> () const </td></tr>
152
153<tr><td colspan="2"><div class="groupHeader">Connection</div></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df3dc1b90efc0cc54a3a6e5e858542d1"></a><!-- doxytag: member="bdm::ARX::set_drv" ref="df3dc1b90efc0cc54a3a6e5e858542d1" args="(const RV &amp;drv0)" -->
155void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_drv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv0)</td></tr>
156
157<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b96872783ab72e135b7b9ee26ef0577"></a><!-- doxytag: member="bdm::ARX::get_yrv" ref="7b96872783ab72e135b7b9ee26ef0577" args="()" -->
158<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>get_yrv</b> ()</td></tr>
159
160<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1dee3fddaf021e62d925289660a707dc"></a><!-- doxytag: member="bdm::ARX::bayesB" ref="1dee3fddaf021e62d925289660a707dc" args="(const mat &amp;Dt)" -->
162virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#1dee3fddaf021e62d925289660a707dc">bayesB</a> (const mat &amp;Dt)</td></tr>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Batch Bayes rule (columns of Dt are observations). <br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e8ebe61fb14990abe1254bd3dda5fae"></a><!-- doxytag: member="bdm::ARX::logpred_m" ref="0e8ebe61fb14990abe1254bd3dda5fae" args="(const mat &amp;dt) const " -->
166vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#0e8ebe61fb14990abe1254bd3dda5fae">logpred_m</a> (const mat &amp;dt) const </td></tr>
167
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of logpred. <br></td></tr>
169<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff2d8755ba0b3def927d31305c03b09c"></a><!-- doxytag: member="bdm::ARX::_drv" ref="ff2d8755ba0b3def927d31305c03b09c" args="() const " -->
171const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_drv</b> () const </td></tr>
172
173<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b38d92f17620813ad872d86e01a26e5e"></a><!-- doxytag: member="bdm::ARX::set_rv" ref="b38d92f17620813ad872d86e01a26e5e" args="(const RV &amp;rv)" -->
174void&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>
175
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5be65d37dedfe33a3671e7065f523a70"></a><!-- doxytag: member="bdm::ARX::_ll" ref="5be65d37dedfe33a3671e7065f523a70" args="() const " -->
177double&nbsp;</td><td class="memItemRight" valign="bottom"><b>_ll</b> () const </td></tr>
178
179<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="236b3abbcc93594fc97cd86d82c1a83f"></a><!-- doxytag: member="bdm::ARX::set_evalll" ref="236b3abbcc93594fc97cd86d82c1a83f" args="(bool evl0)" -->
180void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_evalll</b> (bool evl0)</td></tr>
181
182<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e68db2a218d54b09304cad6c0a897d9"></a><!-- doxytag: member="bdm::ARX::dimx" ref="8e68db2a218d54b09304cad6c0a897d9" args="" -->
184int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#8e68db2a218d54b09304cad6c0a897d9">dimx</a></td></tr>
185
186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output variable (needed in regressors) <br></td></tr>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#363aaa55b2ab3eec602510cdf53e84ef">_yrv</a></td></tr>
188
189<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11474a627367f81b76830cb8477cf026"></a><!-- doxytag: member="bdm::ARX::est" ref="11474a627367f81b76830cb8477cf026" args="" -->
190<a class="el" href="classbdm_1_1egiw.html">egiw</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#11474a627367f81b76830cb8477cf026">est</a></td></tr>
191
192<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Posterior estimate of <img class="formulaInl" alt="$\theta,r$" src="form_27.png"> in the form of Normal-inverse Wishart density. <br></td></tr>
193<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de5b7d83ff5d3f5af2f80068db0abdfd"></a><!-- doxytag: member="bdm::ARX::V" ref="de5b7d83ff5d3f5af2f80068db0abdfd" args="" -->
194<a class="el" href="classldmat.html">ldmat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#de5b7d83ff5d3f5af2f80068db0abdfd">V</a></td></tr>
195
196<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cached value of est.V <br></td></tr>
197<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="740b0582f180ba13cae91d66e9bdb67f"></a><!-- doxytag: member="bdm::ARX::nu" ref="740b0582f180ba13cae91d66e9bdb67f" args="" -->
198double &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ARX.html#740b0582f180ba13cae91d66e9bdb67f">nu</a></td></tr>
199
200<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cached value of est.nu <br></td></tr>
201<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1331865e10fb1ccef65bb4c47fa3be64"></a><!-- doxytag: member="bdm::ARX::frg" ref="1331865e10fb1ccef65bb4c47fa3be64" args="" -->
202double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMEF.html#1331865e10fb1ccef65bb4c47fa3be64">frg</a></td></tr>
203
204<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">forgetting factor <br></td></tr>
205<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06e7b3ac03e10017d4288c76888e2865"></a><!-- doxytag: member="bdm::ARX::last_lognc" ref="06e7b3ac03e10017d4288c76888e2865" args="" -->
206double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BMEF.html#06e7b3ac03e10017d4288c76888e2865">last_lognc</a></td></tr>
207
208<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cached value of lognc() in the previous step (used in evaluation of <code>ll</code> ) <br></td></tr>
209<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c400357e37d27a4834b2b1d9211009ed"></a><!-- doxytag: member="bdm::ARX::drv" ref="c400357e37d27a4834b2b1d9211009ed" args="" -->
210<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>
211
212<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Random variable of the data (optional). <br></td></tr>
213<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4064b6559d962633e4372b12f4cd204a"></a><!-- doxytag: member="bdm::ARX::ll" ref="4064b6559d962633e4372b12f4cd204a" args="" -->
214double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#4064b6559d962633e4372b12f4cd204a">ll</a></td></tr>
215
216<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Logarithm of marginalized data likelihood. <br></td></tr>
217<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="faff0ad12556fe7dc0e2807d4fd938ee"></a><!-- doxytag: member="bdm::ARX::evalll" ref="faff0ad12556fe7dc0e2807d4fd938ee" args="" -->
218bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#faff0ad12556fe7dc0e2807d4fd938ee">evalll</a></td></tr>
219
220<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>
221<tr><td colspan="2"><br><h2>Extension to conditional BM</h2></td></tr>
222<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>
223<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5e8e016be16e4029c789063cb3f3b33"></a><!-- doxytag: member="bdm::ARX::_rvc" ref="b5e8e016be16e4029c789063cb3f3b33" args="() const " -->
224const <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>
225
226<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
227<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6799f4b16a6a59ed58b1d0d6e17116f4"></a><!-- doxytag: member="bdm::ARX::condition" ref="6799f4b16a6a59ed58b1d0d6e17116f4" args="(const vec &amp;val)" -->
228virtual 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>
229
230<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitute <code>val</code> for <code>rvc</code>. <br></td></tr>
231<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de95c590d650b2db423d53992f0906cb"></a><!-- doxytag: member="bdm::ARX::rvc" ref="de95c590d650b2db423d53992f0906cb" args="" -->
232<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>
233
234<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of extension variable. <br></td></tr>
235<tr><td colspan="2"><br><h2>Logging of results</h2></td></tr>
236<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adb539fa2585c8a2a91c54e5aebf330e"></a><!-- doxytag: member="bdm::ARX::set_options" ref="adb539fa2585c8a2a91c54e5aebf330e" args="(const string &amp;opt)" -->
237virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#adb539fa2585c8a2a91c54e5aebf330e">set_options</a> (const string &amp;opt)</td></tr>
238
239<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set boolean options from a string, recognized are: "logbounds,logll". <br></td></tr>
240<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2298ca6af9b13a78a4c9e18ab43f1827"></a><!-- doxytag: member="bdm::ARX::log_add" ref="2298ca6af9b13a78a4c9e18ab43f1827" args="(logger &amp;L, const string &amp;name=&quot;&quot;)" -->
241virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#2298ca6af9b13a78a4c9e18ab43f1827">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L, const string &amp;name=&quot;&quot;)</td></tr>
242
243<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>
244<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b517e1679eaa94e803ea4cd0b8efbcd7"></a><!-- doxytag: member="bdm::ARX::logit" ref="b517e1679eaa94e803ea4cd0b8efbcd7" args="(logger &amp;L)" -->
245virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>logit</b> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
246
247<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109c1a626a69031658e3a44e9e500cca"></a><!-- doxytag: member="bdm::ARX::LIDs" ref="109c1a626a69031658e3a44e9e500cca" args="" -->
248ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#109c1a626a69031658e3a44e9e500cca">LIDs</a></td></tr>
249
250<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IDs of storages in loggers 4:[1=mean,2=lb,3=ub,4=ll]. <br></td></tr>
251<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="398b7e7a162cf37d0022d6126495f207"></a><!-- doxytag: member="bdm::ARX::LFlags" ref="398b7e7a162cf37d0022d6126495f207" args="" -->
252ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1BM.html#398b7e7a162cf37d0022d6126495f207">LFlags</a></td></tr>
253
254<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags for logging - same size as LIDs, each entry correspond to the same in LIDs. <br></td></tr>
255</table>
256<hr><a name="_details"></a><h2>Detailed Description</h2>
257Linear Autoregressive model with Gaussian noise.
258<p>
259Regression of the following kind: <p class="formulaDsp">
260<img class="formulaDsp" alt="\[ y_t = \theta_1 \psi_1 + \theta_2 + \psi_2 +\ldots + \theta_n \psi_n + r e_t \]" src="form_20.png">
261<p>
262 where unknown parameters <code>rv</code> are <img class="formulaInl" alt="$[\theta r]$" src="form_21.png">, regression vector <img class="formulaInl" alt="$\psi=\psi(y_{1:t},u_{1:t})$" src="form_22.png"> is a known function of past outputs and exogeneous variables <img class="formulaInl" alt="$u_t$" src="form_23.png">. Distrubances <img class="formulaInl" alt="$e_t$" src="form_24.png"> are supposed to be normally distributed: <p class="formulaDsp">
263<img class="formulaDsp" alt="\[ e_t \sim \mathcal{N}(0,1). \]" src="form_25.png">
264<p>
265<p>
266See <a class="el" href="tut_arx.html">Theory of ARX model estimation</a> for mathematical treatment.<p>
267The easiest way how to use the class is: <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "<a class="code" href="arx_8h.html" title="Bayesian Filtering for generalized autoregressive (ARX) model.">estim/arx.h</a>"</span>
268<span class="keyword">using namespace </span>bdm;
269       
270<span class="comment">// estimation of AR(0) model</span>
271<span class="keywordtype">int</span> main() {
272        <span class="comment">//prior </span>
273        mat V0 = 0.00001*eye(2); V0(0,0)= 0.1; <span class="comment">//</span>
274        ARX Ar;
275        Ar.set_statistics(1, V0); <span class="comment">//nu is default (set to have finite moments)</span>
276                                                          <span class="comment">// forgetting is default: 1.0</span>
277        mat Data = concat_vertical( randn(1,100), ones(1,100) );
278        Ar.bayesB( Data);
279                       
280        cout &lt;&lt; <span class="stringliteral">"Expected value of Theta is: "</span> &lt;&lt; Ar.posterior().mean() &lt;&lt;endl;
281}
282</pre></div><p>
283<dl class="todo" compact><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>sort out constant terms - bayes should accept vec without additional 1s </dd></dl>
284<hr><h2>Member Function Documentation</h2>
285<a class="anchor" name="8bdf2974052e8ce74eb0d4f3791c58a3"></a><!-- doxytag: member="bdm::ARX::bayes" ref="8bdf2974052e8ce74eb0d4f3791c58a3" args="(const vec &amp;dt)" -->
286<div class="memitem">
287<div class="memproto">
288      <table class="memname">
289        <tr>
290          <td class="memname">void bdm::ARX::bayes           </td>
291          <td>(</td>
292          <td class="paramtype">const vec &amp;&nbsp;</td>
293          <td class="paramname"> <em>dt</em>          </td>
294          <td>&nbsp;)&nbsp;</td>
295          <td><code> [inline, virtual]</code></td>
296        </tr>
297      </table>
298</div>
299<div class="memdoc">
300
301<p>
302Incremental Bayes rule.
303<p>
304<dl compact><dt><b>Parameters:</b></dt><dd>
305  <table border="0" cellspacing="2" cellpadding="0">
306    <tr><td valign="top"></td><td valign="top"><em>dt</em>&nbsp;</td><td>vector of input data </td></tr>
307  </table>
308</dl>
309
310<p>Reimplemented from <a class="el" href="classbdm_1_1BMEF.html#c287f4c0c1ea31b91572ec45351838f1">bdm::BMEF</a>.</p>
311
312<p>References <a class="el" href="arx_8h_source.html#l00078">bayes()</a>.</p>
313
314<p>Referenced by <a class="el" href="arx_8h_source.html#l00078">bayes()</a>.</p>
315
316</div>
317</div><p>
318<a class="anchor" name="9637412df898048bafaefee9dc7e9f6c"></a><!-- doxytag: member="bdm::ARX::from_setting" ref="9637412df898048bafaefee9dc7e9f6c" args="(const Setting &amp;set)" -->
319<div class="memitem">
320<div class="memproto">
321      <table class="memname">
322        <tr>
323          <td class="memname">void bdm::ARX::from_setting           </td>
324          <td>(</td>
325          <td class="paramtype">const Setting &amp;&nbsp;</td>
326          <td class="paramname"> <em>set</em>          </td>
327          <td>&nbsp;)&nbsp;</td>
328          <td><code> [virtual]</code></td>
329        </tr>
330      </table>
331</div>
332<div class="memdoc">
333
334<p>
335<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> estimator<p>
336The <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 = {
337                type = <span class="stringliteral">"ARX"</span>;
338                y = {type=<span class="stringliteral">"rv"</span>, ...}   <span class="comment">// description of output variables</span>
339                rgr = {type=<span class="stringliteral">"rv"</span>, ...} <span class="comment">// description of regressor variables</span>
340                constant = <span class="keyword">true</span>;       <span class="comment">// boolean switch if the constant term is modelled or not</span>
341
342                <span class="comment">//optional fields</span>
343                dV0 = [1e-3, 1e-5, 1e-5, 1e-5];
344                                                           <span class="comment">// default: 1e-3 for y, 1e-5 for rgr</span>
345                nu0 = 6;               <span class="comment">// default: rgrlen + 2</span>
346                <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>
347        };
348</pre></div><p>
349The estimator will assign names of the posterior in the form ["theta_i" and "r_i"]
350<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
351
352<p>References <a class="el" href="exp__family_8h_source.html#l00086">bdm::BMEF::frg</a>, and <a class="el" href="user__info_8h_source.html#l00387">bdm::UI::get()</a>.</p>
353
354</div>
355</div><p>
356<a class="anchor" name="080a7e531e3aa06694112863b15bc6a4"></a><!-- doxytag: member="bdm::ARX::logpred" ref="080a7e531e3aa06694112863b15bc6a4" args="(const vec &amp;dt) const " -->
357<div class="memitem">
358<div class="memproto">
359      <table class="memname">
360        <tr>
361          <td class="memname">double bdm::ARX::logpred           </td>
362          <td>(</td>
363          <td class="paramtype">const vec &amp;&nbsp;</td>
364          <td class="paramname"> <em>dt</em>          </td>
365          <td>&nbsp;)&nbsp;</td>
366          <td> const<code> [virtual]</code></td>
367        </tr>
368      </table>
369</div>
370<div class="memdoc">
371
372<p>
373Evaluates predictive log-likelihood of the given data record I.e. marginal likelihood of the data with the posterior integrated out.
374<p>Reimplemented from <a class="el" href="classbdm_1_1BM.html#50257e0c1e5b5c73153ea6e716ad8ae0">bdm::BM</a>.</p>
375
376<p>References <a class="el" href="arx_8h_source.html#l00049">est</a>, <a class="el" href="bdmbase_8h_source.html#l00741">bdm::BM::evalll</a>, <a class="el" href="exp__family_8h_source.html#l00086">bdm::BMEF::frg</a>, <a class="el" href="exp__family_8h_source.html#l00088">bdm::BMEF::last_lognc</a>, <a class="el" href="exp__family_8cpp_source.html#l00047">bdm::egiw::lognc()</a>, <a class="el" href="arx_8h_source.html#l00053">nu</a>, <a class="el" href="square__mat_8cpp_source.html#l00058">ldmat::opupdt()</a>, <a class="el" href="exp__family_8h_source.html#l00227">bdm::egiw::pow()</a>, and <a class="el" href="arx_8h_source.html#l00051">V</a>.</p>
377
378</div>
379</div><p>
380<a class="anchor" name="74fe8ae2d88bee8639510fd0eaf73513"></a><!-- doxytag: member="bdm::ARX::predictor" ref="74fe8ae2d88bee8639510fd0eaf73513" args="() const " -->
381<div class="memitem">
382<div class="memproto">
383      <table class="memname">
384        <tr>
385          <td class="memname"><a class="el" href="classbdm_1_1mlnorm.html">mlnorm</a>&lt; <a class="el" href="classldmat.html">ldmat</a> &gt; * bdm::ARX::predictor           </td>
386          <td>(</td>
387          <td class="paramname">          </td>
388          <td>&nbsp;)&nbsp;</td>
389          <td> const<code> [virtual]</code></td>
390        </tr>
391      </table>
392</div>
393<div class="memdoc">
394
395<p>
396conditional version of the predictor
397<p>
398
399<p>
400&lt;----------- TODO
401<p>Reimplemented from <a class="el" href="classbdm_1_1BM.html#598b25e3f3d96a5bc00a5faeb5b3c912">bdm::BM</a>.</p>
402
403<p>References <a class="el" href="bdmbase_8h_source.html#l00323">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h_source.html#l00049">est</a>, <a class="el" href="square__mat_8h_source.html#l00095">sqmat::rows()</a>, <a class="el" href="exp__family_8h_source.html#l01261">bdm::mlnorm&lt; sq_T &gt;::set_parameters()</a>, and <a class="el" href="arx_8h_source.html#l00051">V</a>.</p>
404
405</div>
406</div><p>
407<a class="anchor" name="16b02ae03316751664c22d59d90c1e34"></a><!-- doxytag: member="bdm::ARX::structure_est" ref="16b02ae03316751664c22d59d90c1e34" args="(egiw Eg0)" -->
408<div class="memitem">
409<div class="memproto">
410      <table class="memname">
411        <tr>
412          <td class="memname">ivec bdm::ARX::structure_est           </td>
413          <td>(</td>
414          <td class="paramtype"><a class="el" href="classbdm_1_1egiw.html">egiw</a>&nbsp;</td>
415          <td class="paramname"> <em>Eg0</em>          </td>
416          <td>&nbsp;)&nbsp;</td>
417          <td></td>
418        </tr>
419      </table>
420</div>
421<div class="memdoc">
422
423<p>
424Brute force structure estimation.
425<p>
426<dl class="return" compact><dt><b>Returns:</b></dt><dd>indeces of accepted regressors. </dd></dl>
427
428<p>References <a class="el" href="bdmbase_8h_source.html#l00323">bdm::epdf::dimension()</a>, <a class="el" href="arx_8h_source.html#l00049">est</a>, and <a class="el" href="exp__family_8cpp_source.html#l00047">bdm::egiw::lognc()</a>.</p>
429
430</div>
431</div><p>
432<hr><h2>Member Data Documentation</h2>
433<a class="anchor" name="363aaa55b2ab3eec602510cdf53e84ef"></a><!-- doxytag: member="bdm::ARX::_yrv" ref="363aaa55b2ab3eec602510cdf53e84ef" args="" -->
434<div class="memitem">
435<div class="memproto">
436      <table class="memname">
437        <tr>
438          <td class="memname"><a class="el" href="classbdm_1_1RV.html">RV</a> <a class="el" href="classbdm_1_1ARX.html#363aaa55b2ab3eec602510cdf53e84ef">bdm::ARX::_yrv</a><code> [protected]</code>          </td>
439        </tr>
440      </table>
441</div>
442<div class="memdoc">
443
444<p>
445description of modelled data <img class="formulaInl" alt="$ y_t $" src="form_26.png"> in the likelihood function Do NOT access directly, only via <code>get_yrv()</code>.
446</div>
447</div><p>
448<hr>The documentation for this class was generated from the following files:<ul>
449<li><a class="el" href="arx_8h_source.html">arx.h</a><li>arx.cpp</ul>
450</div>
451<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:57 2009 for mixpp by&nbsp;
452<a href="http://www.doxygen.org/index.html">
453<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
454</body>
455</html>
Note: See TracBrowser for help on using the browser.