root/doc/latex/classUIArxDS.tex @ 271

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

Next major revision

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