root/doc/latex/classbdm_1_1diffbifn.tex @ 280

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

progress...

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