root/doc/latex/classbdm_1_1ArxDS.tex @ 269

Revision 269, 9.2 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[261]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
[264]31\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
[261]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
[264]61\begin{CompactList}\small\item\em Set parameters of the internal model. \item\end{CompactList}\item 
[269]62\hypertarget{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}{
63void \hyperlink{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}{set\_\-options} (const string \&s)}
64\label{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}
[264]65
[269]66\begin{CompactList}\small\item\em set options from a string \item\end{CompactList}\item 
67\hypertarget{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}{
68virtual void \hyperlink{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
69\label{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}
70
[264]71\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
[269]72\hypertarget{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}{
73virtual void \hyperlink{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
74\label{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}
[264]75
[269]76\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
77\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
78virtual \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
79\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}
80
81\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
82\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
83const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
84\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}
85
86\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
[261]87\subsection*{Protected Attributes}
88\begin{CompactItemize}
89\item 
[269]90\hypertarget{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}{
91\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}{Rrv}}
92\label{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}
93
94\begin{CompactList}\small\item\em Rv of the regressor. \item\end{CompactList}\item 
95\hypertarget{classbdm_1_1ArxDS_d910dcb5d0c1132f1cffad2c91348b3f}{
96\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1ArxDS_d910dcb5d0c1132f1cffad2c91348b3f}{Hrv}}
97\label{classbdm_1_1ArxDS_d910dcb5d0c1132f1cffad2c91348b3f}
98
99\begin{CompactList}\small\item\em Rv of the history (full regressor). \item\end{CompactList}\item 
100\hypertarget{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}{
101vec \hyperlink{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}{H}}
102\label{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}
103
104\begin{CompactList}\small\item\em History, ordered as $[y_t, u_t, y_{t-1 }, u_{t-1}, \ldots]$. \item\end{CompactList}\item 
105\hypertarget{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}{
106vec \hyperlink{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}{U}}
107\label{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}
108
109\begin{CompactList}\small\item\em (future) input \item\end{CompactList}\item 
110\hypertarget{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}{
111vec \hyperlink{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}{rgr}}
112\label{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}
113
114\begin{CompactList}\small\item\em temporary variable for regressor \item\end{CompactList}\item 
115\hypertarget{classbdm_1_1ArxDS_1520556e3577db8c72b902e633d68e5a}{
116\hyperlink{classbdm_1_1datalink__e2e}{datalink\_\-e2e} \hyperlink{classbdm_1_1ArxDS_1520556e3577db8c72b902e633d68e5a}{rgrlnk}}
117\label{classbdm_1_1ArxDS_1520556e3577db8c72b902e633d68e5a}
118
119\begin{CompactList}\small\item\em data link: H -$>$ rgr \item\end{CompactList}\item 
120\hypertarget{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}{
121\hyperlink{classbdm_1_1mlnorm}{mlnorm}$<$ \hyperlink{classchmat}{chmat} $>$ \hyperlink{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}{model}}
122\label{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}
123
124\begin{CompactList}\small\item\em model of Y - linear Gaussian \item\end{CompactList}\item 
125\hypertarget{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}{
126bool \hyperlink{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}{opt\_\-L\_\-theta}}
127\label{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}
128
129\begin{CompactList}\small\item\em options \item\end{CompactList}\item 
130\hypertarget{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}{
131int \hyperlink{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}{L\_\-theta}}
132\label{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}
133
134\begin{CompactList}\small\item\em loggers \item\end{CompactList}\item 
135\hypertarget{classbdm_1_1ArxDS_81a70c39cbd429fcc8130a35b368346c}{
136int \textbf{L\_\-R}}
137\label{classbdm_1_1ArxDS_81a70c39cbd429fcc8130a35b368346c}
138
139\item 
[261]140\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
141\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
142\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
143
144\begin{CompactList}\small\item\em Observed variables, returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
145\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
146\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
147\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
148
[264]149\begin{CompactList}\small\item\em Action variables, accepted by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
150\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
151int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
152\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
[261]153
[264]154\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
155\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
156int \textbf{L\_\-ut}}
157\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
[261]158
[264]159\end{CompactItemize}
160
161
[261]162\subsection{Detailed Description}
163Generator of \hyperlink{classbdm_1_1ARX}{ARX} data.
164
165The documentation for this class was generated from the following files:\begin{CompactItemize}
166\item 
167\hyperlink{libDS_8h}{libDS.h}\item 
168libDS.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.