1 | \hypertarget{classUIARX}{ |
---|
2 | \section{UIARX Class Reference} |
---|
3 | \label{classUIARX}\index{UIARX@{UIARX}} |
---|
4 | } |
---|
5 | {\tt \#include $<$arx\_\-ui.h$>$} |
---|
6 | |
---|
7 | Inheritance diagram for UIARX::\begin{figure}[H] |
---|
8 | \begin{center} |
---|
9 | \leavevmode |
---|
10 | \includegraphics[height=2cm]{classUIARX} |
---|
11 | \end{center} |
---|
12 | \end{figure} |
---|
13 | |
---|
14 | |
---|
15 | \subsection{Detailed Description} |
---|
16 | UI for ARX estimator |
---|
17 | |
---|
18 | The ARX is constructed from a structure with fields: |
---|
19 | |
---|
20 | \begin{Code}\begin{verbatim}estimator = { |
---|
21 | type = "ARX"; |
---|
22 | y = {type="rv", ...} // description of output variables |
---|
23 | rgr = {type="rv", ...} // description of regressor variables |
---|
24 | constant = true; // boolean switch if the constant term is modelled or not |
---|
25 | |
---|
26 | //optional fields |
---|
27 | dV0 = [1e-3, 1e-5, 1e-5, 1e-5]; |
---|
28 | // default: 1e-3 for y, 1e-5 for rgr |
---|
29 | nu0 = 6; // default: rgrlen + 2 |
---|
30 | frg = 1.0; // forgetting, default frg=1.0 |
---|
31 | }; |
---|
32 | \end{verbatim} |
---|
33 | \end{Code} |
---|
34 | |
---|
35 | |
---|
36 | |
---|
37 | The estimator will assign names of the posterior in the form \mbox{[}\char`\"{}theta\_\-i\char`\"{} and \char`\"{}r\_\-i\char`\"{}\mbox{]} \subsection*{Public Member Functions} |
---|
38 | \begin{CompactItemize} |
---|
39 | \item |
---|
40 | \hypertarget{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77}{ |
---|
41 | \hyperlink{classbdm_1_1bdmroot}{bdmroot} $\ast$ \hyperlink{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77}{build} (Setting \&S) const } |
---|
42 | \label{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77} |
---|
43 | |
---|
44 | \begin{CompactList}\small\item\em Function building the computational object. \item\end{CompactList}\end{CompactItemize} |
---|
45 | \subsection*{Protected Member Functions} |
---|
46 | \begin{CompactItemize} |
---|
47 | \item |
---|
48 | \hypertarget{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}{ |
---|
49 | const vec \textbf{getvec} (Setting \&S) const } |
---|
50 | \label{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd} |
---|
51 | |
---|
52 | \item |
---|
53 | \hypertarget{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}{ |
---|
54 | const mat \textbf{getmat} (Setting \&S, int ncols) const } |
---|
55 | \label{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8} |
---|
56 | |
---|
57 | \item |
---|
58 | \hypertarget{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e}{ |
---|
59 | const ivec \textbf{getivec} (Setting \&S) const } |
---|
60 | \label{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e} |
---|
61 | |
---|
62 | \item |
---|
63 | \hypertarget{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22}{ |
---|
64 | const Array$<$ string $>$ \textbf{get\_\-as} (Setting \&S) const } |
---|
65 | \label{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22} |
---|
66 | |
---|
67 | \end{CompactItemize} |
---|
68 | |
---|
69 | |
---|
70 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
71 | \item |
---|
72 | \hyperlink{arx__ui_8h}{arx\_\-ui.h}\end{CompactItemize} |
---|