Show
Ignore:
Timestamp:
09/24/08 13:31:03 (16 years ago)
Author:
smidl
Message:

Latex doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classdiffbifn.tex

    r145 r172  
     1\hypertarget{classdiffbifn}{ 
    12\section{diffbifn Class Reference} 
    23\label{classdiffbifn}\index{diffbifn@{diffbifn}} 
     4} 
    35Class representing a differentiable function of two variables $f(x,u)$.   
    46 
    … …  
    2325\begin{CompactItemize} 
    2426\item  
    25 vec {\bf eval} (const vec \&cond)\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632} 
     27\hypertarget{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{ 
     28vec \hyperlink{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{eval} (const vec \&cond)} 
     29\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632} 
    2630 
    2731\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item  
    28 virtual vec {\bf eval} (const vec \&x0, const vec \&u0)\label{classdiffbifn_40d8a7eee45acc55cda33d43282faa03} 
     32\hypertarget{classdiffbifn_40d8a7eee45acc55cda33d43282faa03}{ 
     33virtual vec \hyperlink{classdiffbifn_40d8a7eee45acc55cda33d43282faa03}{eval} (const vec \&x0, const vec \&u0)} 
     34\label{classdiffbifn_40d8a7eee45acc55cda33d43282faa03} 
    2935 
    3036\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item  
    31 virtual void {\bf dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true) 
     37virtual void \hyperlink{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true) 
    3238\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  
    33 virtual void {\bf dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true) 
     39virtual void \hyperlink{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true) 
    3440\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  
    35 {\bf diffbifn} (int {\bf dimy}, const {\bf RV} rvx0, const {\bf RV} rvu0)\label{classdiffbifn_797772c0d5aab8ddccec19dfe4bb2d77} 
     41\hypertarget{classdiffbifn_797772c0d5aab8ddccec19dfe4bb2d77}{ 
     42\hyperlink{classdiffbifn_797772c0d5aab8ddccec19dfe4bb2d77}{diffbifn} (int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}, const \hyperlink{classRV}{RV} rvx0, const \hyperlink{classRV}{RV} rvu0)} 
     43\label{classdiffbifn_797772c0d5aab8ddccec19dfe4bb2d77} 
    3644 
    3745\begin{CompactList}\small\item\em Default constructor (dimy is not set!). \item\end{CompactList}\item  
    38 int {\bf \_\-dimx} () const \label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57} 
     46\hypertarget{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{ 
     47int \hyperlink{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{\_\-dimx} () const } 
     48\label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57} 
    3949 
    4050\begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    41 int {\bf \_\-dimu} () const \label{classdiffbifn_fc8779acbff170611aff0ee70cee3879} 
     51\hypertarget{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{ 
     52int \hyperlink{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{\_\-dimu} () const } 
     53\label{classdiffbifn_fc8779acbff170611aff0ee70cee3879} 
    4254 
    4355\begin{CompactList}\small\item\em access function \item\end{CompactList}\item  
    44 int {\bf \_\-dimy} () const \label{classfnc_a8891973d0ca48ce38e1886df45ca298} 
     56\hypertarget{classfnc_a8891973d0ca48ce38e1886df45ca298}{ 
     57int \hyperlink{classfnc_a8891973d0ca48ce38e1886df45ca298}{\_\-dimy} () const } 
     58\label{classfnc_a8891973d0ca48ce38e1886df45ca298} 
    4559 
    4660\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize} 
    … …  
    4862\begin{CompactItemize} 
    4963\item  
    50 {\bf RV} {\bf rvx}\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75} 
     64\hypertarget{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{ 
     65\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{rvx}} 
     66\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75} 
    5167 
    5268\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item  
    53 {\bf RV} {\bf rvu}\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d} 
     69\hypertarget{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{ 
     70\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{rvu}} 
     71\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d} 
    5472 
    5573\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item  
    56 int {\bf dimx}\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78} 
     74\hypertarget{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{ 
     75int \hyperlink{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{dimx}} 
     76\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78} 
    5777 
    5878\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item  
    59 int {\bf dimu}\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79} 
     79\hypertarget{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{ 
     80int \hyperlink{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{dimu}} 
     81\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79} 
    6082 
    6183\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item  
    62 int {\bf dimy}\label{classfnc_22d51d10a7901331167f64f80d1af8e9} 
     84\hypertarget{classfnc_22d51d10a7901331167f64f80d1af8e9}{ 
     85int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}} 
     86\label{classfnc_22d51d10a7901331167f64f80d1af8e9} 
    6387 
    6488\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize} 
    … …  
    7094Function of two variables. 
    7195 
    72 TODO: 1) Technically, it could have a common parent (e.g. {\tt \doxyref{fnc}{p.}{classfnc}} ) 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 \doxyref{fnc}{p.}{classfnc}} ).  
     96TODO: 1) Technically, it could have a common parent (e.g. {\tt \hyperlink{classfnc}{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{classfnc}{fnc}} ).  
    7397 
    7498\subsection{Member Function Documentation} 
     99\hypertarget{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{ 
    75100\index{diffbifn@{diffbifn}!dfdx\_\-cond@{dfdx\_\-cond}} 
    76101\index{dfdx\_\-cond@{dfdx\_\-cond}!diffbifn@{diffbifn}} 
    77 \subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void diffbifn::dfdx\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4} 
     102\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void 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{]}}}} 
     103\label{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4} 
    78104 
    79105 
    … …  
    87113 
    88114 
    89 Reimplemented in {\bf bilinfn} \doxyref{}{p.}{classbilinfn_79c022de8dbe2b054bb9cc49345f3ef5}, {\bf IMpmsm} \doxyref{}{p.}{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}, and {\bf OMpmsm} \doxyref{}{p.}{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}. 
     115Reimplemented in \hyperlink{classbilinfn_79c022de8dbe2b054bb9cc49345f3ef5}{bilinfn}, \hyperlink{classIMpmsm_b4378b5d3bf64c683e4cf5c5f1cd56f1}{IMpmsm}, and \hyperlink{classOMpmsm_b75b5fd55b2ac5ed74b5b953af122821}{OMpmsm}. 
    90116 
    91 Referenced by EKF$<$ sq\_\-T $>$::bayes(), EKFCh::bayes(), EKFfull::bayes(), EKF$<$ sq\_\-T $>$::set\_\-parameters(), EKFCh::set\_\-parameters(), and EKFfull::set\_\-parameters().\index{diffbifn@{diffbifn}!dfdu\_\-cond@{dfdu\_\-cond}} 
     117Referenced by EKF$<$ sq\_\-T $>$::bayes(), EKFCh::bayes(), EKFfull::bayes(), EKF$<$ sq\_\-T $>$::set\_\-parameters(), EKFCh::set\_\-parameters(), and EKFfull::set\_\-parameters().\hypertarget{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{ 
     118\index{diffbifn@{diffbifn}!dfdu\_\-cond@{dfdu\_\-cond}} 
    92119\index{dfdu\_\-cond@{dfdu\_\-cond}!diffbifn@{diffbifn}} 
    93 \subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void diffbifn::dfdu\_\-cond (const vec \& {\em x0}, \/  const vec \& {\em u0}, \/  mat \& {\em A}, \/  bool {\em full} = {\tt true})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classdiffbifn_1978bafd7909d15c139a08c495c24aa0} 
     120\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}virtual void 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{]}}}} 
     121\label{classdiffbifn_1978bafd7909d15c139a08c495c24aa0} 
    94122 
    95123 
    … …  
    103131 
    104132 
    105 Reimplemented in {\bf bilinfn} \doxyref{}{p.}{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}, and {\bf IMpmsm} \doxyref{}{p.}{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}. 
     133Reimplemented in \hyperlink{classbilinfn_90f2b15612b14883d6ed2b0e295cb82b}{bilinfn}, and \hyperlink{classIMpmsm_c3f8dad22ae9855c04a1d593b45c99b5}{IMpmsm}. 
    106134 
    107135The documentation for this class was generated from the following file:\begin{CompactItemize}