root/doc/latex/classbdm_1_1bilinfn.tex @ 267

Revision 261, 7.7 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classbdm_1_1bilinfn}{
2\section{bdm::bilinfn Class Reference}
3\label{classbdm_1_1bilinfn}\index{bdm::bilinfn@{bdm::bilinfn}}
4}
5Class representing function $f(x,u) = Ax+Bu$. 
6
7
8{\tt \#include $<$libFN.h$>$}
9
10Inheritance diagram for bdm::bilinfn:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1bilinfn__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::bilinfn:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=88pt]{classbdm_1_1bilinfn__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1bilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}{
28vec \hyperlink{classbdm_1_1bilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}{eval} (const vec \&x0, const vec \&u0)}
29\label{classbdm_1_1bilinfn_e36a16e72e7f9fedf3cb18d2d5505a24}
30
31\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1bilinfn_1e86e5081f13964ee64342f8e988032c}{
33\hyperlink{classbdm_1_1bilinfn_1e86e5081f13964ee64342f8e988032c}{bilinfn} (const \hyperlink{classbdm_1_1RV}{RV} \&rvx0, const \hyperlink{classbdm_1_1RV}{RV} \&rvu0)}
34\label{classbdm_1_1bilinfn_1e86e5081f13964ee64342f8e988032c}
35
36\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1bilinfn_c99f91d7752e131275b219df731868bd}{
38\hyperlink{classbdm_1_1bilinfn_c99f91d7752e131275b219df731868bd}{bilinfn} (const \hyperlink{classbdm_1_1RV}{RV} \&rvx0, const \hyperlink{classbdm_1_1RV}{RV} \&rvu0, const mat \&A0, const mat \&B0)}
39\label{classbdm_1_1bilinfn_c99f91d7752e131275b219df731868bd}
40
41\begin{CompactList}\small\item\em Alternative constructor. \item\end{CompactList}\item 
42void \hyperlink{classbdm_1_1bilinfn_33066f1054dd259df2ec5fafae4b46e6}{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{classbdm_1_1bilinfn_9cfe2f1c115ba7c3c75849a10a4f2c08}{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{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{
47vec \hyperlink{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{eval} (const vec \&cond)}
48\label{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}
49
50\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
51\hypertarget{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{
52int \hyperlink{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{\_\-dimx} () const }
53\label{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{
57int \hyperlink{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{\_\-dimu} () const }
58\label{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{
62virtual void \hyperlink{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{condition} (const vec \&val)}
63\label{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}
64
65\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
66\hypertarget{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{
67int \hyperlink{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{\_\-dimy} () const }
68\label{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}
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{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{
75\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{rvx}}
76\label{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}
77
78\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{
80\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{rvu}}
81\label{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}
82
83\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{
85int \hyperlink{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{dimx}}
86\label{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}
87
88\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{
90int \hyperlink{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{dimu}}
91\label{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}
92
93\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
94\hypertarget{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{
95int \hyperlink{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{dimy}}
96\label{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}
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{classbdm_1_1bilinfn_33066f1054dd259df2ec5fafae4b46e6}{
106\index{bdm::bilinfn@{bdm::bilinfn}!dfdx\_\-cond@{dfdx\_\-cond}}
107\index{dfdx\_\-cond@{dfdx\_\-cond}!bdm::bilinfn@{bdm::bilinfn}}
108\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void bdm::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{classbdm_1_1bilinfn_33066f1054dd259df2ec5fafae4b46e6}
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{classbdm_1_1diffbifn_651184f808a35f236dbfea21aca1b6ac}{bdm::diffbifn}.\hypertarget{classbdm_1_1bilinfn_9cfe2f1c115ba7c3c75849a10a4f2c08}{
122\index{bdm::bilinfn@{bdm::bilinfn}!dfdu\_\-cond@{dfdu\_\-cond}}
123\index{dfdu\_\-cond@{dfdu\_\-cond}!bdm::bilinfn@{bdm::bilinfn}}
124\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void bdm::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{classbdm_1_1bilinfn_9cfe2f1c115ba7c3c75849a10a4f2c08}
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{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}{bdm::diffbifn}.
138
139The documentation for this class was generated from the following files:\begin{CompactItemize}
140\item 
141libFN.h\item 
142libFN.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.