root/library/doc/html/classbdm_1_1diffbifn.html @ 486

Revision 472, 18.6 kB (checked in by mido, 15 years ago)

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: bdm::diffbifn Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1diffbifn.html">diffbifn</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::diffbifn Class Reference</h1><!-- doxytag: class="bdm::diffbifn" --><!-- doxytag: inherits="bdm::fnc" -->Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_42.png">. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="functions_8h_source.html">functions.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1diffbifn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188f31066bd72e1bf0ddacd1eb0e6af3"></a><!-- doxytag: member="bdm::diffbifn::eval" ref="188f31066bd72e1bf0ddacd1eb0e6af3" args="(const vec &amp;cond)" -->
81vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_44.png"> (VS: Do we really need common eval? ). <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5462c05b58cd38367ff946836bb82d3"></a><!-- doxytag: member="bdm::diffbifn::eval" ref="b5462c05b58cd38367ff946836bb82d3" args="(const vec &amp;x0, const vec &amp;u0)" -->
85virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#b5462c05b58cd38367ff946836bb82d3">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_44.png">. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_45.png"> and writes result into <code>A</code> .  <a href="#651184f808a35f236dbfea21aca1b6ac"></a><br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_47.png"> and writes result into <code>A</code> .  <a href="#6ea1dc7a482601b29c5ba36a52d20d07"></a><br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92ff29d748e445b440453a38d0b09681"></a><!-- doxytag: member="bdm::diffbifn::diffbifn" ref="92ff29d748e445b440453a38d0b09681" args="()" -->
95&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#92ff29d748e445b440453a38d0b09681">diffbifn</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (dimy is not set!). <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::diffbifn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
99int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::diffbifn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
103int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="bdm::diffbifn::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
107virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#0786e40fade2663a70d654c1dda5d73e">condition</a> (const vec &amp;val)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::diffbifn::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
111int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::diffbifn::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
115virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::diffbifn::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
119virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::diffbifn::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
123virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::diffbifn::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
127virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
130<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::diffbifn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
132<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#5f56547d8e9378b669d3cc19d7831cbb">rvx</a></td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::diffbifn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
136<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a8e3e861d5ec2a7ae9524e6338e58320">rvu</a></td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::diffbifn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
140int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::diffbifn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
144int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::diffbifn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
148int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
151</table>
152<hr><a name="_details"></a><h2>Detailed Description</h2>
153Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_42.png">.
154<p>
155Function of two variables.<p>
156TODO: 1) Technically, it could have a common parent (e.g. <code><a class="el" href="classbdm_1_1fnc.html" title="Class representing function  of variable  represented by rv.">fnc</a></code> ) with other functions. For now, we keep it as it is. 2) It could be generalized into multivariate form, (which was original meaning of <code><a class="el" href="classbdm_1_1fnc.html" title="Class representing function  of variable  represented by rv.">fnc</a></code> ). <hr><h2>Member Function Documentation</h2>
157<a class="anchor" name="6ea1dc7a482601b29c5ba36a52d20d07"></a><!-- doxytag: member="bdm::diffbifn::dfdu_cond" ref="6ea1dc7a482601b29c5ba36a52d20d07" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
158<div class="memitem">
159<div class="memproto">
160      <table class="memname">
161        <tr>
162          <td class="memname">virtual void bdm::diffbifn::dfdu_cond           </td>
163          <td>(</td>
164          <td class="paramtype">const vec &amp;&nbsp;</td>
165          <td class="paramname"> <em>x0</em>, </td>
166        </tr>
167        <tr>
168          <td class="paramkey"></td>
169          <td></td>
170          <td class="paramtype">const vec &amp;&nbsp;</td>
171          <td class="paramname"> <em>u0</em>, </td>
172        </tr>
173        <tr>
174          <td class="paramkey"></td>
175          <td></td>
176          <td class="paramtype">mat &amp;&nbsp;</td>
177          <td class="paramname"> <em>A</em>, </td>
178        </tr>
179        <tr>
180          <td class="paramkey"></td>
181          <td></td>
182          <td class="paramtype">bool&nbsp;</td>
183          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
184        </tr>
185        <tr>
186          <td></td>
187          <td>)</td>
188          <td></td><td></td><td><code> [inline, virtual]</code></td>
189        </tr>
190      </table>
191</div>
192<div class="memdoc">
193
194<p>
195Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_47.png"> and writes result into <code>A</code> .
196<p>
197<dl compact><dt><b>Parameters:</b></dt><dd>
198  <table border="0" cellspacing="2" cellpadding="0">
199    <tr><td valign="top"></td><td valign="top"><em>full</em>&nbsp;</td><td>denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. </td></tr>
200    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_1.png">, </td></tr>
201    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_46.png"> </td></tr>
202    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
203  </table>
204</dl>
205
206<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>.</p>
207
208</div>
209</div><p>
210<a class="anchor" name="651184f808a35f236dbfea21aca1b6ac"></a><!-- doxytag: member="bdm::diffbifn::dfdx_cond" ref="651184f808a35f236dbfea21aca1b6ac" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
211<div class="memitem">
212<div class="memproto">
213      <table class="memname">
214        <tr>
215          <td class="memname">virtual void bdm::diffbifn::dfdx_cond           </td>
216          <td>(</td>
217          <td class="paramtype">const vec &amp;&nbsp;</td>
218          <td class="paramname"> <em>x0</em>, </td>
219        </tr>
220        <tr>
221          <td class="paramkey"></td>
222          <td></td>
223          <td class="paramtype">const vec &amp;&nbsp;</td>
224          <td class="paramname"> <em>u0</em>, </td>
225        </tr>
226        <tr>
227          <td class="paramkey"></td>
228          <td></td>
229          <td class="paramtype">mat &amp;&nbsp;</td>
230          <td class="paramname"> <em>A</em>, </td>
231        </tr>
232        <tr>
233          <td class="paramkey"></td>
234          <td></td>
235          <td class="paramtype">bool&nbsp;</td>
236          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
237        </tr>
238        <tr>
239          <td></td>
240          <td>)</td>
241          <td></td><td></td><td><code> [inline, virtual]</code></td>
242        </tr>
243      </table>
244</div>
245<div class="memdoc">
246
247<p>
248Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_45.png"> and writes result into <code>A</code> .
249<p>
250<dl compact><dt><b>Parameters:</b></dt><dd>
251  <table border="0" cellspacing="2" cellpadding="0">
252    <tr><td valign="top"></td><td valign="top"><em>full</em>&nbsp;</td><td>denotes that even unchanged entries are to be rewritten. When, false only the changed elements are computed. </td></tr>
253    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_1.png">, </td></tr>
254    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_46.png"> </td></tr>
255    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
256  </table>
257</dl>
258
259<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#33066f1054dd259df2ec5fafae4b46e6">bdm::bilinfn</a>.</p>
260
261<p>Referenced by <a class="el" href="kalman_8h_source.html#l00493">bdm::EKF&lt; sq_T &gt;::bayes()</a>, <a class="el" href="kalman_8cpp_source.html#l00199">bdm::EKFCh::bayes()</a>, <a class="el" href="kalman_8cpp_source.html#l00087">bdm::EKFfull::bayes()</a>, <a class="el" href="kalman_8h_source.html#l00475">bdm::EKF&lt; sq_T &gt;::set_parameters()</a>, <a class="el" href="kalman_8cpp_source.html#l00168">bdm::EKFCh::set_parameters()</a>, and <a class="el" href="kalman_8cpp_source.html#l00066">bdm::EKFfull::set_parameters()</a>.</p>
262
263</div>
264</div><p>
265<hr>The documentation for this class was generated from the following file:<ul>
266<li><a class="el" href="functions_8h_source.html">functions.h</a></ul>
267</div>
268<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:07:00 2009 for mixpp by&nbsp;
269<a href="http://www.doxygen.org/index.html">
270<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
271</body>
272</html>
Note: See TracBrowser for help on using the browser.