root/doc/html/classbdm_1_1MemDS.html @ 259

Revision 259, 10.5 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::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>
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 class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1MemDS.html">MemDS</a>
26  </div>
27</div>
28<div class="contents">
29<h1>bdm::MemDS Class Reference</h1><!-- doxytag: class="bdm::MemDS" --><!-- doxytag: inherits="bdm::DS" -->Class representing off-line data stored in memory. 
30<a href="#_details">More...</a>
31<p>
32<code>#include &lt;<a class="el" href="libDS_8h-source.html">libDS.h</a>&gt;</code>
33<p>
34<div class="dynheader">
35Inheritance diagram for bdm::MemDS:</div>
36<div class="dynsection">
37<p><center><img src="classbdm_1_1MemDS__inherit__graph.png" border="0" usemap="#bdm_1_1MemDS__inherit__map" alt="Inheritance graph"></center>
38<map name="bdm_1_1MemDS__inherit__map">
39<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="21,7,99,33"></map>
40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41<div class="dynheader">
42Collaboration diagram for bdm::MemDS:</div>
43<div class="dynsection">
44<p><center><img src="classbdm_1_1MemDS__coll__graph.png" border="0" usemap="#bdm_1_1MemDS__coll__map" alt="Collaboration graph"></center>
45<map name="bdm_1_1MemDS__coll__map">
46<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_1RV.html" title="Class representing variables, most often random variables." alt="" coords="23,87,97,113"><area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="16,7,104,33"></map>
47<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
48
49<p>
50<a href="classbdm_1_1MemDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
51<tr><td></td></tr>
52<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
53<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)" -->
54void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#23522b9e7dd0bb0c365cc9cde4c05449">getdata</a> (vec &amp;dt)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="900f1e1c9eb950f87e557c068628e60e"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="900f1e1c9eb950f87e557c068628e60e" args="(vec &amp;dt, ivec &amp;indeces)" -->
58void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#900f1e1c9eb950f87e557c068628e60e">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#5f72b555e0e4a61de1440c457cf57007">linkrvs</a> (<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>
62
63<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>
64<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)" -->
65void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
68<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)" -->
69void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#d9af4563d430d8a3f15aa03581e52ef0">write</a> (vec &amp;ut, ivec &amp;indexes)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::MemDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
73void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
74
75<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>
76<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)" -->
77&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>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
80<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::MemDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
82<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>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#cbffe794e02eb88b5856b83119b7c23c" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::MemDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
86<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>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classbdm_1_1DS.html#653a30e5bb76fb231429dae52216c851" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr>
89</table>
90<hr><a name="_details"></a><h2>Detailed Description</h2>
91Class representing off-line data stored in memory.
92<p>
93The 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>
94The data can be loaded from a file. <hr><h2>Member Function Documentation</h2>
95<a class="anchor" name="5f72b555e0e4a61de1440c457cf57007"></a><!-- doxytag: member="bdm::MemDS::linkrvs" ref="5f72b555e0e4a61de1440c457cf57007" args="(RV &amp;drv, RV &amp;urv)" -->
96<div class="memitem">
97<div class="memproto">
98      <table class="memname">
99        <tr>
100          <td class="memname">void MemDS::linkrvs           </td>
101          <td>(</td>
102          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
103          <td class="paramname"> <em>drv</em>, </td>
104        </tr>
105        <tr>
106          <td class="paramkey"></td>
107          <td></td>
108          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
109          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
110        </tr>
111        <tr>
112          <td></td>
113          <td>)</td>
114          <td></td><td></td><td></td>
115        </tr>
116      </table>
117</div>
118<div class="memdoc">
119
120<p>
121Method 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.
122<p>
123(Inherited from m3k, may be deprecated soon).
124<p>Reimplemented from <a class="el" href="classbdm_1_1DS.html#edd136e9046c08ac615cbe3c741de21e">bdm::DS</a>.</p>
125
126<p>References <a class="el" href="libBM_8h-source.html#l00081">bdm::RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00386">bdm::DS::Drv</a>, and <a class="el" href="libBM_8h-source.html#l00388">bdm::DS::Urv</a>.</p>
127
128</div>
129</div><p>
130<hr>The documentation for this class was generated from the following files:<ul>
131<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>
132</div>
133<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:31:27 2009 for mixpp by&nbsp;
134<a href="http://www.doxygen.org/index.html">
135<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
136</body>
137</html>
Note: See TracBrowser for help on using the browser.