root/doc/latex/classIMk1.tex @ 254

Revision 224, 7.3 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classIMk1}{
2\section{IMk1 Class Reference}
3\label{classIMk1}\index{IMk1@{IMk1}}
4}
5Model stredni hodnoty vyvoje stavu pro k1. 
6
7
8{\tt \#include $<$model.h$>$}
9
10Inheritance diagram for IMk1:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=46pt]{classIMk1__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for IMk1:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=60pt]{classIMk1__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classIMk1_c440a205745a09c2c903c4bdf7f5f9fc}{
28\hyperlink{classIMk1_c440a205745a09c2c903c4bdf7f5f9fc}{IMk1} ()}
29\label{classIMk1_c440a205745a09c2c903c4bdf7f5f9fc}
30
31\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
32\hypertarget{classIMk1_75f9d12716a3648a838477186b49aff1}{
33void \hyperlink{classIMk1_75f9d12716a3648a838477186b49aff1}{set\_\-parameters} (double alp10, double alp20)}
34\label{classIMk1_75f9d12716a3648a838477186b49aff1}
35
36\begin{CompactList}\small\item\em set CONSTANT parameters \item\end{CompactList}\item 
37\hypertarget{classIMk1_8957f00622352dcacd64518136c7da33}{
38vec \hyperlink{classIMk1_8957f00622352dcacd64518136c7da33}{eval} (const vec \&x0, const vec \&u0)}
39\label{classIMk1_8957f00622352dcacd64518136c7da33}
40
41\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$. \item\end{CompactList}\item 
42void \hyperlink{classIMk1_463177c0fdffdf4951761959160cc682}{dfdx\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, bool full=true)
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{classIMk1_2b85f0984da3fe55849bb7b28f66e50c}{dfdu\_\-cond} (const vec \&x0, const vec \&u0, mat \&A, 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{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{
47vec \hyperlink{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}{eval} (const vec \&cond)}
48\label{classdiffbifn_ad7673e16aa1a046b131b24c731c4632}
49
50\begin{CompactList}\small\item\em Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). \item\end{CompactList}\item 
51\hypertarget{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{
52int \hyperlink{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}{\_\-dimx} () const }
53\label{classdiffbifn_436de7a7301ea9eac7d6081b893bbf57}
54
55\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
56\hypertarget{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{
57int \hyperlink{classdiffbifn_fc8779acbff170611aff0ee70cee3879}{\_\-dimu} () const }
58\label{classdiffbifn_fc8779acbff170611aff0ee70cee3879}
59
60\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
61\hypertarget{classfnc_d28babf615a7240c34ee57779250f602}{
62virtual void \hyperlink{classfnc_d28babf615a7240c34ee57779250f602}{condition} (const vec \&val)}
63\label{classfnc_d28babf615a7240c34ee57779250f602}
64
65\begin{CompactList}\small\item\em function substitutes given value into an appropriate position \item\end{CompactList}\item 
66\hypertarget{classfnc_a8891973d0ca48ce38e1886df45ca298}{
67int \hyperlink{classfnc_a8891973d0ca48ce38e1886df45ca298}{\_\-dimy} () const }
68\label{classfnc_a8891973d0ca48ce38e1886df45ca298}
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{classIMk1_269fe6e6deaac454858cb1ae69fb2c9f}{
75double \textbf{alp1}}
76\label{classIMk1_269fe6e6deaac454858cb1ae69fb2c9f}
77
78\item 
79\hypertarget{classIMk1_441759a33d2a4f452ea5cc9fb25c5f68}{
80double \textbf{alp2}}
81\label{classIMk1_441759a33d2a4f452ea5cc9fb25c5f68}
82
83\item 
84\hypertarget{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{
85\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}{rvx}}
86\label{classdiffbifn_bcf96b86250c3cbd465ba5ee62474b75}
87
88\begin{CompactList}\small\item\em Indentifier of the first rv. \item\end{CompactList}\item 
89\hypertarget{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{
90\hyperlink{classRV}{RV} \hyperlink{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}{rvu}}
91\label{classdiffbifn_c41c74c7942dba51ef0b0bfed963447d}
92
93\begin{CompactList}\small\item\em Indentifier of the second rv. \item\end{CompactList}\item 
94\hypertarget{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{
95int \hyperlink{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}{dimx}}
96\label{classdiffbifn_f6918bc0a9dad656b4cddc028137eb78}
97
98\begin{CompactList}\small\item\em cache for rvx.count() \item\end{CompactList}\item 
99\hypertarget{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{
100int \hyperlink{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}{dimu}}
101\label{classdiffbifn_2e07ce491e973f03d763e37624d0fe79}
102
103\begin{CompactList}\small\item\em cache for rvu.count() \item\end{CompactList}\item 
104\hypertarget{classfnc_22d51d10a7901331167f64f80d1af8e9}{
105int \hyperlink{classfnc_22d51d10a7901331167f64f80d1af8e9}{dimy}}
106\label{classfnc_22d51d10a7901331167f64f80d1af8e9}
107
108\begin{CompactList}\small\item\em Length of the output vector. \item\end{CompactList}\end{CompactItemize}
109
110
111\subsection{Detailed Description}
112Model stredni hodnoty vyvoje stavu pro k1.
113
114\subsection{Member Function Documentation}
115\hypertarget{classIMk1_463177c0fdffdf4951761959160cc682}{
116\index{IMk1@{IMk1}!dfdx\_\-cond@{dfdx\_\-cond}}
117\index{dfdx\_\-cond@{dfdx\_\-cond}!IMk1@{IMk1}}
118\subsubsection[dfdx\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void IMk1::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{]}}}}
119\label{classIMk1_463177c0fdffdf4951761959160cc682}
120
121
122Evaluates $A=\frac{d}{dx}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
123
124\begin{Desc}
125\item[Parameters:]
126\begin{description}
127\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}
128\end{Desc}
129
130
131Reimplemented from \hyperlink{classdiffbifn_6d217a02d4fa13931258d4bebdd0feb4}{diffbifn}.
132
133References RV::count().\hypertarget{classIMk1_2b85f0984da3fe55849bb7b28f66e50c}{
134\index{IMk1@{IMk1}!dfdu\_\-cond@{dfdu\_\-cond}}
135\index{dfdu\_\-cond@{dfdu\_\-cond}!IMk1@{IMk1}}
136\subsubsection[dfdu\_\-cond]{\setlength{\rightskip}{0pt plus 5cm}void IMk1::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{]}}}}
137\label{classIMk1_2b85f0984da3fe55849bb7b28f66e50c}
138
139
140Evaluates $A=\frac{d}{du}f(x,u)|_{x0,u0}$ and writes result into {\tt A} .
141
142\begin{Desc}
143\item[Parameters:]
144\begin{description}
145\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}
146\end{Desc}
147
148
149Reimplemented from \hyperlink{classdiffbifn_1978bafd7909d15c139a08c495c24aa0}{diffbifn}.
150
151The documentation for this class was generated from the following file:\begin{CompactItemize}
152\item 
153work/git/mixpp/doprava/model.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.