root/doc/latex/classbdm_1_1ArxDS.tex @ 267

Revision 264, 5.4 kB (checked in by smidl, 17 years ago)

doc

Line 
1\hypertarget{classbdm_1_1ArxDS}{
2\section{bdm::ArxDS Class Reference}
3\label{classbdm_1_1ArxDS}\index{bdm::ArxDS@{bdm::ArxDS}}
4}
5Generator of \hyperlink{classbdm_1_1ARX}{ARX} data. 
6
7
8{\tt \#include $<$libDS.h$>$}
9
10Inheritance diagram for bdm::ArxDS:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1ArxDS__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::ArxDS:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=400pt]{classbdm_1_1ArxDS__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{
28void \hyperlink{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{getdata} (vec \&dt)}
29\label{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}
30
31\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1ArxDS_fd61140869637b91bc23215ab7f45d3b}{
33void \hyperlink{classbdm_1_1ArxDS_fd61140869637b91bc23215ab7f45d3b}{getdata} (vec \&dt, const ivec \&indexes)}
34\label{classbdm_1_1ArxDS_fd61140869637b91bc23215ab7f45d3b}
35
36\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}{
38void \hyperlink{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}{write} (vec \&ut)}
39\label{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}
40
41\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1ArxDS_7240ea989a6453e58468feea319dcf0b}{
43void \hyperlink{classbdm_1_1ArxDS_7240ea989a6453e58468feea319dcf0b}{write} (vec \&ut, const ivec \&indexes)}
44\label{classbdm_1_1ArxDS_7240ea989a6453e58468feea319dcf0b}
45
46\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{
48void \hyperlink{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{step} ()}
49\label{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}
50
51\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 
52\hypertarget{classbdm_1_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}{
53\hyperlink{classbdm_1_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}{ArxDS} (\hyperlink{classbdm_1_1RV}{RV} \&drv, \hyperlink{classbdm_1_1RV}{RV} \&urv, \hyperlink{classbdm_1_1RV}{RV} \&rrv)}
54\label{classbdm_1_1ArxDS_e6f17e13dc0c9187ed8dbb19f3c4330a}
55
56\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
57\hypertarget{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{
58void \hyperlink{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{set\_\-parameters} (const mat \&Th0, const vec mu0, const \hyperlink{classchmat}{chmat} \&sqR0)}
59\label{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}
60
61\begin{CompactList}\small\item\em Set parameters of the internal model. \item\end{CompactList}\item 
62\hypertarget{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{
63virtual void \hyperlink{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
64\label{classbdm_1_1DS_3c9e417d85052396fe74c164857ee67e}
65
66\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{
68virtual void \hyperlink{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
69\label{classbdm_1_1DS_e03d2c93cddd5c3a03107ddd3ae999cf}
70
71\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}
72\subsection*{Protected Attributes}
73\begin{CompactItemize}
74\item 
75\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
76\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
77\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
78
79\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
80\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
81\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
82\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
83
84\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
85\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
86int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
87\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
88
89\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
90\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
91int \textbf{L\_\-ut}}
92\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
93
94\end{CompactItemize}
95
96
97\subsection{Detailed Description}
98Generator of \hyperlink{classbdm_1_1ARX}{ARX} data.
99
100The documentation for this class was generated from the following files:\begin{CompactItemize}
101\item 
102\hyperlink{libDS_8h}{libDS.h}\item 
103libDS.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.