root/doc/html/classbdm_1_1diffbifn.html @ 290

Revision 290, 17.1 kB (checked in by smidl, 15 years ago)

correction of ARX tutorial

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.8 -->
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><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1diffbifn.html">diffbifn</a>
68  </div>
69</div>
70<div class="contents">
71<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_81.png">. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1diffbifn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<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)" -->
82vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_83.png"> (VS: Do we really need common eval? ). <br></td></tr>
85<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)" -->
86virtual 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>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_83.png">. <br></td></tr>
89<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>
90
91<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_84.png"> and writes result into <code>A</code> .  <a href="#651184f808a35f236dbfea21aca1b6ac"></a><br></td></tr>
92<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>
93
94<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_86.png"> and writes result into <code>A</code> .  <a href="#6ea1dc7a482601b29c5ba36a52d20d07"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92ff29d748e445b440453a38d0b09681"></a><!-- doxytag: member="bdm::diffbifn::diffbifn" ref="92ff29d748e445b440453a38d0b09681" args="()" -->
96&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#92ff29d748e445b440453a38d0b09681">diffbifn</a> ()</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (dimy is not set!). <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::diffbifn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
100int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::diffbifn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
104int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
107<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)" -->
108virtual 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>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::diffbifn::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
112int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
115<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::diffbifn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
117<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>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::diffbifn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
121<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>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::diffbifn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
125int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::diffbifn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
129int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::diffbifn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
133int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
136</table>
137<hr><a name="_details"></a><h2>Detailed Description</h2>
138Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_81.png">.
139<p>
140Function of two variables.<p>
141TODO: 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>
142<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)" -->
143<div class="memitem">
144<div class="memproto">
145      <table class="memname">
146        <tr>
147          <td class="memname">virtual void bdm::diffbifn::dfdu_cond           </td>
148          <td>(</td>
149          <td class="paramtype">const vec &amp;&nbsp;</td>
150          <td class="paramname"> <em>x0</em>, </td>
151        </tr>
152        <tr>
153          <td class="paramkey"></td>
154          <td></td>
155          <td class="paramtype">const vec &amp;&nbsp;</td>
156          <td class="paramname"> <em>u0</em>, </td>
157        </tr>
158        <tr>
159          <td class="paramkey"></td>
160          <td></td>
161          <td class="paramtype">mat &amp;&nbsp;</td>
162          <td class="paramname"> <em>A</em>, </td>
163        </tr>
164        <tr>
165          <td class="paramkey"></td>
166          <td></td>
167          <td class="paramtype">bool&nbsp;</td>
168          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
169        </tr>
170        <tr>
171          <td></td>
172          <td>)</td>
173          <td></td><td></td><td><code> [inline, virtual]</code></td>
174        </tr>
175      </table>
176</div>
177<div class="memdoc">
178
179<p>
180Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_86.png"> and writes result into <code>A</code> .
181<p>
182<dl compact><dt><b>Parameters:</b></dt><dd>
183  <table border="0" cellspacing="2" cellpadding="0">
184    <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>
185    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_28.png">, </td></tr>
186    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_85.png"> </td></tr>
187    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
188  </table>
189</dl>
190
191<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>, <a class="el" href="classIMpmsm.html#c3f8dad22ae9855c04a1d593b45c99b5">IMpmsm</a>, <a class="el" href="classIMpmsm2o.html#27f9d89bce832056f747d985df77a726">IMpmsm2o</a>, and <a class="el" href="classIMpmsmStat.html#ff740ee20100ae2a2d03a2538638f8e8">IMpmsmStat</a>.</p>
192
193</div>
194</div><p>
195<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)" -->
196<div class="memitem">
197<div class="memproto">
198      <table class="memname">
199        <tr>
200          <td class="memname">virtual void bdm::diffbifn::dfdx_cond           </td>
201          <td>(</td>
202          <td class="paramtype">const vec &amp;&nbsp;</td>
203          <td class="paramname"> <em>x0</em>, </td>
204        </tr>
205        <tr>
206          <td class="paramkey"></td>
207          <td></td>
208          <td class="paramtype">const vec &amp;&nbsp;</td>
209          <td class="paramname"> <em>u0</em>, </td>
210        </tr>
211        <tr>
212          <td class="paramkey"></td>
213          <td></td>
214          <td class="paramtype">mat &amp;&nbsp;</td>
215          <td class="paramname"> <em>A</em>, </td>
216        </tr>
217        <tr>
218          <td class="paramkey"></td>
219          <td></td>
220          <td class="paramtype">bool&nbsp;</td>
221          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
222        </tr>
223        <tr>
224          <td></td>
225          <td>)</td>
226          <td></td><td></td><td><code> [inline, virtual]</code></td>
227        </tr>
228      </table>
229</div>
230<div class="memdoc">
231
232<p>
233Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_84.png"> and writes result into <code>A</code> .
234<p>
235<dl compact><dt><b>Parameters:</b></dt><dd>
236  <table border="0" cellspacing="2" cellpadding="0">
237    <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>
238    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_28.png">, </td></tr>
239    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_85.png"> </td></tr>
240    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
241  </table>
242</dl>
243
244<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#33066f1054dd259df2ec5fafae4b46e6">bdm::bilinfn</a>, <a class="el" href="classIMpmsm.html#b4378b5d3bf64c683e4cf5c5f1cd56f1">IMpmsm</a>, <a class="el" href="classIMpmsm2o.html#0a3e125df1e53821e08accbd4960d713">IMpmsm2o</a>, <a class="el" href="classIMpmsmStat.html#29a9c09fd328e89748d9be0801e84831">IMpmsmStat</a>, and <a class="el" href="classOMpmsm.html#b75b5fd55b2ac5ed74b5b953af122821">OMpmsm</a>.</p>
245
246<p>Referenced by <a class="el" href="libKF_8h-source.html#l00389">bdm::EKF&lt; sq_T &gt;::bayes()</a>, <a class="el" href="libKF_8cpp-source.html#l00198">bdm::EKFCh::bayes()</a>, <a class="el" href="libKF_8cpp-source.html#l00086">bdm::EKFfull::bayes()</a>, <a class="el" href="libKF_8h-source.html#l00372">bdm::EKF&lt; sq_T &gt;::set_parameters()</a>, <a class="el" href="libKF_8cpp-source.html#l00167">bdm::EKFCh::set_parameters()</a>, and <a class="el" href="libKF_8cpp-source.html#l00066">bdm::EKFfull::set_parameters()</a>.</p>
247
248</div>
249</div><p>
250<hr>The documentation for this class was generated from the following file:<ul>
251<li><a class="el" href="libFN_8h-source.html">libFN.h</a></ul>
252</div>
253<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 15:01:39 2009 for mixpp by&nbsp;
254<a href="http://www.doxygen.org/index.html">
255<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
256</body>
257</html>
Note: See TracBrowser for help on using the browser.