root/doc/xml/classMemDS.xml @ 234

Revision 187, 15.9 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classMemDS" kind="class" prot="public">
4    <compoundname>MemDS</compoundname>
5    <basecompoundref refid="classDS" prot="public" virt="non-virtual">DS</basecompoundref>
6    <includes refid="libDS_8h" local="no">libDS.h</includes>
7      <sectiondef kind="private-attrib">
8      <memberdef kind="variable" id="classMemDS_1ab45b03f3e154479fdea3cb02d5f8810" prot="private" static="no" mutable="no">
9        <type>mat</type>
10        <definition>mat MemDS::Data</definition>
11        <argsstring></argsstring>
12        <name>Data</name>
13        <briefdescription>
14        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="29" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="29" bodyend="-1"/>
20      </memberdef>
21      <memberdef kind="variable" id="classMemDS_16c755a9befd9a9dcd91cad11073ba8a0" prot="private" static="no" mutable="no">
22        <type>int</type>
23        <definition>int MemDS::time</definition>
24        <argsstring></argsstring>
25        <name>time</name>
26        <briefdescription>
27        </briefdescription>
28        <detaileddescription>
29        </detaileddescription>
30        <inbodydescription>
31        </inbodydescription>
32        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="30" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="30" bodyend="-1"/>
33      </memberdef>
34      <memberdef kind="variable" id="classMemDS_113e303d38a1d5e939b1f02e1f1591608" prot="private" static="no" mutable="no">
35        <type>ivec</type>
36        <definition>ivec MemDS::rowid</definition>
37        <argsstring></argsstring>
38        <name>rowid</name>
39        <briefdescription>
40        </briefdescription>
41        <detaileddescription>
42        </detaileddescription>
43        <inbodydescription>
44        </inbodydescription>
45        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="31" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="31" bodyend="-1"/>
46      </memberdef>
47      <memberdef kind="variable" id="classMemDS_1862d2f8512990e0a7a28ef2b2dee7bd0" prot="private" static="no" mutable="no">
48        <type>ivec</type>
49        <definition>ivec MemDS::delays</definition>
50        <argsstring></argsstring>
51        <name>delays</name>
52        <briefdescription>
53        </briefdescription>
54        <detaileddescription>
55        </detaileddescription>
56        <inbodydescription>
57        </inbodydescription>
58        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="32" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="32" bodyend="-1"/>
59      </memberdef>
60      </sectiondef>
61      <sectiondef kind="public-func">
62      <memberdef kind="function" id="classMemDS_123522b9e7dd0bb0c365cc9cde4c05449" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
63        <type>void</type>
64        <definition>void MemDS::getdata</definition>
65        <argsstring>(vec &amp;dt)</argsstring>
66        <name>getdata</name>
67        <reimplements refid="classDS_1db2dacc9e71a36eeb9c5c2ee402eeeb1">getdata</reimplements>
68        <param>
69          <type>vec &amp;</type>
70          <declname>dt</declname>
71        </param>
72        <briefdescription>
73<para>Returns full vector of observed data. </para>        </briefdescription>
74        <detaileddescription>
75        </detaileddescription>
76        <inbodydescription>
77        </inbodydescription>
78        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="35" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.cpp" bodystart="6" bodyend="13"/>
79      </memberdef>
80      <memberdef kind="function" id="classMemDS_1900f1e1c9eb950f87e557c068628e60e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
81        <type>void</type>
82        <definition>void MemDS::getdata</definition>
83        <argsstring>(vec &amp;dt, ivec &amp;indeces)</argsstring>
84        <name>getdata</name>
85        <reimplements refid="classDS_14027575bc66ea358f9b03dd3be28fe1e">getdata</reimplements>
86        <param>
87          <type>vec &amp;</type>
88          <declname>dt</declname>
89        </param>
90        <param>
91          <type>ivec &amp;</type>
92          <declname>indeces</declname>
93        </param>
94        <briefdescription>
95<para>Returns data records at indeces. </para>        </briefdescription>
96        <detaileddescription>
97        </detaileddescription>
98        <inbodydescription>
99        </inbodydescription>
100        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="36" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.cpp" bodystart="15" bodyend="22"/>
101      </memberdef>
102      <memberdef kind="function" id="classMemDS_15f72b555e0e4a61de1440c457cf57007" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
103        <type>void</type>
104        <definition>void MemDS::linkrvs</definition>
105        <argsstring>(RV &amp;drv, RV &amp;urv)</argsstring>
106        <name>linkrvs</name>
107        <reimplements refid="classDS_19a35ca9c9321dce2bf63bf668f785b75">linkrvs</reimplements>
108        <param>
109          <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
110          <declname>drv</declname>
111        </param>
112        <param>
113          <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
114          <declname>urv</declname>
115        </param>
116        <briefdescription>
117<para>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. </para>        </briefdescription>
118        <detaileddescription>
119<para>(Inherited from m3k, may be deprecated soon). </para>        </detaileddescription>
120        <inbodydescription>
121        </inbodydescription>
122        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="37" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.cpp" bodystart="28" bodyend="34"/>
123        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
124        <references refid="classDS_11012025a1a3a1fdd24aa48698a3d3454" compoundref="libBM_8h" startline="233">DS::Drv</references>
125        <references refid="classDS_10a88ffaeb3c7c2cf30c69bc41a000629" compoundref="libBM_8h" startline="235">DS::Urv</references>
126      </memberdef>
127      <memberdef kind="function" id="classMemDS_1b120ed178f7c848f1227c928d8a79be8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
128        <type>void</type>
129        <definition>void MemDS::write</definition>
130        <argsstring>(vec &amp;ut)</argsstring>
131        <name>write</name>
132        <reimplements refid="classDS_10dfb6788b70c0d48a1f5276ed6c93039">write</reimplements>
133        <param>
134          <type>vec &amp;</type>
135          <declname>ut</declname>
136        </param>
137        <briefdescription>
138<para>Accepts action variable and schedule it for application. </para>        </briefdescription>
139        <detaileddescription>
140        </detaileddescription>
141        <inbodydescription>
142        </inbodydescription>
143        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="38" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="38" bodyend="38"/>
144      </memberdef>
145      <memberdef kind="function" id="classMemDS_16279bf18d44343750747ecc12e050f09" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
146        <type>void</type>
147        <definition>void MemDS::write</definition>
148        <argsstring>(vec &amp;ut, ivec &amp;indexes)</argsstring>
149        <name>write</name>
150        <reimplements refid="classDS_1f4ae51a3bc1267a6a52fc229973afe85">write</reimplements>
151        <param>
152          <type>vec &amp;</type>
153          <declname>ut</declname>
154        </param>
155        <param>
156          <type>ivec &amp;</type>
157          <declname>indeces</declname>
158        </param>
159        <briefdescription>
160<para>Accepts action variables at specific indeces. </para>        </briefdescription>
161        <detaileddescription>
162        </detaileddescription>
163        <inbodydescription>
164        </inbodydescription>
165        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="39" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="39" bodyend="39"/>
166      </memberdef>
167      <memberdef kind="function" id="classMemDS_121916feb3e5ff960855c09b06a0d279b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
168        <type>void</type>
169        <definition>void MemDS::step</definition>
170        <argsstring>()</argsstring>
171        <name>step</name>
172        <reimplements refid="classDS_1470ba89e8e7c3c4d830803221b4e9be6">step</reimplements>
173        <briefdescription>
174<para>Moves from <formula id="38">$t$</formula> to <formula id="39">$t+1$</formula>, i.e. perfroms the actions and reads response of the system. </para>        </briefdescription>
175        <detaileddescription>
176        </detaileddescription>
177        <inbodydescription>
178        </inbodydescription>
179        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="40" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.cpp" bodystart="24" bodyend="26"/>
180      </memberdef>
181      <memberdef kind="function" id="classMemDS_184cfba80cb32d07be94690658175e9c4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
182        <type></type>
183        <definition>MemDS::MemDS</definition>
184        <argsstring>(mat &amp;Dat, ivec &amp;rowid, ivec &amp;delays)</argsstring>
185        <name>MemDS</name>
186        <param>
187          <type>mat &amp;</type>
188          <declname>Dat</declname>
189        </param>
190        <param>
191          <type>ivec &amp;</type>
192          <declname>rowid</declname>
193        </param>
194        <param>
195          <type>ivec &amp;</type>
196          <declname>delays</declname>
197        </param>
198        <briefdescription>
199<para>Default constructor. </para>        </briefdescription>
200        <detaileddescription>
201        </detaileddescription>
202        <inbodydescription>
203        </inbodydescription>
204        <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="42" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.cpp" bodystart="36" bodyend="42"/>
205      </memberdef>
206      </sectiondef>
207      <sectiondef kind="protected-attrib">
208      <memberdef kind="variable" id="classDS_11012025a1a3a1fdd24aa48698a3d3454" prot="protected" static="no" mutable="no">
209        <type><ref refid="classRV" kindref="compound">RV</ref></type>
210        <definition>RV DS::Drv</definition>
211        <argsstring></argsstring>
212        <name>Drv</name>
213        <briefdescription>
214<para>Observed variables, returned by <computeroutput><ref refid="classDS_1db2dacc9e71a36eeb9c5c2ee402eeeb1" kindref="member">getdata()</ref></computeroutput>. </para>        </briefdescription>
215        <detaileddescription>
216        </detaileddescription>
217        <inbodydescription>
218        </inbodydescription>
219        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="233" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="233" bodyend="-1"/>
220        <referencedby refid="classMemDS_15f72b555e0e4a61de1440c457cf57007" compoundref="libDS_8cpp" startline="28" endline="34">linkrvs</referencedby>
221      </memberdef>
222      <memberdef kind="variable" id="classDS_10a88ffaeb3c7c2cf30c69bc41a000629" prot="protected" static="no" mutable="no">
223        <type><ref refid="classRV" kindref="compound">RV</ref></type>
224        <definition>RV DS::Urv</definition>
225        <argsstring></argsstring>
226        <name>Urv</name>
227        <briefdescription>
228<para>Action variables, accepted by <computeroutput><ref refid="classDS_10dfb6788b70c0d48a1f5276ed6c93039" kindref="member">write()</ref></computeroutput>. </para>        </briefdescription>
229        <detaileddescription>
230        </detaileddescription>
231        <inbodydescription>
232        </inbodydescription>
233        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="235" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="235" bodyend="-1"/>
234        <referencedby refid="classMemDS_15f72b555e0e4a61de1440c457cf57007" compoundref="libDS_8cpp" startline="28" endline="34">linkrvs</referencedby>
235      </memberdef>
236      </sectiondef>
237    <briefdescription>
238<para>Class representing off-line data stored in memory. </para>    </briefdescription>
239    <detaileddescription>
240<para>The data are stored in an internal matrix <computeroutput>Data</computeroutput> . Each column of Data corresponds to one discrete time observation <formula id="38">$t$</formula>. Access to this matrix is via indexes <computeroutput>rowid</computeroutput> and <computeroutput>delays</computeroutput>.</para><para>The data can be loaded from a file. </para>    </detaileddescription>
241    <inheritancegraph>
242      <node id="1174">
243        <label>MemDS</label>
244        <link refid="classMemDS"/>
245        <childnode refid="1175" relation="public-inheritance">
246        </childnode>
247      </node>
248      <node id="1175">
249        <label>DS</label>
250        <link refid="classDS"/>
251      </node>
252    </inheritancegraph>
253    <collaborationgraph>
254      <node id="1176">
255        <label>MemDS</label>
256        <link refid="classMemDS"/>
257        <childnode refid="1177" relation="public-inheritance">
258        </childnode>
259      </node>
260      <node id="1177">
261        <label>DS</label>
262        <link refid="classDS"/>
263        <childnode refid="1178" relation="usage">
264          <edgelabel>Urv
265Drv</edgelabel>
266        </childnode>
267      </node>
268      <node id="1178">
269        <label>RV</label>
270        <link refid="classRV"/>
271      </node>
272    </collaborationgraph>
273    <location file="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" line="28" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libDS.h" bodystart="28" bodyend="43"/>
274    <listofallmembers>
275      <member refid="classMemDS_1ab45b03f3e154479fdea3cb02d5f8810" prot="private" virt="non-virtual"><scope>MemDS</scope><name>Data</name></member>
276      <member refid="classMemDS_1862d2f8512990e0a7a28ef2b2dee7bd0" prot="private" virt="non-virtual"><scope>MemDS</scope><name>delays</name></member>
277      <member refid="classDS_11012025a1a3a1fdd24aa48698a3d3454" prot="protected" virt="non-virtual"><scope>MemDS</scope><name>Drv</name></member>
278      <member refid="classMemDS_123522b9e7dd0bb0c365cc9cde4c05449" prot="public" virt="non-virtual"><scope>MemDS</scope><name>getdata</name></member>
279      <member refid="classMemDS_1900f1e1c9eb950f87e557c068628e60e" prot="public" virt="non-virtual"><scope>MemDS</scope><name>getdata</name></member>
280      <member refid="classMemDS_15f72b555e0e4a61de1440c457cf57007" prot="public" virt="non-virtual"><scope>MemDS</scope><name>linkrvs</name></member>
281      <member refid="classMemDS_184cfba80cb32d07be94690658175e9c4" prot="public" virt="non-virtual"><scope>MemDS</scope><name>MemDS</name></member>
282      <member refid="classMemDS_113e303d38a1d5e939b1f02e1f1591608" prot="private" virt="non-virtual"><scope>MemDS</scope><name>rowid</name></member>
283      <member refid="classMemDS_121916feb3e5ff960855c09b06a0d279b" prot="public" virt="non-virtual"><scope>MemDS</scope><name>step</name></member>
284      <member refid="classMemDS_16c755a9befd9a9dcd91cad11073ba8a0" prot="private" virt="non-virtual"><scope>MemDS</scope><name>time</name></member>
285      <member refid="classDS_10a88ffaeb3c7c2cf30c69bc41a000629" prot="protected" virt="non-virtual"><scope>MemDS</scope><name>Urv</name></member>
286      <member refid="classMemDS_1b120ed178f7c848f1227c928d8a79be8" prot="public" virt="non-virtual"><scope>MemDS</scope><name>write</name></member>
287      <member refid="classMemDS_16279bf18d44343750747ecc12e050f09" prot="public" virt="non-virtual"><scope>MemDS</scope><name>write</name></member>
288    </listofallmembers>
289  </compounddef>
290</doxygen>
Note: See TracBrowser for help on using the browser.