root/doc/latex/classUIArxDS.tex @ 269

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

doc

RevLine 
[264]1\hypertarget{classUIArxDS}{
2\section{UIArxDS Class Reference}
3\label{classUIArxDS}\index{UIArxDS@{UIArxDS}}
4}
5{\tt \#include $<$libDS\_\-ui.h$>$}
6
7Inheritance diagram for UIArxDS:\nopagebreak
8\begin{figure}[H]
9\begin{center}
10\leavevmode
11\includegraphics[width=65pt]{classUIArxDS__inherit__graph}
12\end{center}
13\end{figure}
14Collaboration diagram for UIArxDS:\nopagebreak
15\begin{figure}[H]
16\begin{center}
17\leavevmode
18\includegraphics[width=65pt]{classUIArxDS__coll__graph}
19\end{center}
20\end{figure}
21\subsection*{Public Member Functions}
22\begin{CompactItemize}
23\item 
24\hypertarget{classUIArxDS_f29ba9f6bb21461d3c061701b8ba366f}{
25\hyperlink{classbdm_1_1bdmroot}{bdmroot} $\ast$ \hyperlink{classUIArxDS_f29ba9f6bb21461d3c061701b8ba366f}{build} (Setting \&S) const }
26\label{classUIArxDS_f29ba9f6bb21461d3c061701b8ba366f}
27
28\begin{CompactList}\small\item\em Function building the computational object. \item\end{CompactList}\end{CompactItemize}
29\subsection*{Protected Member Functions}
30\begin{CompactItemize}
31\item 
32\hypertarget{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}{
33const vec \textbf{getvec} (Setting \&S) const }
34\label{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}
35
36\item 
[269]37\hypertarget{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}{
38const mat \textbf{getmat} (Setting \&S, int ncols) const }
39\label{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}
40
41\item 
[264]42\hypertarget{classbdm_1_1UIbuilder_5f0c1a56ac46342d339c8e7944639b4b}{
43const vec \textbf{getivec} (Setting \&S) const }
44\label{classbdm_1_1UIbuilder_5f0c1a56ac46342d339c8e7944639b4b}
45
46\end{CompactItemize}
47
48
49\subsection{Detailed Description}
50UI for ArxDS using factorized description!
51
[269]52The ArxDS is constructed from a structure with fields:
[264]53
54\begin{Code}\begin{verbatim}system = {
55        type = "ArxDS";
[269]56        // number of output channels
57        ychns = 2;
58        // number of input channels
59        uchns = 0;
60        // regressor ids (only those in ychns or uchns)
61        ids = [1, 1, 1, 2];
62        // regressor time delays
63        delays = [-1, -2, -3, 0];
64        // theta
65        theta = [0.8, -0.3, 0.4, 1.0,
66                 0.0, 0.0, 0.0, 0.0];
67        // offset (optional)
68        offset = [0.0, 0.0];
69        //variance
70        r = [0.1, 0.0,
71             0.0, 1.0];
72        //options: L_theta, etc.
73        opt = "L_theta";
[264]74};
75\end{verbatim}
76\end{Code}
77
78
[269]79
80{\tt ychns} and {\tt uchns} will be transformed into rvs of size=1.
81
82Result is ARX data source offering with full history as Drv.
83
[264]84The documentation for this class was generated from the following file:\begin{CompactItemize}
85\item 
86\hyperlink{libDS__ui_8h}{libDS\_\-ui.h}\end{CompactItemize}
Note: See TracBrowser for help on using the browser.