root/doc/latex/classbdm_1_1ArxDS.tex @ 264

\hypertarget{classbdm_1_1ArxDS}{
\section{bdm::ArxDS Class Reference}
\label{classbdm_1_1ArxDS}\index{bdm::ArxDS@{bdm::ArxDS}}
}
Generator of \hyperlink{classbdm_1_1ARX}{ARX} data.  


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

Inheritance diagram for bdm::ArxDS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=64pt]{classbdm_1_1ArxDS__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for bdm::ArxDS:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{classbdm_1_1ArxDS__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{
void \hyperlink{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{getdata} (vec \&dt)}
\label{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}

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

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

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

\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{
void \hyperlink{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{step} ()}
\label{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}

\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_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}{
\hyperlink{classbdm_1_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}{ArxDS} (\hyperlink{classbdm_1_1RV}{RV} \&drv, \hyperlink{classbdm_1_1RV}{RV} \&urv, \hyperlink{classbdm_1_1RV}{RV} \&rrv)}
\label{classbdm_1_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{
void \hyperlink{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{set\_\-parameters} (const mat \&Th0, const vec mu0, const \hyperlink{classchmat}{chmat} \&sqR0)}
\label{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}

\begin{CompactList}\small\item\em Set parameters of the internal model. \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}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\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 Observed variables, 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 Action variables, accepted 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}


\subsection{Detailed Description}
Generator of \hyperlink{classbdm_1_1ARX}{ARX} data. 

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