root/doc/latex/classbilinfn.tex @ 234

Revision 224, 7.3 kB (checked in by smidl, 16 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\hypertarget{classbilinfn}{
2\section{bilinfn Class Reference}
3\label{classbilinfn}\index{bilinfn@{bilinfn}}
4}
5Class representing function $f(x,u) = Ax+Bu$. 
6
7
8{\tt \#include $<$libFN.h$>$}
9
10Inheritance diagram for bilinfn:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=44pt]{classbilinfn__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bilinfn:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=60pt]{classbilinfn__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}{
28vec \hyperlink{classbilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}{eval} (const vec \&x0, const vec \&u0)}
29\label{classbilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}
30
31\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
32\hypertarget{classbilinfn_af9f36282730d910a41b95f4d1fb8221}{
33\hyperlink{classbilinfn_af9f36282730d910a41b95f4d1fb8221}{bilinfn} (const \hyperlink{classRV}{RV} \&rvx0, const \hyperlink{classRV}{RV} \&rvu0)}
34\label{classbilinfn_af9f36282730d910a41b95f4d1fb8221}
35
36\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
37\hypertarget{classbilinfn_c99f91d7752e131275b219df731868bd}{
38\hyperlink{classbilinfn_c99f91d7752e131275b219df731868bd}{bilinfn} (const \hyperlink{classRV}{RV} \&rvx0, const \hyperlink{classRV}{RV} \&rvu0, const mat \&A0, const mat \&B0)}
39\label{classbilinfn_c99f91d7752e131275b219df731868bd}
40
41\begin{CompactList}\small\item\em Alternative constructor. \item\end{CompactList}\item 
42void \hyperlink{classbilinfn_79c022de8dbe2b054bb9cc49345f3ef5}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&F, bool full)
43\begin{CompactList}\small\item\em Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} . \item\end{CompactList}\item 
44void \hyperlink{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&F, bool full=true)
45\begin{CompactList}\small\item\em Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} . \item\end{CompactList}\item 
46\hypertarget{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{
47vec \hyperlink{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{eval} (const vec \&cond)}
48\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}
49
50\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
51\hypertarget{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{
52int \hyperlink{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{\_\-dimx} () const }
53\label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{
57int \hyperlink{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{\_\-dimu} () const }
58\label{classdiffbifn_fc8779acbff170611aff0ee70cee3879}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classfnc_d28babf615a7240c34ee57779250f602}{
62virtual void \hyperlink{classfnc_d28babf615a7240c34ee57779250f602}{condition} (const vec \&val)}
63\label{classfnc_d28babf615a7240c34ee57779250f602}
64
65\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
66\hypertarget{classfnc_a8891973d0ca48ce38e1886df45ca298}{
67int \hyperlink{classfnc_a8891973d0ca48ce38e1886df45ca298}{\_\-dimy} () const }
68\label{classfnc_a8891973d0ca48ce38e1886df45ca298}
69
70\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
71\subsection*{Protected Attributes}
72\begin{CompactItemize}
73\item 
74\hypertarget{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{
75\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{rvx}}
76\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}
77
78\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
79\hypertarget{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{
80\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{rvu}}
81\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}
82
83\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
84\hypertarget{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{
85int \hyperlink{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{dimx}}
86\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}
87
88\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
89\hypertarget{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{
90int \hyperlink{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{dimu}}
91\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}
92
93\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
94\hypertarget{classfnc_22d51d10a7901331167f64f80d1af8e9}{
95int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}}
96\label{classfnc_22d51d10a7901331167f64f80d1af8e9}
97
98\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
99
100
101\subsection{Detailed Description}
102Class representing function $f(x,u) = Ax+Bu$.
103
104\subsection{Member Function Documentation}
105\hypertarget{classbilinfn_79c022de8dbe2b054bb9cc49345f3ef5}{
106\index{bilinfn@{bilinfn}!dfdx\_\-cond@{dfdx\_\-cond}}
107\index{dfdx\_\-cond@{dfdx\_\-cond}!bilinfn@{bilinfn}}
108\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void bilinfn::dfdx\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
109\label{classbilinfn_79c022de8dbe2b054bb9cc49345f3ef5}
110
111
112Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
113
114\begin{Desc}
115\item[Parameters:]
116\begin{description}
117\item[{\em full}]denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. \item[{\em x0}]numeric value of $x$, \item[{\em u0}]numeric value of $u$ \item[{\em A}]a place where the result will be stored. \end{description}
118\end{Desc}
119
120
121Reimplemented from \hyperlink{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{diffbifn}.\hypertarget{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}{
122\index{bilinfn@{bilinfn}!dfdu\_\-cond@{dfdu\_\-cond}}
123\index{dfdu\_\-cond@{dfdu\_\-cond}!bilinfn@{bilinfn}}
124\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void bilinfn::dfdu\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
125\label{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}
126
127
128Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
129
130\begin{Desc}
131\item[Parameters:]
132\begin{description}
133\item[{\em full}]denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. \item[{\em x0}]numeric value of $x$, \item[{\em u0}]numeric value of $u$ \item[{\em A}]a place where the result will be stored. \end{description}
134\end{Desc}
135
136
137Reimplemented from \hyperlink{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{diffbifn}.
138
139The documentation for this class was generated from the following files:\begin{CompactItemize}
140\item 
141work/git/mixpp/bdm/stat/libFN.h\item 
142work/git/mixpp/bdm/stat/libFN.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.