root/doc/latex/classbdm_1_1diffbifn.tex @ 270

Revision 270, 7.6 kB (checked in by smidl, 16 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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