root/doc/html/classbdm_1_1MemDS.html @ 264

Revision 264, 11.8 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[259]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::MemDS 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>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[259]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[259]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>
[261]27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1MemDS.html">MemDS</a>
[259]28  </div>
29</div>
30<div class="contents">
[261]31<h1>bdm::MemDS Class Reference</h1><!-- doxytag: class="bdm::MemDS" --><!-- doxytag: inherits="bdm::DS" -->Memory storage of off-line data column-wise. 
[259]32<a href="#_details">More...</a>
33<p>
34<code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::MemDS:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1MemDS__inherit__graph.png" border="0" usemap="#bdm_1_1MemDS__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1MemDS__inherit__map">
[261]41<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>
[259]42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43<div class="dynheader">
44Collaboration diagram for bdm::MemDS:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1MemDS__coll__graph.png" border="0" usemap="#bdm_1_1MemDS__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1MemDS__coll__map">
[261]48<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="21,199,99,225"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="9,7,121,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="76,87,151,113"></map>
[259]49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
50
51<p>
52<a href="classbdm_1_1MemDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
53<tr><td></td></tr>
54<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23522b9e7dd0bb0c365cc9cde4c05449"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="23522b9e7dd0bb0c365cc9cde4c05449" args="(vec &amp;dt)" -->
56void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#23522b9e7dd0bb0c365cc9cde4c05449">getdata</a> (vec &amp;dt)</td></tr>
57
[264]58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
[261]59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62083e1db465a97a2a39fc682addc83d"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="62083e1db465a97a2a39fc682addc83d" args="(vec &amp;dt, const ivec &amp;indeces)" -->
60void&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>
[259]61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
[261]63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f72b555e0e4a61de1440c457cf57007"></a><!-- doxytag: member="bdm::MemDS::linkrvs" ref="5f72b555e0e4a61de1440c457cf57007" args="(RV &amp;drv, RV &amp;urv)" -->
64void&nbsp;</td><td class="memItemRight" valign="bottom"><b>linkrvs</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>
[259]65
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::MemDS::write" ref="9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9af4563d430d8a3f15aa03581e52ef0"></a><!-- doxytag: member="bdm::MemDS::write" ref="d9af4563d430d8a3f15aa03581e52ef0" args="(vec &amp;ut, ivec &amp;indexes)" -->
[261]71void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indexes)</td></tr>
[259]72
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::MemDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
74void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#21916feb3e5ff960855c09b06a0d279b">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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84cfba80cb32d07be94690658175e9c4"></a><!-- doxytag: member="bdm::MemDS::MemDS" ref="84cfba80cb32d07be94690658175e9c4" args="(mat &amp;Dat, ivec &amp;rowid, ivec &amp;delays)" -->
78&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#84cfba80cb32d07be94690658175e9c4">MemDS</a> (mat &amp;Dat, ivec &amp;rowid, ivec &amp;delays)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
[261]81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::MemDS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
82virtual 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>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
[264]85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c9e417d85052396fe74c164857ee67e"></a><!-- doxytag: member="bdm::MemDS::log_add" ref="3c9e417d85052396fe74c164857ee67e" args="(logger &amp;L)" -->
86virtual 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>
87
88<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="DataLink is a connection between two data vectors Up and Down.">logger</a> L. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e03d2c93cddd5c3a03107ddd3ae999cf"></a><!-- doxytag: member="bdm::MemDS::logit" ref="e03d2c93cddd5c3a03107ddd3ae999cf" args="(logger &amp;L)" -->
90virtual 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>
91
92<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="DataLink is a connection between two data vectors Up and Down.">logger</a> L. <br></td></tr>
[259]93<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::MemDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
95<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>
96
[264]97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, 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>
[259]98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::MemDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
99<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>
100
[261]101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted 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]102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::MemDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
103int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::MemDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
107int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
108
[259]109</table>
110<hr><a name="_details"></a><h2>Detailed Description</h2>
[261]111Memory storage of off-line data column-wise.
[259]112<p>
113The 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_38.png">. Access to this matrix is via indexes <code>rowid</code> and <code>delays</code>.<p>
[261]114The data can be loaded from a file. <hr>The documentation for this class was generated from the following files:<ul>
115<li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul>
[259]116</div>
[264]117<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 19:50:12 2009 for mixpp by&nbsp;
[259]118<a href="http://www.doxygen.org/index.html">
119<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
120</body>
121</html>
Note: See TracBrowser for help on using the browser.