Show
Ignore:
Timestamp:
09/24/08 13:31:03 (16 years ago)
Author:
smidl
Message:

Latex doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/latex/classMemDS.tex

    r145 r172  
     1\hypertarget{classMemDS}{ 
    12\section{MemDS Class Reference} 
    23\label{classMemDS}\index{MemDS@{MemDS}} 
     4} 
    35Class representing off-line data stored in memory.   
    46 
     
    2325\begin{CompactItemize} 
    2426\item  
    25 void {\bf getdata} (vec \&dt)\label{classMemDS_23522b9e7dd0bb0c365cc9cde4c05449} 
     27\hypertarget{classMemDS_23522b9e7dd0bb0c365cc9cde4c05449}{ 
     28void \hyperlink{classMemDS_23522b9e7dd0bb0c365cc9cde4c05449}{getdata} (vec \&dt)} 
     29\label{classMemDS_23522b9e7dd0bb0c365cc9cde4c05449} 
    2630 
    2731\begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item  
    28 void {\bf getdata} (vec \&dt, ivec \&indeces)\label{classMemDS_900f1e1c9eb950f87e557c068628e60e} 
     32\hypertarget{classMemDS_900f1e1c9eb950f87e557c068628e60e}{ 
     33void \hyperlink{classMemDS_900f1e1c9eb950f87e557c068628e60e}{getdata} (vec \&dt, ivec \&indeces)} 
     34\label{classMemDS_900f1e1c9eb950f87e557c068628e60e} 
    2935 
    3036\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item  
    31 void {\bf linkrvs} ({\bf RV} \&drv, {\bf RV} \&urv) 
     37void \hyperlink{classMemDS_5f72b555e0e4a61de1440c457cf57007}{linkrvs} (\hyperlink{classRV}{RV} \&drv, \hyperlink{classRV}{RV} \&urv) 
    3238\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  
    33 void {\bf write} (vec \&ut)\label{classMemDS_b120ed178f7c848f1227c928d8a79be8} 
     39\hypertarget{classMemDS_b120ed178f7c848f1227c928d8a79be8}{ 
     40void \hyperlink{classMemDS_b120ed178f7c848f1227c928d8a79be8}{write} (vec \&ut)} 
     41\label{classMemDS_b120ed178f7c848f1227c928d8a79be8} 
    3442 
    3543\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item  
    36 void {\bf write} (vec \&ut, ivec \&indexes)\label{classMemDS_6279bf18d44343750747ecc12e050f09} 
     44\hypertarget{classMemDS_6279bf18d44343750747ecc12e050f09}{ 
     45void \hyperlink{classMemDS_6279bf18d44343750747ecc12e050f09}{write} (vec \&ut, ivec \&indexes)} 
     46\label{classMemDS_6279bf18d44343750747ecc12e050f09} 
    3747 
    3848\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item  
    39 void {\bf step} ()\label{classMemDS_21916feb3e5ff960855c09b06a0d279b} 
     49\hypertarget{classMemDS_21916feb3e5ff960855c09b06a0d279b}{ 
     50void \hyperlink{classMemDS_21916feb3e5ff960855c09b06a0d279b}{step} ()} 
     51\label{classMemDS_21916feb3e5ff960855c09b06a0d279b} 
    4052 
    4153\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} 
     54\hypertarget{classMemDS_84cfba80cb32d07be94690658175e9c4}{ 
     55\hyperlink{classMemDS_84cfba80cb32d07be94690658175e9c4}{MemDS} (mat \&Dat, ivec \&rowid, ivec \&delays)} 
     56\label{classMemDS_84cfba80cb32d07be94690658175e9c4} 
    4357 
    4458\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\end{CompactItemize} 
     
    4660\begin{CompactItemize} 
    4761\item  
    48 {\bf RV} {\bf Drv}\label{classDS_1012025a1a3a1fdd24aa48698a3d3454} 
     62\hypertarget{classDS_1012025a1a3a1fdd24aa48698a3d3454}{ 
     63\hyperlink{classRV}{RV} \hyperlink{classDS_1012025a1a3a1fdd24aa48698a3d3454}{Drv}} 
     64\label{classDS_1012025a1a3a1fdd24aa48698a3d3454} 
    4965 
    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} 
     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} 
    5270 
    53 \begin{CompactList}\small\item\em Action variables, accepted by {\tt \doxyref{write()}{p.}{classDS_0dfb6788b70c0d48a1f5276ed6c93039}}. \item\end{CompactList}\end{CompactItemize} 
     71\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{write()}}. \item\end{CompactList}\end{CompactItemize} 
    5472 
    5573 
     
    6280 
    6381\subsection{Member Function Documentation} 
     82\hypertarget{classMemDS_5f72b555e0e4a61de1440c457cf57007}{ 
    6483\index{MemDS@{MemDS}!linkrvs@{linkrvs}} 
    6584\index{linkrvs@{linkrvs}!MemDS@{MemDS}} 
    66 \subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}void MemDS::linkrvs ({\bf RV} \& {\em drv}, \/  {\bf RV} \& {\em urv})}\label{classMemDS_5f72b555e0e4a61de1440c457cf57007} 
     85\subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}void MemDS::linkrvs ({\bf RV} \& {\em drv}, \/  {\bf RV} \& {\em urv})}} 
     86\label{classMemDS_5f72b555e0e4a61de1440c457cf57007} 
    6787 
    6888 
     
    7191(Inherited from m3k, may be deprecated soon).  
    7292 
    73 Reimplemented from {\bf DS} \doxyref{}{p.}{classDS_9a35ca9c9321dce2bf63bf668f785b75}. 
     93Reimplemented from \hyperlink{classDS_9a35ca9c9321dce2bf63bf668f785b75}{DS}. 
    7494 
    7595References RV::count(), DS::Drv, and DS::Urv. 
     
    7797The documentation for this class was generated from the following files:\begin{CompactItemize} 
    7898\item  
    79 work/git/mixpp/bdm/stat/{\bf libDS.h}\item  
     99work/git/mixpp/bdm/stat/\hyperlink{libDS_8h}{libDS.h}\item  
    80100work/git/mixpp/bdm/stat/libDS.cpp\end{CompactItemize}