root/doc/latex/classbdm_1_1MemDS.tex @ 271

\hypertarget{classbdm_1_1MemDS}{
\section{bdm::MemDS Class Reference}
\label{classbdm_1_1MemDS}\index{bdm::MemDS@{bdm::MemDS}}
}
{\tt \#include $<$libDS.h$>$}

Inheritance diagram for bdm::MemDS::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classbdm_1_1MemDS}
\end{center}
\end{figure}


\subsection{Detailed Description}
Memory storage of off-line data column-wise. 

The 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 indices {\tt rowid} and {\tt delays}.

The data can be loaded from a file. \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}{
void \hyperlink{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}{getdata} (vec \&dt)}
\label{classbdm_1_1MemDS_23522b9e7dd0bb0c365cc9cde4c05449}

\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}{
void \hyperlink{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}{getdata} (vec \&dt, const ivec \&indeces)}
\label{classbdm_1_1MemDS_62083e1db465a97a2a39fc682addc83d}

\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1MemDS_e6428f2778254e8304fb5a799b7f815a}{
void \textbf{set\_\-rvs} (\hyperlink{classbdm_1_1RV}{RV} \&drv, \hyperlink{classbdm_1_1RV}{RV} \&urv)}
\label{classbdm_1_1MemDS_e6428f2778254e8304fb5a799b7f815a}

\item 
\hypertarget{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}{
void \hyperlink{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}{write} (vec \&ut)}
\label{classbdm_1_1MemDS_9a7f17598fe2b458707ba932865beef5}

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

\item 
\hypertarget{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}{
void \hyperlink{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}{step} ()}
\label{classbdm_1_1MemDS_21916feb3e5ff960855c09b06a0d279b}

\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 
\hypertarget{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}{
\hyperlink{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}{MemDS} (mat \&Dat, ivec \&rowid, ivec \&delays)}
\label{classbdm_1_1MemDS_84cfba80cb32d07be94690658175e9c4}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{
virtual void \hyperlink{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}{write} (vec \&ut, const ivec \&indeces)}
\label{classbdm_1_1DS_6bced13f84f6bf04449728817e049e1d}

\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{
virtual void \hyperlink{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
\label{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}

\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{
virtual void \hyperlink{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
\label{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}

\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
virtual \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}{
int \textbf{dtsize}}
\label{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}

\item 
\hypertarget{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}{
int \textbf{utsize}}
\label{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}

\item 
\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}

\begin{CompactList}\small\item\em Description of data returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}

\begin{CompactList}\small\item\em Description of data witten by by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}

\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
int \textbf{L\_\-ut}}
\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}

\end{CompactItemize}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
\hyperlink{libDS_8h}{libDS.h}\item 
libDS.cpp\end{CompactItemize}