root/library/doc/html/classbdm_1_1MexDS.html @ 461

Revision 401, 16.7 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::MexDS 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_1MexDS.html">MexDS</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::MexDS Class Reference</h1><!-- doxytag: class="bdm::MexDS" --><!-- doxytag: inherits="bdm::MemDS" -->Memory storage of off-line data column-wise. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="mex__datasource_8h-source.html">mex_datasource.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1MexDS-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="23522b9e7dd0bb0c365cc9cde4c05449"></a><!-- doxytag: member="bdm::MexDS::getdata" ref="23522b9e7dd0bb0c365cc9cde4c05449" args="(vec &amp;dt)" -->
82void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#23522b9e7dd0bb0c365cc9cde4c05449">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="62083e1db465a97a2a39fc682addc83d"></a><!-- doxytag: member="bdm::MexDS::getdata" ref="62083e1db465a97a2a39fc682addc83d" args="(vec &amp;dt, const ivec &amp;indeces)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#62083e1db465a97a2a39fc682addc83d">getdata</a> (vec &amp;dt, const ivec &amp;indeces)</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="e6428f2778254e8304fb5a799b7f815a"></a><!-- doxytag: member="bdm::MexDS::set_rvs" ref="e6428f2778254e8304fb5a799b7f815a" args="(RV &amp;drv, RV &amp;urv)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvs</b> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::MexDS::write" ref="9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4349a043d00fd82c8d5f5c39673787e5"></a><!-- doxytag: member="bdm::MexDS::write" ref="4349a043d00fd82c8d5f5c39673787e5" args="(vec &amp;ut, ivec &amp;indices)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indices)</td></tr>
98
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::MexDS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
100virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::MexDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
104void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_12.png"> to <img class="formulaInl" alt="$ t+1 $" src="form_13.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::MexDS::log_add" ref="3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
108virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#3c9e417d85052396fe74c164857ee67e">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
109
110<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>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::MexDS::logit" ref="e03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
112virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#e03d2c93cddd5c3a03107ddd3ae999cf">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
113
114<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>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::MexDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
116virtual <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>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::MexDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
120const <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>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="821297dfd839d68691324f024e57252f"></a><!-- doxytag: member="bdm::MexDS::set_drv" ref="821297dfd839d68691324f024e57252f" args="(const RV &amp;drv, const RV &amp;urv)" -->
124virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#821297dfd839d68691324f024e57252f">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br></td></tr>
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::MexDS::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
128virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::MexDS::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
132virtual 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>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::MexDS::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
136virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
139<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a724f4cbfc32e79bacc044253234e260"></a><!-- doxytag: member="bdm::MexDS::Data" ref="a724f4cbfc32e79bacc044253234e260" args="" -->
141mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a724f4cbfc32e79bacc044253234e260">Data</a></td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal matrix of data <br></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="681ee3831f68f4f20ed54e04e8b3f107"></a><!-- doxytag: member="bdm::MexDS::time" ref="681ee3831f68f4f20ed54e04e8b3f107" args="" -->
145int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#681ee3831f68f4f20ed54e04e8b3f107">time</a></td></tr>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active column in the Data matrix <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="865814d49913dcf672bb20a4334d3dc4"></a><!-- doxytag: member="bdm::MexDS::rowid" ref="865814d49913dcf672bb20a4334d3dc4" args="" -->
149ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="166522aed4d3b12d9b3c2afaf6673301"></a><!-- doxytag: member="bdm::MexDS::delays" ref="166522aed4d3b12d9b3c2afaf6673301" args="" -->
153ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#166522aed4d3b12d9b3c2afaf6673301">delays</a></td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of delays that are presented in Dt <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::MexDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
158
159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::MexDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
160int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
161
162<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::MexDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
163<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>
164
165<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>
166<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::MexDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
167<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>
168
169<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>
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::MexDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
171int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
172
173<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
174<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::MexDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
175int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
176
177</table>
178<hr><a name="_details"></a><h2>Detailed Description</h2>
179Memory storage of off-line data column-wise.
180<p>
181The data are stored in an internal matrix <code>Data</code> . Each column of Data corresponds to one discrete time observation <img class="formulaInl" alt="$t$" src="form_15.png">. Access to this matrix is via indices <code>rowid</code> and <code>delays</code>.<p>
182The data can be loaded from a file. <hr>The documentation for this class was generated from the following file:<ul>
183<li><a class="el" href="mex__datasource_8h-source.html">mex_datasource.h</a></ul>
184</div>
185<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by&nbsp;
186<a href="http://www.doxygen.org/index.html">
187<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
188</body>
189</html>
Note: See TracBrowser for help on using the browser.