root/doc/html/classMemDS.html @ 187

Revision 181, 10.0 kB (checked in by smidl, 16 years ago)

Regenerated 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: 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>MemDS Class Reference</h1><!-- doxytag: class="MemDS" --><!-- doxytag: inherits="DS" -->Class representing off-line data stored in memory. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for MemDS:</div>
33<div class="dynsection">
34<p><center><img src="classMemDS__inherit__graph.png" border="0" usemap="#MemDS__inherit__map" alt="Inheritance graph"></center>
35<map name="MemDS__inherit__map">
36<area shape="rect" href="classDS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="19,7,59,31"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for MemDS:</div>
40<div class="dynsection">
41<p><center><img src="classMemDS__coll__graph.png" border="0" usemap="#MemDS__coll__map" alt="Collaboration graph"></center>
42<map name="MemDS__coll__map">
43<area shape="rect" href="classDS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="19,111,59,135"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="20,7,57,31"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classMemDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23522b9e7dd0bb0c365cc9cde4c05449"></a><!-- doxytag: member="MemDS::getdata" ref="23522b9e7dd0bb0c365cc9cde4c05449" args="(vec &amp;dt)" -->
51void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#23522b9e7dd0bb0c365cc9cde4c05449">getdata</a> (vec &amp;dt)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="900f1e1c9eb950f87e557c068628e60e"></a><!-- doxytag: member="MemDS::getdata" ref="900f1e1c9eb950f87e557c068628e60e" args="(vec &amp;dt, ivec &amp;indeces)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#900f1e1c9eb950f87e557c068628e60e">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#5f72b555e0e4a61de1440c457cf57007">linkrvs</a> (<a class="el" href="classRV.html">RV</a> &amp;drv, <a class="el" href="classRV.html">RV</a> &amp;urv)</td></tr>
59
60<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="#5f72b555e0e4a61de1440c457cf57007"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b120ed178f7c848f1227c928d8a79be8"></a><!-- doxytag: member="MemDS::write" ref="b120ed178f7c848f1227c928d8a79be8" args="(vec &amp;ut)" -->
62void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#b120ed178f7c848f1227c928d8a79be8">write</a> (vec &amp;ut)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6279bf18d44343750747ecc12e050f09"></a><!-- doxytag: member="MemDS::write" ref="6279bf18d44343750747ecc12e050f09" args="(vec &amp;ut, ivec &amp;indexes)" -->
66void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#6279bf18d44343750747ecc12e050f09">write</a> (vec &amp;ut, ivec &amp;indexes)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="MemDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
70void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
71
72<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>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84cfba80cb32d07be94690658175e9c4"></a><!-- doxytag: member="MemDS::MemDS" ref="84cfba80cb32d07be94690658175e9c4" args="(mat &amp;Dat, ivec &amp;rowid, ivec &amp;delays)" -->
74&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemDS.html#84cfba80cb32d07be94690658175e9c4">MemDS</a> (mat &amp;Dat, ivec &amp;rowid, ivec &amp;delays)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <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="MemDS::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="MemDS::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>
88Class representing off-line data stored in memory.
89<p>
90The 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>
91The data can be loaded from a file. <hr><h2>Member Function Documentation</h2>
92<a class="anchor" name="5f72b555e0e4a61de1440c457cf57007"></a><!-- doxytag: member="MemDS::linkrvs" ref="5f72b555e0e4a61de1440c457cf57007" args="(RV &amp;drv, RV &amp;urv)" -->
93<div class="memitem">
94<div class="memproto">
95      <table class="memname">
96        <tr>
97          <td class="memname">void MemDS::linkrvs           </td>
98          <td>(</td>
99          <td class="paramtype"><a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
100          <td class="paramname"> <em>drv</em>, </td>
101        </tr>
102        <tr>
103          <td class="paramkey"></td>
104          <td></td>
105          <td class="paramtype"><a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
106          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
107        </tr>
108        <tr>
109          <td></td>
110          <td>)</td>
111          <td></td><td></td><td></td>
112        </tr>
113      </table>
114</div>
115<div class="memdoc">
116
117<p>
118Method 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.
119<p>
120(Inherited from m3k, may be deprecated soon).
121<p>Reimplemented from <a class="el" href="classDS.html#9a35ca9c9321dce2bf63bf668f785b75">DS</a>.</p>
122
123<p>References <a class="el" href="libBM_8h-source.html#l00072">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00287">DS::Drv</a>, and <a class="el" href="libBM_8h-source.html#l00289">DS::Urv</a>.</p>
124
125</div>
126</div><p>
127<hr>The documentation for this class was generated from the following files:<ul>
128<li>work/git/mixpp/bdm/stat/<a class="el" href="libDS_8h-source.html">libDS.h</a><li>work/git/mixpp/bdm/stat/libDS.cpp</ul>
129</div>
130<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:15 2008 for mixpp by&nbsp;
131<a href="http://www.doxygen.org/index.html">
132<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
133</body>
134</html>
Note: See TracBrowser for help on using the browser.