Changeset 172 for doc/latex/classDS.tex
- Timestamp:
- 09/24/08 13:31:03 (16 years ago)
- Files:
-
- 1 modified
Legend:
- Unmodified
- Added
- Removed
-
doc/latex/classDS.tex
r145 r172 1 \hypertarget{classDS}{ 1 2 \section{DS Class Reference} 2 3 \label{classDS}\index{DS@{DS}} 4 } 3 5 Abstract class for discrete-time sources of data. 4 6 … … 23 25 \begin{CompactItemize} 24 26 \item 25 void {\bf getdata} (vec \&dt)\label{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1} 27 \hypertarget{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{ 28 void \hyperlink{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{getdata} (vec \&dt)} 29 \label{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1} 26 30 27 31 \begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item 28 void {\bf getdata} (vec \&dt, ivec \&indeces)\label{classDS_4027575bc66ea358f9b03dd3be28fe1e} 32 \hypertarget{classDS_4027575bc66ea358f9b03dd3be28fe1e}{ 33 void \hyperlink{classDS_4027575bc66ea358f9b03dd3be28fe1e}{getdata} (vec \&dt, ivec \&indeces)} 34 \label{classDS_4027575bc66ea358f9b03dd3be28fe1e} 29 35 30 36 \begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 31 void {\bf write} (vec \&ut)\label{classDS_0dfb6788b70c0d48a1f5276ed6c93039} 37 \hypertarget{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{ 38 void \hyperlink{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{write} (vec \&ut)} 39 \label{classDS_0dfb6788b70c0d48a1f5276ed6c93039} 32 40 33 41 \begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 34 void {\bf write} (vec \&ut, ivec \&indeces)\label{classDS_f4ae51a3bc1267a6a52fc229973afe85} 42 \hypertarget{classDS_f4ae51a3bc1267a6a52fc229973afe85}{ 43 void \hyperlink{classDS_f4ae51a3bc1267a6a52fc229973afe85}{write} (vec \&ut, ivec \&indeces)} 44 \label{classDS_f4ae51a3bc1267a6a52fc229973afe85} 35 45 36 46 \begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 37 void {\bf linkrvs} ({\bf RV} \&drv, {\bfRV} \&urv)47 void \hyperlink{classDS_9a35ca9c9321dce2bf63bf668f785b75}{linkrvs} (\hyperlink{classRV}{RV} \&drv, \hyperlink{classRV}{RV} \&urv) 38 48 \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 39 void {\bf step} ()\label{classDS_470ba89e8e7c3c4d830803221b4e9be6} 49 \hypertarget{classDS_470ba89e8e7c3c4d830803221b4e9be6}{ 50 void \hyperlink{classDS_470ba89e8e7c3c4d830803221b4e9be6}{step} ()} 51 \label{classDS_470ba89e8e7c3c4d830803221b4e9be6} 40 52 41 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}\end{CompactItemize} … … 43 55 \begin{CompactItemize} 44 56 \item 45 {\bf RV} {\bf Drv}\label{classDS_1012025a1a3a1fdd24aa48698a3d3454} 57 \hypertarget{classDS_1012025a1a3a1fdd24aa48698a3d3454}{ 58 \hyperlink{classRV}{RV} \hyperlink{classDS_1012025a1a3a1fdd24aa48698a3d3454}{Drv}} 59 \label{classDS_1012025a1a3a1fdd24aa48698a3d3454} 46 60 47 \begin{CompactList}\small\item\em Observed variables, returned by {\tt \doxyref{getdata()}{p.}{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}}. \item\end{CompactList}\item 48 {\bf RV} {\bf Urv}\label{classDS_0a88ffaeb3c7c2cf30c69bc41a000629} 61 \begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{getdata()}}. \item\end{CompactList}\item 62 \hypertarget{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}{ 63 \hyperlink{classRV}{RV} \hyperlink{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}{Urv}} 64 \label{classDS_0a88ffaeb3c7c2cf30c69bc41a000629} 49 65 50 \begin{CompactList}\small\item\em Action variables, accepted by {\tt \ doxyref{write()}{p.}{classDS_0dfb6788b70c0d48a1f5276ed6c93039}}. \item\end{CompactList}\end{CompactItemize}66 \begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{write()}}. \item\end{CompactList}\end{CompactItemize} 51 67 52 68 … … 57 73 58 74 \subsection{Member Function Documentation} 75 \hypertarget{classDS_9a35ca9c9321dce2bf63bf668f785b75}{ 59 76 \index{DS@{DS}!linkrvs@{linkrvs}} 60 77 \index{linkrvs@{linkrvs}!DS@{DS}} 61 \subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}void DS::linkrvs ({\bf RV} \& {\em drv}, \/ {\bf RV} \& {\em urv})}\label{classDS_9a35ca9c9321dce2bf63bf668f785b75} 78 \subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}void DS::linkrvs ({\bf RV} \& {\em drv}, \/ {\bf RV} \& {\em urv})}} 79 \label{classDS_9a35ca9c9321dce2bf63bf668f785b75} 62 80 63 81 … … 66 84 (Inherited from m3k, may be deprecated soon). 67 85 68 Reimplemented in {\bf MemDS} \doxyref{}{p.}{classMemDS_5f72b555e0e4a61de1440c457cf57007}.86 Reimplemented in \hyperlink{classMemDS_5f72b555e0e4a61de1440c457cf57007}{MemDS}. 69 87 70 88 The documentation for this class was generated from the following file:\begin{CompactItemize} 71 89 \item 72 work/git/mixpp/bdm/stat/ {\bflibBM.h}\end{CompactItemize}90 work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}