root/doc/latex/classbdm_1_1MemDS.tex @ 264

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

doc

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