root/doc/latex/classbdm_1_1ArxDS.tex @ 271

Revision 271, 9.4 kB (checked in by smidl, 16 years ago)

Next major revision

RevLine 
[261]1\hypertarget{classbdm_1_1ArxDS}{
2\section{bdm::ArxDS Class Reference}
3\label{classbdm_1_1ArxDS}\index{bdm::ArxDS@{bdm::ArxDS}}
4}
5{\tt \#include $<$libDS.h$>$}
6
[271]7Inheritance diagram for bdm::ArxDS::\begin{figure}[H]
[261]8\begin{center}
9\leavevmode
[271]10\includegraphics[height=3cm]{classbdm_1_1ArxDS}
[261]11\end{center}
12\end{figure}
[270]13
14
15\subsection{Detailed Description}
16Generator of \hyperlink{classbdm_1_1ARX}{ARX} data. \subsection*{Public Member Functions}
[261]17\begin{CompactItemize}
18\item 
19\hypertarget{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{
20void \hyperlink{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}{getdata} (vec \&dt)}
21\label{classbdm_1_1ArxDS_db242e35812c311c8415bb7e31c3f595}
22
[264]23\begin{CompactList}\small\item\em Returns full vector of observed data=\mbox{[}output, input\mbox{]}. \item\end{CompactList}\item 
[271]24\hypertarget{classbdm_1_1ArxDS_701151418bc5fc3861acef8359fb0d80}{
25void \hyperlink{classbdm_1_1ArxDS_701151418bc5fc3861acef8359fb0d80}{getdata} (vec \&dt, const ivec \&indices)}
26\label{classbdm_1_1ArxDS_701151418bc5fc3861acef8359fb0d80}
[261]27
28\begin{CompactList}\small\item\em Returns data records at indeces. \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}{
30void \hyperlink{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}{write} (vec \&ut)}
31\label{classbdm_1_1ArxDS_8f6da8a00abba70bc58c7a4030bd8940}
32
33\begin{CompactList}\small\item\em Accepts action variable and schedule it for application. \item\end{CompactList}\item 
[271]34\hypertarget{classbdm_1_1ArxDS_477fd706639535f520e9dbbd19f73318}{
35void \hyperlink{classbdm_1_1ArxDS_477fd706639535f520e9dbbd19f73318}{write} (vec \&ut, const ivec \&indices)}
36\label{classbdm_1_1ArxDS_477fd706639535f520e9dbbd19f73318}
[261]37
38\begin{CompactList}\small\item\em Accepts action variables at specific indeces. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{
40void \hyperlink{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}{step} ()}
41\label{classbdm_1_1ArxDS_57dfa26b23cc03d53b123fa7e0474b19}
42
[270]43\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 
44\hypertarget{classbdm_1_1ArxDS_7c8b418677a48041adacac8e8e9c9849}{
45\hyperlink{classbdm_1_1ArxDS_7c8b418677a48041adacac8e8e9c9849}{ArxDS} ()}
46\label{classbdm_1_1ArxDS_7c8b418677a48041adacac8e8e9c9849}
[261]47
48\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
49\hypertarget{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{
50void \hyperlink{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}{set\_\-parameters} (const mat \&Th0, const vec mu0, const \hyperlink{classchmat}{chmat} \&sqR0)}
51\label{classbdm_1_1ArxDS_2d9abc62f1fee862f0e1c60c5c4a3c8a}
52
[271]53\begin{CompactList}\small\item\em Set parameters of the internal model, H is maximum time delay. \item\end{CompactList}\item 
54\hypertarget{classbdm_1_1ArxDS_bf9cd9d4043d7e0dc61de56db37ec703}{
55void \hyperlink{classbdm_1_1ArxDS_bf9cd9d4043d7e0dc61de56db37ec703}{set\_\-drv} (\hyperlink{classbdm_1_1RV}{RV} \&yrv, \hyperlink{classbdm_1_1RV}{RV} \&urv, \hyperlink{classbdm_1_1RV}{RV} \&rrv)}
56\label{classbdm_1_1ArxDS_bf9cd9d4043d7e0dc61de56db37ec703}
57
58\begin{CompactList}\small\item\em Set. \item\end{CompactList}\item 
[269]59\hypertarget{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}{
60void \hyperlink{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}{set\_\-options} (const string \&s)}
61\label{classbdm_1_1ArxDS_e7438127de87c5a8128edfa12255b436}
[264]62
[269]63\begin{CompactList}\small\item\em set options from a string \item\end{CompactList}\item 
64\hypertarget{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}{
65virtual void \hyperlink{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}{log\_\-add} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
66\label{classbdm_1_1ArxDS_64819633a1191fcaa60d0de26ade2e52}
67
[264]68\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]69\hypertarget{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}{
70virtual void \hyperlink{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}{logit} (\hyperlink{classbdm_1_1logger}{logger} \&L)}
71\label{classbdm_1_1ArxDS_4128f5dc3a04063d62fc7e35635aeb90}
[264]72
[269]73\begin{CompactList}\small\item\em Register \hyperlink{classbdm_1_1DS}{DS} for logging into \hyperlink{classbdm_1_1logger}{logger} L. \item\end{CompactList}\item 
74\hypertarget{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{
75virtual \hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}{\_\-drv} () const }
76\label{classbdm_1_1DS_ed2113851294ed96abe60fc3f05aa660}
77
78\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{
80const \hyperlink{classbdm_1_1RV}{RV} \& \hyperlink{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}{\_\-urv} () const }
81\label{classbdm_1_1DS_a6a9a375da64c82fc227bda3418a1f33}
82
83\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
[261]84\subsection*{Protected Attributes}
85\begin{CompactItemize}
86\item 
[269]87\hypertarget{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}{
88\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}{Rrv}}
89\label{classbdm_1_1ArxDS_c7b3cc6cd059ff3d7f4462cedff4bdeb}
90
91\begin{CompactList}\small\item\em Rv of the regressor. \item\end{CompactList}\item 
92\hypertarget{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}{
93vec \hyperlink{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}{H}}
94\label{classbdm_1_1ArxDS_a11a3f3fbeea1d17b66b073017964597}
95
96\begin{CompactList}\small\item\em History, ordered as $[y_t, u_t, y_{t-1 }, u_{t-1}, \ldots]$. \item\end{CompactList}\item 
97\hypertarget{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}{
98vec \hyperlink{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}{U}}
99\label{classbdm_1_1ArxDS_392b87be85675cb3d55fa4953d671bb5}
100
101\begin{CompactList}\small\item\em (future) input \item\end{CompactList}\item 
102\hypertarget{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}{
103vec \hyperlink{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}{rgr}}
104\label{classbdm_1_1ArxDS_b2d7530264499b92c3aa32454b960abe}
105
106\begin{CompactList}\small\item\em temporary variable for regressor \item\end{CompactList}\item 
[271]107\hypertarget{classbdm_1_1ArxDS_fbe7b993ec5f75c195ae1b2ccd96a898}{
108\hyperlink{classbdm_1_1datalink}{datalink} \hyperlink{classbdm_1_1ArxDS_fbe7b993ec5f75c195ae1b2ccd96a898}{rgrlnk}}
109\label{classbdm_1_1ArxDS_fbe7b993ec5f75c195ae1b2ccd96a898}
[269]110
111\begin{CompactList}\small\item\em data link: H -$>$ rgr \item\end{CompactList}\item 
112\hypertarget{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}{
113\hyperlink{classbdm_1_1mlnorm}{mlnorm}$<$ \hyperlink{classchmat}{chmat} $>$ \hyperlink{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}{model}}
114\label{classbdm_1_1ArxDS_0aa9d8d35792159dc9611802f6c190eb}
115
116\begin{CompactList}\small\item\em model of Y - linear Gaussian \item\end{CompactList}\item 
117\hypertarget{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}{
118bool \hyperlink{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}{opt\_\-L\_\-theta}}
119\label{classbdm_1_1ArxDS_064e5d3f2dc0b39459c7ca53d05223e1}
120
121\begin{CompactList}\small\item\em options \item\end{CompactList}\item 
122\hypertarget{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}{
123int \hyperlink{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}{L\_\-theta}}
124\label{classbdm_1_1ArxDS_e13e5ffdfe9d896089310b0fc54e0c85}
125
126\begin{CompactList}\small\item\em loggers \item\end{CompactList}\item 
127\hypertarget{classbdm_1_1ArxDS_81a70c39cbd429fcc8130a35b368346c}{
128int \textbf{L\_\-R}}
129\label{classbdm_1_1ArxDS_81a70c39cbd429fcc8130a35b368346c}
130
131\item 
[271]132\hypertarget{classbdm_1_1ArxDS_9ef18dad16bf2b66bd3e9c8d233e62d8}{
133int \textbf{dt\_\-size}}
134\label{classbdm_1_1ArxDS_9ef18dad16bf2b66bd3e9c8d233e62d8}
135
136\item 
[270]137\hypertarget{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}{
138int \textbf{dtsize}}
139\label{classbdm_1_1DS_f96cae44624e79638a91ec4f2c7c81a9}
140
141\item 
142\hypertarget{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}{
143int \textbf{utsize}}
144\label{classbdm_1_1DS_d7467046a0bd05bc992cc5e1bdedb983}
145
146\item 
[261]147\hypertarget{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{
148\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}{Drv}}
149\label{classbdm_1_1DS_d8db125ac35f3b8eeb773fc9a4cb45ec}
150
[270]151\begin{CompactList}\small\item\em Description of data returned by {\tt \hyperlink{classbdm_1_1DS_c1ec862dec7164fee3284c6f9a51b0ba}{getdata()}}. \item\end{CompactList}\item 
[261]152\hypertarget{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{
153\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}{Urv}}
154\label{classbdm_1_1DS_9ac5970128fd39f4f6226723cd1de702}
155
[270]156\begin{CompactList}\small\item\em Description of data witten by by {\tt \hyperlink{classbdm_1_1DS_f5baeee8528e5e4c5c7a344b2e3f192a}{write()}}. \item\end{CompactList}\item 
[264]157\hypertarget{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{
158int \hyperlink{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}{L\_\-dt}}
159\label{classbdm_1_1DS_b4b7bdb9d98a11ab587aa0ad803bb867}
[261]160
[264]161\begin{CompactList}\small\item\em Remember its own index in Logger L. \item\end{CompactList}\item 
162\hypertarget{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}{
163int \textbf{L\_\-ut}}
164\label{classbdm_1_1DS_b56b74ec21485846ccfad461f33b0e7a}
[261]165
[264]166\end{CompactItemize}
167
168
[261]169The documentation for this class was generated from the following files:\begin{CompactItemize}
170\item 
171\hyperlink{libDS_8h}{libDS.h}\item 
172libDS.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.