root/doc/html/classbdm_1_1diffbifn.html @ 270

Revision 270, 15.9 kB (checked in by smidl, 15 years ago)

Changes in the very root classes!
* rv and rvc are no longer compulsory,
* samplecond does not return ll
* BM has drv

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="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1diffbifn.html">diffbifn</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::diffbifn Class Reference</h1><!-- doxytag: class="bdm::diffbifn" --><!-- doxytag: inherits="bdm::fnc" --><code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
32<p>
33<div class="dynheader">
34Inheritance diagram for bdm::diffbifn:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1diffbifn__inherit__graph.png" border="0" usemap="#bdm_1_1diffbifn__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1diffbifn__inherit__map">
38<area shape="rect" href="classbdm_1_1bilinfn.html" title="Class representing function ." alt="" coords="13,239,109,265"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
39<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
40
41<p>
42<a href="classbdm_1_1diffbifn-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_47.png">.
44<p>
45Function of two variables.<p>
46TODO: 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> ). <table border="0" cellpadding="0" cellspacing="0">
47<tr><td></td></tr>
48<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
49<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)" -->
50vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png"> (VS: Do we really need common eval? ). <br></td></tr>
53<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)" -->
54virtual 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>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
57<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>
58
59<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_1.png"> and writes result into <code>A</code> .  <a href="#651184f808a35f236dbfea21aca1b6ac"></a><br></td></tr>
60<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>
61
62<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_2.png"> and writes result into <code>A</code> .  <a href="#6ea1dc7a482601b29c5ba36a52d20d07"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92ff29d748e445b440453a38d0b09681"></a><!-- doxytag: member="bdm::diffbifn::diffbifn" ref="92ff29d748e445b440453a38d0b09681" args="()" -->
64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#92ff29d748e445b440453a38d0b09681">diffbifn</a> ()</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (dimy is not set!). <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::diffbifn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
68int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::diffbifn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
72int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
75<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)" -->
76virtual 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>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="bdm::diffbifn::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
80int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_dimy</a> () const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
83<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::diffbifn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
85<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>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::diffbifn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
89<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>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::diffbifn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
93int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::diffbifn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
97int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::diffbifn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
101int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
104</table>
105<hr><h2>Member Function Documentation</h2>
106<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)" -->
107<div class="memitem">
108<div class="memproto">
109      <table class="memname">
110        <tr>
111          <td class="memname">virtual void bdm::diffbifn::dfdx_cond           </td>
112          <td>(</td>
113          <td class="paramtype">const vec &amp;&nbsp;</td>
114          <td class="paramname"> <em>x0</em>, </td>
115        </tr>
116        <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">const vec &amp;&nbsp;</td>
120          <td class="paramname"> <em>u0</em>, </td>
121        </tr>
122        <tr>
123          <td class="paramkey"></td>
124          <td></td>
125          <td class="paramtype">mat &amp;&nbsp;</td>
126          <td class="paramname"> <em>A</em>, </td>
127        </tr>
128        <tr>
129          <td class="paramkey"></td>
130          <td></td>
131          <td class="paramtype">bool&nbsp;</td>
132          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
133        </tr>
134        <tr>
135          <td></td>
136          <td>)</td>
137          <td></td><td></td><td><code> [inline, virtual]</code></td>
138        </tr>
139      </table>
140</div>
141<div class="memdoc">
142
143<p>
144Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
145<p>
146<dl compact><dt><b>Parameters:</b></dt><dd>
147  <table border="0" cellspacing="2" cellpadding="0">
148    <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>
149    <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>
150    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
151    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
152  </table>
153</dl>
154
155<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#33066f1054dd259df2ec5fafae4b46e6">bdm::bilinfn</a>.</p>
156
157<p>Referenced by <a class="el" href="libKF_8h-source.html#l00362">bdm::EKF&lt; sq_T &gt;::bayes()</a>, <a class="el" href="libKF_8cpp-source.html#l00189">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#l00345">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>
158
159</div>
160</div><p>
161<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)" -->
162<div class="memitem">
163<div class="memproto">
164      <table class="memname">
165        <tr>
166          <td class="memname">virtual void bdm::diffbifn::dfdu_cond           </td>
167          <td>(</td>
168          <td class="paramtype">const vec &amp;&nbsp;</td>
169          <td class="paramname"> <em>x0</em>, </td>
170        </tr>
171        <tr>
172          <td class="paramkey"></td>
173          <td></td>
174          <td class="paramtype">const vec &amp;&nbsp;</td>
175          <td class="paramname"> <em>u0</em>, </td>
176        </tr>
177        <tr>
178          <td class="paramkey"></td>
179          <td></td>
180          <td class="paramtype">mat &amp;&nbsp;</td>
181          <td class="paramname"> <em>A</em>, </td>
182        </tr>
183        <tr>
184          <td class="paramkey"></td>
185          <td></td>
186          <td class="paramtype">bool&nbsp;</td>
187          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
188        </tr>
189        <tr>
190          <td></td>
191          <td>)</td>
192          <td></td><td></td><td><code> [inline, virtual]</code></td>
193        </tr>
194      </table>
195</div>
196<div class="memdoc">
197
198<p>
199Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
200<p>
201<dl compact><dt><b>Parameters:</b></dt><dd>
202  <table border="0" cellspacing="2" cellpadding="0">
203    <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>
204    <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>
205    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
206    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
207  </table>
208</dl>
209
210<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>.</p>
211
212</div>
213</div><p>
214<hr>The documentation for this class was generated from the following file:<ul>
215<li><a class="el" href="libFN_8h-source.html">libFN.h</a></ul>
216</div>
217<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:07 2009 for mixpp by&nbsp;
218<a href="http://www.doxygen.org/index.html">
219<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
220</body>
221</html>
Note: See TracBrowser for help on using the browser.