root/doc/html/classbdm_1_1ArxDS.html @ 270

Revision 270, 17.3 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

RevLine 
[261]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="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1ArxDS.html">ArxDS</a>
28  </div>
29</div>
30<div class="contents">
[270]31<h1>bdm::ArxDS Class Reference</h1><!-- doxytag: class="bdm::ArxDS" --><!-- doxytag: inherits="bdm::DS" --><code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
[261]32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::ArxDS:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1ArxDS__inherit__graph.png" border="0" usemap="#bdm_1_1ArxDS__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1ArxDS__inherit__map">
38<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
[270]42<a href="classbdm_1_1ArxDS-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <table border="0" cellpadding="0" cellspacing="0">
[261]44<tr><td></td></tr>
45<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
46<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)" -->
47void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#db242e35812c311c8415bb7e31c3f595">getdata</a> (vec &amp;dt)</td></tr>
48
[264]49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
[261]50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd61140869637b91bc23215ab7f45d3b"></a><!-- doxytag: member="bdm::ArxDS::getdata" ref="fd61140869637b91bc23215ab7f45d3b" args="(vec &amp;dt, const ivec &amp;indexes)" -->
51void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#fd61140869637b91bc23215ab7f45d3b">getdata</a> (vec &amp;dt, const ivec &amp;indexes)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
54<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)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#8f6da8a00abba70bc58c7a4030bd8940">write</a> (vec &amp;ut)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7240ea989a6453e58468feea319dcf0b"></a><!-- doxytag: member="bdm::ArxDS::write" ref="7240ea989a6453e58468feea319dcf0b" args="(vec &amp;ut, const ivec &amp;indexes)" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#7240ea989a6453e58468feea319dcf0b">write</a> (vec &amp;ut, const ivec &amp;indexes)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57dfa26b23cc03d53b123fa7e0474b19"></a><!-- doxytag: member="bdm::ArxDS::step" ref="57dfa26b23cc03d53b123fa7e0474b19" args="()" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#57dfa26b23cc03d53b123fa7e0474b19">step</a> ()</td></tr>
64
[270]65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_110.png"> to <img class="formulaInl" alt="$ t+1 $" src="form_111.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c8b418677a48041adacac8e8e9c9849"></a><!-- doxytag: member="bdm::ArxDS::ArxDS" ref="7c8b418677a48041adacac8e8e9c9849" args="()" -->
67&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#7c8b418677a48041adacac8e8e9c9849">ArxDS</a> ()</td></tr>
[261]68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
70<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)" -->
71void&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>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set parameters of the internal model. <br></td></tr>
[269]74<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)" -->
75void&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>
[264]76
[269]77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set options from a string <br></td></tr>
78<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)" -->
79virtual 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>
[264]80
[269]81<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>
82<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)" -->
83virtual 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>
84
85<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>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
87virtual <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>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::ArxDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
91const <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>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[261]94<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
[269]95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7b3cc6cd059ff3d7f4462cedff4bdeb"></a><!-- doxytag: member="bdm::ArxDS::Rrv" ref="c7b3cc6cd059ff3d7f4462cedff4bdeb" args="" -->
96<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>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rv of the regressor. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d910dcb5d0c1132f1cffad2c91348b3f"></a><!-- doxytag: member="bdm::ArxDS::Hrv" ref="d910dcb5d0c1132f1cffad2c91348b3f" args="" -->
100<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#d910dcb5d0c1132f1cffad2c91348b3f">Hrv</a></td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rv of the history (full regressor). <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11a3f3fbeea1d17b66b073017964597"></a><!-- doxytag: member="bdm::ArxDS::H" ref="a11a3f3fbeea1d17b66b073017964597" args="" -->
104vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a11a3f3fbeea1d17b66b073017964597">H</a></td></tr>
105
106<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_103.png">. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="392b87be85675cb3d55fa4953d671bb5"></a><!-- doxytag: member="bdm::ArxDS::U" ref="392b87be85675cb3d55fa4953d671bb5" args="" -->
108vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#392b87be85675cb3d55fa4953d671bb5">U</a></td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(future) input <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2d7530264499b92c3aa32454b960abe"></a><!-- doxytag: member="bdm::ArxDS::rgr" ref="b2d7530264499b92c3aa32454b960abe" args="" -->
112vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#b2d7530264499b92c3aa32454b960abe">rgr</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">temporary variable for regressor <br></td></tr>
[270]115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d30d78ba1f16d66267ab8fc2c9cfb5d"></a><!-- doxytag: member="bdm::ArxDS::rgrlnk" ref="2d30d78ba1f16d66267ab8fc2c9cfb5d" args="" -->
116<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#2d30d78ba1f16d66267ab8fc2c9cfb5d">rgrlnk</a></td></tr>
[269]117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">data link: H -&gt; rgr <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aa9d8d35792159dc9611802f6c190eb"></a><!-- doxytag: member="bdm::ArxDS::model" ref="0aa9d8d35792159dc9611802f6c190eb" args="" -->
120<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>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">model of Y - linear Gaussian <br></td></tr>
123<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="" -->
124bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#064e5d3f2dc0b39459c7ca53d05223e1">opt_L_theta</a></td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">options <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e13e5ffdfe9d896089310b0fc54e0c85"></a><!-- doxytag: member="bdm::ArxDS::L_theta" ref="e13e5ffdfe9d896089310b0fc54e0c85" args="" -->
128int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#e13e5ffdfe9d896089310b0fc54e0c85">L_theta</a></td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">loggers <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81a70c39cbd429fcc8130a35b368346c"></a><!-- doxytag: member="bdm::ArxDS::L_R" ref="81a70c39cbd429fcc8130a35b368346c" args="" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_R</b></td></tr>
133
[270]134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::ArxDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
135int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
136
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::ArxDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
138int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
139
[261]140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::ArxDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
141<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>
142
[270]143<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>
[261]144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::ArxDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
145<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>
146
[270]147<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>
[264]148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::ArxDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
149int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::ArxDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
153int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
154
[261]155</table>
[270]156<hr>The documentation for this class was generated from the following files:<ul>
[261]157<li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul>
158</div>
[270]159<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:05 2009 for mixpp by&nbsp;
[261]160<a href="http://www.doxygen.org/index.html">
161<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
162</body>
163</html>
Note: See TracBrowser for help on using the browser.