root/doc/latex/classUIstateDS.tex @ 275

\hypertarget{classUIstateDS}{
\section{UIstateDS Class Reference}
\label{classUIstateDS}\index{UIstateDS@{UIstateDS}}
}
{\tt \#include $<$libDS\_\-ui.h$>$}

Inheritance diagram for UIstateDS::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classUIstateDS}
\end{center}
\end{figure}


\subsection{Detailed Description}
UI for stateDS

The DS is constructed from a structure with fields: 

\begin{Code}\begin{verbatim}system = {
        type = "stateDS";
        //Internal model
        IM = { type = "mpdf"; //<-- valid offspring! e.g. "mlnorm"
                rv = { //description of x_t 
                        names=("name1",...);
                        sizes=[2,1]; // optional default=[1,1...];
                        times=[0,0]; // optional default=[0,0...];
                        }
                rvu= { //description of  u_t 
                        //optional default=empty
                        }       

                // remaining fields depending on the chosen type
                };
        //Observation model
        OM = { type = "mpdf-offspring";
                rv = {}; //description of d_t 
                rvu = {type="internal", path="system.IM.rvu"}; //description of u_t 
        
                //remaining fields
        }
};
\end{verbatim}
\end{Code}

 \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classUIstateDS_972d0b59ec756a4e4247e7febd2383fa}{
\hyperlink{classbdm_1_1bdmroot}{bdmroot} $\ast$ \hyperlink{classUIstateDS_972d0b59ec756a4e4247e7febd2383fa}{build} (Setting \&S) const }
\label{classUIstateDS_972d0b59ec756a4e4247e7febd2383fa}

\begin{CompactList}\small\item\em Function building the computational object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}{
const vec \textbf{getvec} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_3c514c2eb6fc6a347f15c270a32ddebd}

\item 
\hypertarget{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}{
const mat \textbf{getmat} (Setting \&S, int ncols) const }
\label{classbdm_1_1UIbuilder_1e78cce143622e3a0ba66af4768bc3e8}

\item 
\hypertarget{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e}{
const ivec \textbf{getivec} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_950437aed29283d10346f4966011a64e}

\item 
\hypertarget{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22}{
const Array$<$ string $>$ \textbf{get\_\-as} (Setting \&S) const }
\label{classbdm_1_1UIbuilder_4ea1d97d81aba46dfe0e7fd416a4ad22}

\end{CompactItemize}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{libDS__ui_8h}{libDS\_\-ui.h}\end{CompactItemize}