root/doc/latex/classbdm_1_1MemDS.tex @ 270

Revision 270, 6.3 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

Line 
1\hypertarget{classbdm_1_1MemDS}{
2\section{bdm::MemDS Class Reference}
3\label{classbdm_1_1MemDS}\index{bdm::MemDS@{bdm::MemDS}}
4}
5{\tt \#include $<$libDS.h$>$}
6
7Inheritance diagram for bdm::MemDS:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=64pt]{classbdm_1_1MemDS__inherit__graph}
12\end{center}
13\end{figure}
14
15
16\subsection{Detailed Description}
17Memory storage of off-line data column-wise.
18
19The data are stored in an internal matrix {\tt Data} . Each column of Data corresponds to one discrete time observation $t$. Access to this matrix is via indexes {\tt rowid} and {\tt delays}.
20
21The data can be loaded from a file. \subsection*{Public Member Functions}
22\begin{CompactItemize}
23\item 
24\hypertarget{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}{
25void \hyperlink{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}{getdata} (vec \&dt)}
26\label{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}
27
28\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}{
30void \hyperlink{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}{getdata} (vec \&dt, const ivec \&indeces)}
31\label{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}
32
33\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1MemDS_5f72b555e0e4a61de1440c457cf57007}{
35void \textbf{linkrvs} (\hyperlink{classbdm_1_1RV}{RV} \&drv, \hyperlink{classbdm_1_1RV}{RV} \&urv)}
36\label{classbdm_1_1MemDS_5f72b555e0e4a61de1440c457cf57007}
37
38\item 
39\hypertarget{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}{
40void \hyperlink{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}{write} (vec \&ut)}
41\label{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}
42
43\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
44\hypertarget{classbdm_1_1MemDS_d9af4563d430d8a3f15aa03581e52ef0}{
45void \textbf{write} (vec \&ut, ivec \&indexes)}
46\label{classbdm_1_1MemDS_d9af4563d430d8a3f15aa03581e52ef0}
47
48\item 
49\hypertarget{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}{
50void \hyperlink{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}{step} ()}
51\label{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}
52
53\begin{CompactList}\small\item\em Moves from $ t $ to $ t+1 $, i.e. perfroms the actions and reads response of the system. \item\end{CompactList}\item 
54\hypertarget{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}{
55\hyperlink{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}{MemDS} (mat \&Dat, ivec \&rowid, ivec \&delays)}
56\label{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}
57
58\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
59\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
60virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
61\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}
62
63\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
64\hypertarget{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{
65virtual void \hyperlink{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
66\label{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}
67
68\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
69\hypertarget{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{
70virtual void \hyperlink{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
71\label{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}
72
73\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
74\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
75virtual \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
76\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}
77
78\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
80const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
81\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}
82
83\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
84\subsection*{Protected Attributes}
85\begin{CompactItemize}
86\item 
87\hypertarget{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}{
88int \textbf{dtsize}}
89\label{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}
90
91\item 
92\hypertarget{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}{
93int \textbf{utsize}}
94\label{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}
95
96\item 
97\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
98\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
99\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
100
101\begin{CompactList}\small\item\em Description of data returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
102\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
103\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
104\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
105
106\begin{CompactList}\small\item\em Description of data witten by by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
107\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
108int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
109\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
110
111\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
112\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
113int \textbf{L\_\-ut}}
114\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
115
116\end{CompactItemize}
117
118
119The documentation for this class was generated from the following files:\begin{CompactItemize}
120\item 
121\hyperlink{libDS_8h}{libDS.h}\item 
122libDS.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.