root/doc/html/classbdm_1_1ArxDS.html @ 324

Revision 323, 18.5 kB (checked in by smidl, 16 years ago)

doc

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::ArxDS 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.8 -->
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><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1ArxDS.html">ArxDS</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::ArxDS Class Reference</h1><!-- doxytag: class="bdm::ArxDS" --><!-- doxytag: inherits="bdm::DS" -->Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1ArxDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db242e35812c311c8415bb7e31c3f595"></a><!-- doxytag: member="bdm::ArxDS::getdata" ref="db242e35812c311c8415bb7e31c3f595" args="(vec &amp;dt)" -->
82void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#db242e35812c311c8415bb7e31c3f595">getdata</a> (vec &amp;dt)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="701151418bc5fc3861acef8359fb0d80"></a><!-- doxytag: member="bdm::ArxDS::getdata" ref="701151418bc5fc3861acef8359fb0d80" args="(vec &amp;dt, const ivec &amp;indices)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#701151418bc5fc3861acef8359fb0d80">getdata</a> (vec &amp;dt, const ivec &amp;indices)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f6da8a00abba70bc58c7a4030bd8940"></a><!-- doxytag: member="bdm::ArxDS::write" ref="8f6da8a00abba70bc58c7a4030bd8940" args="(vec &amp;ut)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#8f6da8a00abba70bc58c7a4030bd8940">write</a> (vec &amp;ut)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="477fd706639535f520e9dbbd19f73318"></a><!-- doxytag: member="bdm::ArxDS::write" ref="477fd706639535f520e9dbbd19f73318" args="(vec &amp;ut, const ivec &amp;indices)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#477fd706639535f520e9dbbd19f73318">write</a> (vec &amp;ut, const ivec &amp;indices)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57dfa26b23cc03d53b123fa7e0474b19"></a><!-- doxytag: member="bdm::ArxDS::step" ref="57dfa26b23cc03d53b123fa7e0474b19" args="()" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#57dfa26b23cc03d53b123fa7e0474b19">step</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_51.png"> to <img class="formulaInl" alt="$ t+1 $" src="form_52.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c8b418677a48041adacac8e8e9c9849"></a><!-- doxytag: member="bdm::ArxDS::ArxDS" ref="7c8b418677a48041adacac8e8e9c9849" args="()" -->
102&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#7c8b418677a48041adacac8e8e9c9849">ArxDS</a> ()</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d9abc62f1fee862f0e1c60c5c4a3c8a"></a><!-- doxytag: member="bdm::ArxDS::set_parameters" ref="2d9abc62f1fee862f0e1c60c5c4a3c8a" args="(const mat &amp;Th0, const vec mu0, const chmat &amp;sqR0)" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#2d9abc62f1fee862f0e1c60c5c4a3c8a">set_parameters</a> (const mat &amp;Th0, const vec mu0, const <a class="el" href="classchmat.html">chmat</a> &amp;sqR0)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set parameters of the internal model, H is maximum time delay. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf9cd9d4043d7e0dc61de56db37ec703"></a><!-- doxytag: member="bdm::ArxDS::set_drv" ref="bf9cd9d4043d7e0dc61de56db37ec703" args="(RV &amp;yrv, RV &amp;urv, RV &amp;rrv)" -->
110void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#bf9cd9d4043d7e0dc61de56db37ec703">set_drv</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;yrv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rrv)</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7438127de87c5a8128edfa12255b436"></a><!-- doxytag: member="bdm::ArxDS::set_options" ref="e7438127de87c5a8128edfa12255b436" args="(const string &amp;s)" -->
114void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#e7438127de87c5a8128edfa12255b436">set_options</a> (const string &amp;s)</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set options from a string <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64819633a1191fcaa60d0de26ade2e52"></a><!-- doxytag: member="bdm::ArxDS::log_add" ref="64819633a1191fcaa60d0de26ade2e52" args="(logger &amp;L)" -->
118virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#64819633a1191fcaa60d0de26ade2e52">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4128f5dc3a04063d62fc7e35635aeb90"></a><!-- doxytag: member="bdm::ArxDS::logit" ref="4128f5dc3a04063d62fc7e35635aeb90" args="(logger &amp;L)" -->
122virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#4128f5dc3a04063d62fc7e35635aeb90">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
126virtual <a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::ArxDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
130const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
133<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7b3cc6cd059ff3d7f4462cedff4bdeb"></a><!-- doxytag: member="bdm::ArxDS::Rrv" ref="c7b3cc6cd059ff3d7f4462cedff4bdeb" args="" -->
135<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#c7b3cc6cd059ff3d7f4462cedff4bdeb">Rrv</a></td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rv of the regressor. <br></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11a3f3fbeea1d17b66b073017964597"></a><!-- doxytag: member="bdm::ArxDS::H" ref="a11a3f3fbeea1d17b66b073017964597" args="" -->
139vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a11a3f3fbeea1d17b66b073017964597">H</a></td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">History, ordered as <img class="formulaInl" alt="$[y_t, u_t, y_{t-1 }, u_{t-1}, \ldots]$" src="form_56.png">. <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="392b87be85675cb3d55fa4953d671bb5"></a><!-- doxytag: member="bdm::ArxDS::U" ref="392b87be85675cb3d55fa4953d671bb5" args="" -->
143vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#392b87be85675cb3d55fa4953d671bb5">U</a></td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(future) input <br></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2d7530264499b92c3aa32454b960abe"></a><!-- doxytag: member="bdm::ArxDS::rgr" ref="b2d7530264499b92c3aa32454b960abe" args="" -->
147vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#b2d7530264499b92c3aa32454b960abe">rgr</a></td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">temporary variable for regressor <br></td></tr>
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbe7b993ec5f75c195ae1b2ccd96a898"></a><!-- doxytag: member="bdm::ArxDS::rgrlnk" ref="fbe7b993ec5f75c195ae1b2ccd96a898" args="" -->
151<a class="el" href="classbdm_1_1datalink.html">datalink</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#fbe7b993ec5f75c195ae1b2ccd96a898">rgrlnk</a></td></tr>
152
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">data link: H -&gt; rgr <br></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aa9d8d35792159dc9611802f6c190eb"></a><!-- doxytag: member="bdm::ArxDS::model" ref="0aa9d8d35792159dc9611802f6c190eb" args="" -->
155<a class="el" href="classbdm_1_1mlnorm.html">mlnorm</a>&lt; <a class="el" href="classchmat.html">chmat</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#0aa9d8d35792159dc9611802f6c190eb">model</a></td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">model of Y - linear Gaussian <br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="064e5d3f2dc0b39459c7ca53d05223e1"></a><!-- doxytag: member="bdm::ArxDS::opt_L_theta" ref="064e5d3f2dc0b39459c7ca53d05223e1" args="" -->
159bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#064e5d3f2dc0b39459c7ca53d05223e1">opt_L_theta</a></td></tr>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">options <br></td></tr>
162<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e13e5ffdfe9d896089310b0fc54e0c85"></a><!-- doxytag: member="bdm::ArxDS::L_theta" ref="e13e5ffdfe9d896089310b0fc54e0c85" args="" -->
163int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#e13e5ffdfe9d896089310b0fc54e0c85">L_theta</a></td></tr>
164
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">loggers <br></td></tr>
166<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81a70c39cbd429fcc8130a35b368346c"></a><!-- doxytag: member="bdm::ArxDS::L_R" ref="81a70c39cbd429fcc8130a35b368346c" args="" -->
167int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_R</b></td></tr>
168
169<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ef18dad16bf2b66bd3e9c8d233e62d8"></a><!-- doxytag: member="bdm::ArxDS::dt_size" ref="9ef18dad16bf2b66bd3e9c8d233e62d8" args="" -->
170int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dt_size</b></td></tr>
171
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::ArxDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
173int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
174
175<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::ArxDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
176int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
177
178<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::ArxDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
179<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
180
181<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br></td></tr>
182<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::ArxDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
183<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
184
185<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
186<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::ArxDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
187int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
188
189<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
190<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::ArxDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
191int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
192
193</table>
194<hr><a name="_details"></a><h2>Detailed Description</h2>
195Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <hr>The documentation for this class was generated from the following files:<ul>
196<li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul>
197</div>
198<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:46 2009 for mixpp by&nbsp;
199<a href="http://www.doxygen.org/index.html">
200<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
201</body>
202</html>
Note: See TracBrowser for help on using the browser.