root/doc/html/classdiffbifn.html @ 27

Revision 23, 12.7 kB (checked in by smidl, 18 years ago)

doxy

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: 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.3 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
12    <li><a href="files.html"><span>Files</span></a></li>
13  </ul>
14</div>
15<div class="tabs">
16  <ul>
17    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
18    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
19    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
20  </ul>
21</div>
22<h1>diffbifn Class Reference</h1><!-- doxytag: class="diffbifn" --><!-- doxytag: inherits="fnc" -->Class representing a differentiable function of two variables $f(x,u)$. 
23<a href="#_details">More...</a>
24<p>
25<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
26<p>
27<div class="dynheader">
28Inheritance diagram for diffbifn:</div>
29<div class="dynsection">
30<p><center><img src="classdiffbifn__inherit__graph.png" border="0" usemap="#diffbifn__inherit__map" alt="Inheritance graph"></center>
31<map name="diffbifn__inherit__map">
32<area shape="rect" href="classbilinfn.html" title="Class representing function $f(x,u) = Ax+Bu$." alt="" coords="9,161,68,188"><area shape="rect" href="classfnc.html" title="Class representing function $f(x)$ of variable $x$ represented by rv." alt="" coords="19,7,59,33"></map>
33<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
34<div class="dynheader">
35Collaboration diagram for diffbifn:</div>
36<div class="dynsection">
37<p><center><img src="classdiffbifn__coll__graph.png" border="0" usemap="#diffbifn__coll__map" alt="Collaboration graph"></center>
38<map name="diffbifn__coll__map">
39<area shape="rect" href="classfnc.html" title="Class representing function $f(x)$ of variable $x$ represented by rv." alt="" coords="5,7,45,33"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="69,7,107,33"><area shape="rect" title="rvu\nrvx" alt="" coords="80,31,88,39"><area shape="rect" title="rvu\nrvx" alt="" coords="56,115,64,123"></map>
40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41
42<p>
43<a href="classdiffbifn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
44<tr><td></td></tr>
45<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad7673e16aa1a046b131b24c731c4632"></a><!-- doxytag: member="diffbifn::eval" ref="ad7673e16aa1a046b131b24c731c4632" args="(const vec &amp;cond)" -->
47vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#ad7673e16aa1a046b131b24c731c4632">eval</a> (const vec &amp;cond)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates $f(x0,u0)$ (VS: Do we really need common eval? ). <br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40d8a7eee45acc55cda33d43282faa03"></a><!-- doxytag: member="diffbifn::eval" ref="40d8a7eee45acc55cda33d43282faa03" args="(const vec &amp;x0, const vec &amp;u0)" -->
51virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#40d8a7eee45acc55cda33d43282faa03">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates $f(x0,u0)$. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#6d217a02d4fa13931258d4bebdd0feb4">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
55
56<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="#6d217a02d4fa13931258d4bebdd0feb4"></a><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="classdiffbifn.html#1978bafd7909d15c139a08c495c24aa0">dfdu_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}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .  <a href="#1978bafd7909d15c139a08c495c24aa0"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b33e1bfa23be5ed234d172eb4c0e4b5"></a><!-- doxytag: member="diffbifn::diffbifn" ref="0b33e1bfa23be5ed234d172eb4c0e4b5" args="(const RV rvx0, const RV rvu0)" -->
61&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#0b33e1bfa23be5ed234d172eb4c0e4b5">diffbifn</a> (const <a class="el" href="classRV.html">RV</a> rvx0, const <a class="el" href="classRV.html">RV</a> rvu0)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (dimy is not set!). <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="436de7a7301ea9eac7d6081b893bbf57"></a><!-- doxytag: member="diffbifn::_dimx" ref="436de7a7301ea9eac7d6081b893bbf57" args="() const " -->
65int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#436de7a7301ea9eac7d6081b893bbf57">_dimx</a> () const </td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc8779acbff170611aff0ee70cee3879"></a><!-- doxytag: member="diffbifn::_dimu" ref="fc8779acbff170611aff0ee70cee3879" args="() const " -->
69int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#fc8779acbff170611aff0ee70cee3879">_dimu</a> () const </td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
72<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf96b86250c3cbd465ba5ee62474b75"></a><!-- doxytag: member="diffbifn::rvx" ref="bcf96b86250c3cbd465ba5ee62474b75" args="" -->
74<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>rvx</b></td></tr>
75
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c41c74c7942dba51ef0b0bfed963447d"></a><!-- doxytag: member="diffbifn::rvu" ref="c41c74c7942dba51ef0b0bfed963447d" args="" -->
77<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>rvu</b></td></tr>
78
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6918bc0a9dad656b4cddc028137eb78"></a><!-- doxytag: member="diffbifn::dimx" ref="f6918bc0a9dad656b4cddc028137eb78" args="" -->
80int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimx</b></td></tr>
81
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e07ce491e973f03d763e37624d0fe79"></a><!-- doxytag: member="diffbifn::dimu" ref="2e07ce491e973f03d763e37624d0fe79" args="" -->
83int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimu</b></td></tr>
84
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ed8ce97123e01c7636dcbbb63ea8461"></a><!-- doxytag: member="diffbifn::dimy" ref="9ed8ce97123e01c7636dcbbb63ea8461" args="" -->
86int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimy</b></td></tr>
87
88</table>
89<hr><a name="_details"></a><h2>Detailed Description</h2>
90Class representing a differentiable function of two variables $f(x,u)$.
91<p>
92Function of two variables.<p>
93TODO: 1) Technically, it could have a common parent (e.g. <code><a class="el" href="classfnc.html" title="Class representing function $f(x)$ of variable $x$ 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="classfnc.html" title="Class representing function $f(x)$ of variable $x$ represented by rv.">fnc</a></code> ). <hr><h2>Member Function Documentation</h2>
94<a class="anchor" name="6d217a02d4fa13931258d4bebdd0feb4"></a><!-- doxytag: member="diffbifn::dfdx_cond" ref="6d217a02d4fa13931258d4bebdd0feb4" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
95<div class="memitem">
96<div class="memproto">
97      <table class="memname">
98        <tr>
99          <td class="memname">virtual void diffbifn::dfdx_cond           </td>
100          <td>(</td>
101          <td class="paramtype">const vec &amp;&nbsp;</td>
102          <td class="paramname"> <em>x0</em>, </td>
103        </tr>
104        <tr>
105          <td class="paramkey"></td>
106          <td></td>
107          <td class="paramtype">const vec &amp;&nbsp;</td>
108          <td class="paramname"> <em>u0</em>, </td>
109        </tr>
110        <tr>
111          <td class="paramkey"></td>
112          <td></td>
113          <td class="paramtype">mat &amp;&nbsp;</td>
114          <td class="paramname"> <em>A</em>, </td>
115        </tr>
116        <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">bool&nbsp;</td>
120          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
121        </tr>
122        <tr>
123          <td></td>
124          <td>)</td>
125          <td></td><td></td><td width="100%"><code> [inline, virtual]</code></td>
126        </tr>
127      </table>
128</div>
129<div class="memdoc">
130
131<p>
132Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
133<p>
134<dl compact><dt><b>Parameters:</b></dt><dd>
135  <table border="0" cellspacing="2" cellpadding="0">
136    <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>
137  </table>
138</dl>
139
140<p>Reimplemented in <a class="el" href="classbilinfn.html#79c022de8dbe2b054bb9cc49345f3ef5">bilinfn</a>.</p>
141
142</div>
143</div><p>
144<a class="anchor" name="1978bafd7909d15c139a08c495c24aa0"></a><!-- doxytag: member="diffbifn::dfdu_cond" ref="1978bafd7909d15c139a08c495c24aa0" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
145<div class="memitem">
146<div class="memproto">
147      <table class="memname">
148        <tr>
149          <td class="memname">virtual void diffbifn::dfdu_cond           </td>
150          <td>(</td>
151          <td class="paramtype">const vec &amp;&nbsp;</td>
152          <td class="paramname"> <em>x0</em>, </td>
153        </tr>
154        <tr>
155          <td class="paramkey"></td>
156          <td></td>
157          <td class="paramtype">const vec &amp;&nbsp;</td>
158          <td class="paramname"> <em>u0</em>, </td>
159        </tr>
160        <tr>
161          <td class="paramkey"></td>
162          <td></td>
163          <td class="paramtype">mat &amp;&nbsp;</td>
164          <td class="paramname"> <em>A</em>, </td>
165        </tr>
166        <tr>
167          <td class="paramkey"></td>
168          <td></td>
169          <td class="paramtype">bool&nbsp;</td>
170          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
171        </tr>
172        <tr>
173          <td></td>
174          <td>)</td>
175          <td></td><td></td><td width="100%"><code> [inline, virtual]</code></td>
176        </tr>
177      </table>
178</div>
179<div class="memdoc">
180
181<p>
182Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
183<p>
184<dl compact><dt><b>Parameters:</b></dt><dd>
185  <table border="0" cellspacing="2" cellpadding="0">
186    <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>
187  </table>
188</dl>
189
190<p>Reimplemented in <a class="el" href="classbilinfn.html#90f2b15612b14883d6ed2b0e295cb82b">bilinfn</a>.</p>
191
192</div>
193</div><p>
194<hr>The documentation for this class was generated from the following file:<ul>
195<li>work/mixpp/bdm/stat/<a class="el" href="libFN_8h-source.html">libFN.h</a></ul>
196<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 17 16:14:17 2008 for mixpp by&nbsp;
197<a href="http://www.doxygen.org/index.html">
198<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
199</body>
200</html>
Note: See TracBrowser for help on using the browser.