root/doc/latex/classUIARX.tex @ 270

Revision 270, 2.0 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

Line 
1\hypertarget{classUIARX}{
2\section{UIARX Class Reference}
3\label{classUIARX}\index{UIARX@{UIARX}}
4}
5{\tt \#include $<$arx\_\-ui.h$>$}
6
7Inheritance diagram for UIARX:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=65pt]{classUIARX__inherit__graph}
12\end{center}
13\end{figure}
14
15
16\subsection{Detailed Description}
17UI for ARX estimator
18
19The ARX is constructed from a structure with fields:
20
21\begin{Code}\begin{verbatim}estimator = {
22    type = "ARX";
23        ychns = [1];
24        rgrid =  [ 1,  1,  1,  2];
25        delays = [-1, -2, -3, -1];
26
27        //optional fields
28        dV0 = [1e-3, 1e-5, 1e-5, 1e-5]; //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 \subsection*{Public Member Functions}
36\begin{CompactItemize}
37\item 
38\hypertarget{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77}{
39\hyperlink{classbdm_1_1bdmroot}{bdmroot} $\ast$ \hyperlink{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77}{build} (Setting \&S) const }
40\label{classUIARX_e9ef8d41d8f10a31343d76a73b9f0f77}
41
42\begin{CompactList}\small\item\em Function building the computational object. \item\end{CompactList}\end{CompactItemize}
43\subsection*{Protected Member Functions}
44\begin{CompactItemize}
45\item 
46\hypertarget{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}{
47const vec \textbf{getvec} (Setting \&S) const }
48\label{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}
49
50\item 
51\hypertarget{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}{
52const mat \textbf{getmat} (Setting \&S, int ncols) const }
53\label{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}
54
55\item 
56\hypertarget{classbdm_1_1UIbuilder_5f0c1a56ac46342d339c8e7944639b4b}{
57const vec \textbf{getivec} (Setting \&S) const }
58\label{classbdm_1_1UIbuilder_5f0c1a56ac46342d339c8e7944639b4b}
59
60\end{CompactItemize}
61
62
63The documentation for this class was generated from the following file:\begin{CompactItemize}
64\item 
65\hyperlink{arx__ui_8h}{arx\_\-ui.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.