root/doc/latex/classbdm_1_1diffbifn.tex @ 261

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

doc

Line 
1\hypertarget{classbdm_1_1diffbifn}{
2\section{bdm::diffbifn Class Reference}
3\label{classbdm_1_1diffbifn}\index{bdm::diffbifn@{bdm::diffbifn}}
4}
5Class representing a differentiable function of two variables $f(x,u)$. 
6
7
8{\tt \#include $<$libFN.h$>$}
9
10Inheritance diagram for bdm::diffbifn:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1diffbifn__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::diffbifn:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=88pt]{classbdm_1_1diffbifn__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{
28vec \hyperlink{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}{eval} (const vec \&cond)}
29\label{classbdm_1_1diffbifn_188f31066bd72e1bf0ddacd1eb0e6af3}
30
31\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1diffbifn_b5462c05b58cd38367ff946836bb82d3}{
33virtual vec \hyperlink{classbdm_1_1diffbifn_b5462c05b58cd38367ff946836bb82d3}{eval} (const vec \&x0, const vec \&u0)}
34\label{classbdm_1_1diffbifn_b5462c05b58cd38367ff946836bb82d3}
35
36\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
37virtual void \hyperlink{classbdm_1_1diffbifn_651184f808a35f236dbfea21aca1b6ac}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
38\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 
39virtual void \hyperlink{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
40\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 
41\hypertarget{classbdm_1_1diffbifn_6ecfa9bf42b2421bd56c260a8b2c51e1}{
42\hyperlink{classbdm_1_1diffbifn_6ecfa9bf42b2421bd56c260a8b2c51e1}{diffbifn} (int \hyperlink{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{dimy}, const \hyperlink{classbdm_1_1RV}{RV} rvx0, const \hyperlink{classbdm_1_1RV}{RV} rvu0)}
43\label{classbdm_1_1diffbifn_6ecfa9bf42b2421bd56c260a8b2c51e1}
44
45\begin{CompactList}\small\item\em Default constructor (dimy is not set!). \item\end{CompactList}\item 
46\hypertarget{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{
47int \hyperlink{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}{\_\-dimx} () const }
48\label{classbdm_1_1diffbifn_1b3c8f5949f13d86d2661e191d4b369b}
49
50\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
51\hypertarget{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{
52int \hyperlink{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}{\_\-dimu} () const }
53\label{classbdm_1_1diffbifn_031458f38c97cdb3aecde16f6a06dced}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{
57virtual void \hyperlink{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}{condition} (const vec \&val)}
58\label{classbdm_1_1fnc_0786e40fade2663a70d654c1dda5d73e}
59
60\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
61\hypertarget{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{
62int \hyperlink{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}{\_\-dimy} () const }
63\label{classbdm_1_1fnc_a2277a400fc9f4d6c0bf24dc7156183f}
64
65\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
66\subsection*{Protected Attributes}
67\begin{CompactItemize}
68\item 
69\hypertarget{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{
70\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}{rvx}}
71\label{classbdm_1_1diffbifn_5f56547d8e9378b669d3cc19d7831cbb}
72
73\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
74\hypertarget{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{
75\hyperlink{classbdm_1_1RV}{RV} \hyperlink{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}{rvu}}
76\label{classbdm_1_1diffbifn_a8e3e861d5ec2a7ae9524e6338e58320}
77
78\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{
80int \hyperlink{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}{dimx}}
81\label{classbdm_1_1diffbifn_a193aa2c4a500139c0c4b669691e588e}
82
83\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{
85int \hyperlink{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}{dimu}}
86\label{classbdm_1_1diffbifn_30c45617eec89adeb4ebaa763d093fb0}
87
88\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{
90int \hyperlink{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}{dimy}}
91\label{classbdm_1_1fnc_52156cb4a52a62d51fc7455985797a62}
92
93\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
94
95
96\subsection{Detailed Description}
97Class representing a differentiable function of two variables $f(x,u)$.
98
99Function of two variables.
100
101TODO: 1) Technically, it could have a common parent (e.g. {\tt \hyperlink{classbdm_1_1fnc}{fnc}} ) with other functions. For now, we keep it as it is. 2) It could be generalized into multivariate form, (which was original meaning of {\tt \hyperlink{classbdm_1_1fnc}{fnc}} ).
102
103\subsection{Member Function Documentation}
104\hypertarget{classbdm_1_1diffbifn_651184f808a35f236dbfea21aca1b6ac}{
105\index{bdm::diffbifn@{bdm::diffbifn}!dfdx\_\-cond@{dfdx\_\-cond}}
106\index{dfdx\_\-cond@{dfdx\_\-cond}!bdm::diffbifn@{bdm::diffbifn}}
107\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void bdm::diffbifn::dfdx\_\-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{]}}}}
108\label{classbdm_1_1diffbifn_651184f808a35f236dbfea21aca1b6ac}
109
110
111Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
112
113\begin{Desc}
114\item[Parameters:]
115\begin{description}
116\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}
117\end{Desc}
118
119
120Reimplemented in \hyperlink{classbdm_1_1bilinfn_33066f1054dd259df2ec5fafae4b46e6}{bdm::bilinfn}.
121
122Referenced by bdm::EKF$<$ sq\_\-T $>$::bayes(), bdm::EKFCh::bayes(), bdm::EKFfull::bayes(), bdm::EKF$<$ sq\_\-T $>$::set\_\-parameters(), bdm::EKFCh::set\_\-parameters(), and bdm::EKFfull::set\_\-parameters().\hypertarget{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}{
123\index{bdm::diffbifn@{bdm::diffbifn}!dfdu\_\-cond@{dfdu\_\-cond}}
124\index{dfdu\_\-cond@{dfdu\_\-cond}!bdm::diffbifn@{bdm::diffbifn}}
125\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void bdm::diffbifn::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{]}}}}
126\label{classbdm_1_1diffbifn_6ea1dc7a482601b29c5ba36a52d20d07}
127
128
129Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
130
131\begin{Desc}
132\item[Parameters:]
133\begin{description}
134\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}
135\end{Desc}
136
137
138Reimplemented in \hyperlink{classbdm_1_1bilinfn_9cfe2f1c115ba7c3c75849a10a4f2c08}{bdm::bilinfn}.
139
140The documentation for this class was generated from the following file:\begin{CompactItemize}
141\item 
142libFN.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.