root/doc/latex/classMemDS.tex @ 172

Revision 172, 4.8 kB (checked in by smidl, 16 years ago)

Latex doc

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