root/doc/latex/classDS.tex @ 219

\hypertarget{classDS}{
\section{DS Class Reference}
\label{classDS}\index{DS@{DS}}
}
Abstract class for discrete-time sources of data.  


{\tt \#include $<$libBM.h$>$}

Inheritance diagram for DS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=47pt]{classDS__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for DS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=37pt]{classDS__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{
void \hyperlink{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{getdata} (vec \&dt)}
\label{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}

\begin{CompactList}\small\item\em Returns full vector of observed data. \item\end{CompactList}\item 
\hypertarget{classDS_4027575bc66ea358f9b03dd3be28fe1e}{
void \hyperlink{classDS_4027575bc66ea358f9b03dd3be28fe1e}{getdata} (vec \&dt, ivec \&indeces)}
\label{classDS_4027575bc66ea358f9b03dd3be28fe1e}

\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
\hypertarget{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{
void \hyperlink{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{write} (vec \&ut)}
\label{classDS_0dfb6788b70c0d48a1f5276ed6c93039}

\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
\hypertarget{classDS_f4ae51a3bc1267a6a52fc229973afe85}{
void \hyperlink{classDS_f4ae51a3bc1267a6a52fc229973afe85}{write} (vec \&ut, ivec \&indeces)}
\label{classDS_f4ae51a3bc1267a6a52fc229973afe85}

\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
void \hyperlink{classDS_9a35ca9c9321dce2bf63bf668f785b75}{linkrvs} (\hyperlink{classRV}{RV} \&drv, \hyperlink{classRV}{RV} \&urv)
\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 
\hypertarget{classDS_470ba89e8e7c3c4d830803221b4e9be6}{
void \hyperlink{classDS_470ba89e8e7c3c4d830803221b4e9be6}{step} ()}
\label{classDS_470ba89e8e7c3c4d830803221b4e9be6}

\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}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classDS_1012025a1a3a1fdd24aa48698a3d3454}{
\hyperlink{classRV}{RV} \hyperlink{classDS_1012025a1a3a1fdd24aa48698a3d3454}{Drv}}
\label{classDS_1012025a1a3a1fdd24aa48698a3d3454}

\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classDS_db2dacc9e71a36eeb9c5c2ee402eeeb1}{getdata()}}. \item\end{CompactList}\item 
\hypertarget{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}{
\hyperlink{classRV}{RV} \hyperlink{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}{Urv}}
\label{classDS_0a88ffaeb3c7c2cf30c69bc41a000629}

\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classDS_0dfb6788b70c0d48a1f5276ed6c93039}{write()}}. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Abstract class for discrete-time sources of data. 

The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). 

\subsection{Member Function Documentation}
\hypertarget{classDS_9a35ca9c9321dce2bf63bf668f785b75}{
\index{DS@{DS}!linkrvs@{linkrvs}}
\index{linkrvs@{linkrvs}!DS@{DS}}
\subsubsection[linkrvs]{\setlength{\rightskip}{0pt plus 5cm}void DS::linkrvs ({\bf RV} \& {\em drv}, \/  {\bf RV} \& {\em urv})}}
\label{classDS_9a35ca9c9321dce2bf63bf668f785b75}


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. 

(Inherited from m3k, may be deprecated soon). 

Reimplemented in \hyperlink{classMemDS_5f72b555e0e4a61de1440c457cf57007}{MemDS}.

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
work/git/mixpp/bdm/stat/\hyperlink{libBM_8h}{libBM.h}\end{CompactItemize}