root/doc/html/classDS.html @ 255

Revision 234, 9.1 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: DS 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>DS Class Reference<br>
28<small>
29[<a class="el" href="group__core.html">Core BDM classes</a>]</small>
30</h1><!-- doxytag: class="DS" -->Abstract class for discrete-time sources of data. 
31<a href="#_details">More...</a>
32<p>
33<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
34<p>
35<div class="dynheader">
36Inheritance diagram for DS:</div>
37<div class="dynsection">
38<p><center><img src="classDS__inherit__graph.png" border="0" usemap="#DS__inherit__map" alt="Inheritance graph"></center>
39<map name="DS__inherit__map">
40<area shape="rect" href="classMemDS.html" title="Class representing off&#45;line data stored in memory." alt="" coords="5,81,72,105"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42<div class="dynheader">
43Collaboration diagram for DS:</div>
44<div class="dynsection">
45<p><center><img src="classDS__coll__graph.png" border="0" usemap="#DS__coll__map" alt="Collaboration graph"></center>
46<map name="DS__coll__map">
47<area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="7,6,44,30"></map>
48<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
49
50<p>
51<a href="classDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
52<tr><td></td></tr>
53<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db2dacc9e71a36eeb9c5c2ee402eeeb1"></a><!-- doxytag: member="DS::getdata" ref="db2dacc9e71a36eeb9c5c2ee402eeeb1" args="(vec &amp;dt)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#db2dacc9e71a36eeb9c5c2ee402eeeb1">getdata</a> (vec &amp;dt)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4027575bc66ea358f9b03dd3be28fe1e"></a><!-- doxytag: member="DS::getdata" ref="4027575bc66ea358f9b03dd3be28fe1e" args="(vec &amp;dt, ivec &amp;indeces)" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#4027575bc66ea358f9b03dd3be28fe1e">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0dfb6788b70c0d48a1f5276ed6c93039"></a><!-- doxytag: member="DS::write" ref="0dfb6788b70c0d48a1f5276ed6c93039" args="(vec &amp;ut)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#0dfb6788b70c0d48a1f5276ed6c93039">write</a> (vec &amp;ut)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4ae51a3bc1267a6a52fc229973afe85"></a><!-- doxytag: member="DS::write" ref="f4ae51a3bc1267a6a52fc229973afe85" args="(vec &amp;ut, ivec &amp;indeces)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#f4ae51a3bc1267a6a52fc229973afe85">write</a> (vec &amp;ut, ivec &amp;indeces)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#9a35ca9c9321dce2bf63bf668f785b75">linkrvs</a> (<a class="el" href="classRV.html">RV</a> &amp;drv, <a class="el" href="classRV.html">RV</a> &amp;urv)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.  <a href="#9a35ca9c9321dce2bf63bf668f785b75"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="470ba89e8e7c3c4d830803221b4e9be6"></a><!-- doxytag: member="DS::step" ref="470ba89e8e7c3c4d830803221b4e9be6" args="()" -->
74void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#470ba89e8e7c3c4d830803221b4e9be6">step</a> ()</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$t$" src="form_38.png"> to <img class="formulaInl" alt="$t+1$" src="form_39.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr>
77<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1012025a1a3a1fdd24aa48698a3d3454"></a><!-- doxytag: member="DS::Drv" ref="1012025a1a3a1fdd24aa48698a3d3454" args="" -->
79<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#1012025a1a3a1fdd24aa48698a3d3454">Drv</a></td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classDS.html#db2dacc9e71a36eeb9c5c2ee402eeeb1" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a88ffaeb3c7c2cf30c69bc41a000629"></a><!-- doxytag: member="DS::Urv" ref="0a88ffaeb3c7c2cf30c69bc41a000629" args="" -->
83<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDS.html#0a88ffaeb3c7c2cf30c69bc41a000629">Urv</a></td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classDS.html#0dfb6788b70c0d48a1f5276ed6c93039" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
86</table>
87<hr><a name="_details"></a><h2>Detailed Description</h2>
88Abstract class for discrete-time sources of data.
89<p>
90The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). <hr><h2>Member Function Documentation</h2>
91<a class="anchor" name="9a35ca9c9321dce2bf63bf668f785b75"></a><!-- doxytag: member="DS::linkrvs" ref="9a35ca9c9321dce2bf63bf668f785b75" args="(RV &amp;drv, RV &amp;urv)" -->
92<div class="memitem">
93<div class="memproto">
94      <table class="memname">
95        <tr>
96          <td class="memname">void DS::linkrvs           </td>
97          <td>(</td>
98          <td class="paramtype"><a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
99          <td class="paramname"> <em>drv</em>, </td>
100        </tr>
101        <tr>
102          <td class="paramkey"></td>
103          <td></td>
104          <td class="paramtype"><a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
105          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
106        </tr>
107        <tr>
108          <td></td>
109          <td>)</td>
110          <td></td><td></td><td></td>
111        </tr>
112      </table>
113</div>
114<div class="memdoc">
115
116<p>
117Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.
118<p>
119(Inherited from m3k, may be deprecated soon).
120<p>Reimplemented in <a class="el" href="classMemDS.html#5f72b555e0e4a61de1440c457cf57007">MemDS</a>.</p>
121
122</div>
123</div><p>
124<hr>The documentation for this class was generated from the following file:<ul>
125<li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
126</div>
127<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:50:53 2009 for mixpp by&nbsp;
128<a href="http://www.doxygen.org/index.html">
129<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
130</body>
131</html>
Note: See TracBrowser for help on using the browser.