root/doc/latex/classMemDS.tex @ 91

Revision 91, 3.7 kB (checked in by smidl, 17 years ago)

drobnosti a dokumentace

  • Property svn:eol-style set to native
Line 
1\section{MemDS Class Reference}
2\label{classMemDS}\index{MemDS@{MemDS}}
3Class representing off-line data stored in memory. 
4
5
6{\tt \#include $<$libDS.h$>$}
7
8Inheritance diagram for MemDS:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=47pt]{classMemDS__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for MemDS:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=47pt]{classMemDS__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25void {\bf getdata} (vec \&dt)\label{classMemDS_23522b9e7dd0bb0c365cc9cde4c05449}
26
27\begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item 
28void {\bf getdata} (vec \&dt, ivec \&indeces)\label{classMemDS_900f1e1c9eb950f87e557c068628e60e}
29
30\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
31void {\bf linkrvs} ({\bf RV} \&drv, {\bf RV} \&urv)
32\begin{CompactList}\small\item\em 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. \item\end{CompactList}\item 
33void {\bf write} (vec \&ut)\label{classMemDS_b120ed178f7c848f1227c928d8a79be8}
34
35\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
36void {\bf write} (vec \&ut, ivec \&indexes)\label{classMemDS_6279bf18d44343750747ecc12e050f09}
37
38\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
39void {\bf step} ()\label{classMemDS_21916feb3e5ff960855c09b06a0d279b}
40
41\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 
42{\bf MemDS} (mat \&Dat, ivec \&rowid, ivec \&delays)\label{classMemDS_84cfba80cb32d07be94690658175e9c4}
43
44\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\end{CompactItemize}
45\subsection*{Protected Attributes}
46\begin{CompactItemize}
47\item 
48{\bf RV} {\bf Drv}\label{classDS_1012025a1a3a1fdd24aa48698a3d3454}
49
50\begin{CompactList}\small\item\em Observed variables, returned by {\tt \doxyref{getdata()}{p.}{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}}. \item\end{CompactList}\item 
51{\bf RV} {\bf Urv}\label{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}
52
53\begin{CompactList}\small\item\em Action variables, accepted by {\tt \doxyref{write()}{p.}{classDS_0dfb6788b70c0d48a1f5276ed6c93039}}. \item\end{CompactList}\end{CompactItemize}
54
55
56\subsection{Detailed Description}
57Class representing off-line data stored in memory.
58
59The 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}.
60
61The data can be loaded from a file.
62
63\subsection{Member Function Documentation}
64\index{MemDS@{MemDS}!linkrvs@{linkrvs}}
65\index{linkrvs@{linkrvs}!MemDS@{MemDS}}
66\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void MemDS::linkrvs ({\bf RV} \& {\em drv}, \/  {\bf RV} \& {\em urv})}\label{classMemDS_5f72b555e0e4a61de1440c457cf57007}
67
68
69Method 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.
70
71(Inherited from m3k, may be deprecated soon).
72
73Reimplemented from {\bf DS} \doxyref{}{p.}{classDS_9a35ca9c9321dce2bf63bf668f785b75}.
74
75References RV::count(), DS::Drv, and DS::Urv.
76
77The documentation for this class was generated from the following files:\begin{CompactItemize}
78\item 
79work/mixpp/bdm/stat/{\bf libDS.h}\item 
80work/mixpp/bdm/stat/libDS.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.