root/doc/html/classbilinfn.html @ 234

Revision 234, 15.9 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[23]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: bilinfn 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>
[139]7<!-- Generated by Doxygen 1.5.6 -->
[91]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>
[219]13      <li><a href="modules.html"><span>Modules</span></a></li>
[91]14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
[23]25</div>
[91]26<div class="contents">
27<h1>bilinfn Class Reference</h1><!-- doxytag: class="bilinfn" --><!-- doxytag: inherits="diffbifn" -->Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_48.png">. 
[23]28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for bilinfn:</div>
34<div class="dynsection">
35<p><center><img src="classbilinfn__inherit__graph.png" border="0" usemap="#bilinfn__inherit__map" alt="Inheritance graph"></center>
36<map name="bilinfn__inherit__map">
[91]37<area shape="rect" href="classdiffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="5,82,64,106"><area shape="rect" href="classfnc.html" title="Class representing function  of variable  represented by rv." alt="" coords="15,7,55,31"></map>
[23]38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for bilinfn:</div>
41<div class="dynsection">
42<p><center><img src="classbilinfn__coll__graph.png" border="0" usemap="#bilinfn__coll__map" alt="Collaboration graph"></center>
43<map name="bilinfn__coll__map">
[91]44<area shape="rect" href="classdiffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="27,111,85,135"><area shape="rect" href="classfnc.html" title="Class representing function  of variable  represented by rv." alt="" coords="5,7,45,31"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="69,7,107,31"></map>
[23]45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classbilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e36a16e72e7f9fedf3cb18d2d5505a24"></a><!-- doxytag: member="bilinfn::eval" ref="e36a16e72e7f9fedf3cb18d2d5505a24" args="(const vec &amp;x0, const vec &amp;u0)" -->
52vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbilinfn.html#e36a16e72e7f9fedf3cb18d2d5505a24">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
53
[91]54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
[23]55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af9f36282730d910a41b95f4d1fb8221"></a><!-- doxytag: member="bilinfn::bilinfn" ref="af9f36282730d910a41b95f4d1fb8221" args="(const RV &amp;rvx0, const RV &amp;rvu0)" -->
56&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbilinfn.html#af9f36282730d910a41b95f4d1fb8221">bilinfn</a> (const <a class="el" href="classRV.html">RV</a> &amp;rvx0, const <a class="el" href="classRV.html">RV</a> &amp;rvu0)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c99f91d7752e131275b219df731868bd"></a><!-- doxytag: member="bilinfn::bilinfn" ref="c99f91d7752e131275b219df731868bd" args="(const RV &amp;rvx0, const RV &amp;rvu0, const mat &amp;A0, const mat &amp;B0)" -->
[33]60&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbilinfn.html#c99f91d7752e131275b219df731868bd">bilinfn</a> (const <a class="el" href="classRV.html">RV</a> &amp;rvx0, const <a class="el" href="classRV.html">RV</a> &amp;rvu0, const mat &amp;A0, const mat &amp;B0)</td></tr>
[23]61
[33]62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
[23]63<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbilinfn.html#79c022de8dbe2b054bb9cc49345f3ef5">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full)</td></tr>
64
65<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="#79c022de8dbe2b054bb9cc49345f3ef5"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbilinfn.html#90f2b15612b14883d6ed2b0e295cb82b">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full=true)</td></tr>
67
68<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="#90f2b15612b14883d6ed2b0e295cb82b"></a><br></td></tr>
[28]69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad7673e16aa1a046b131b24c731c4632"></a><!-- doxytag: member="bilinfn::eval" ref="ad7673e16aa1a046b131b24c731c4632" args="(const vec &amp;cond)" -->
70vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#ad7673e16aa1a046b131b24c731c4632">eval</a> (const vec &amp;cond)</td></tr>
71
[91]72<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>
[28]73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="436de7a7301ea9eac7d6081b893bbf57"></a><!-- doxytag: member="bilinfn::_dimx" ref="436de7a7301ea9eac7d6081b893bbf57" args="() const " -->
74int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#436de7a7301ea9eac7d6081b893bbf57">_dimx</a> () const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc8779acbff170611aff0ee70cee3879"></a><!-- doxytag: member="bilinfn::_dimu" ref="fc8779acbff170611aff0ee70cee3879" args="() const " -->
78int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#fc8779acbff170611aff0ee70cee3879">_dimu</a> () const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[224]81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d28babf615a7240c34ee57779250f602"></a><!-- doxytag: member="bilinfn::condition" ref="d28babf615a7240c34ee57779250f602" args="(const vec &amp;val)" -->
82virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#d28babf615a7240c34ee57779250f602">condition</a> (const vec &amp;val)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
[28]85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8891973d0ca48ce38e1886df45ca298"></a><!-- doxytag: member="bilinfn::_dimy" ref="a8891973d0ca48ce38e1886df45ca298" args="() const " -->
86int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#a8891973d0ca48ce38e1886df45ca298">_dimy</a> () const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
89<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf96b86250c3cbd465ba5ee62474b75"></a><!-- doxytag: member="bilinfn::rvx" ref="bcf96b86250c3cbd465ba5ee62474b75" args="" -->
[33]91<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#bcf96b86250c3cbd465ba5ee62474b75">rvx</a></td></tr>
[28]92
[33]93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
[28]94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c41c74c7942dba51ef0b0bfed963447d"></a><!-- doxytag: member="bilinfn::rvu" ref="c41c74c7942dba51ef0b0bfed963447d" args="" -->
[33]95<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#c41c74c7942dba51ef0b0bfed963447d">rvu</a></td></tr>
[28]96
[33]97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
[28]98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6918bc0a9dad656b4cddc028137eb78"></a><!-- doxytag: member="bilinfn::dimx" ref="f6918bc0a9dad656b4cddc028137eb78" args="" -->
[33]99int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#f6918bc0a9dad656b4cddc028137eb78">dimx</a></td></tr>
[28]100
[33]101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
[28]102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e07ce491e973f03d763e37624d0fe79"></a><!-- doxytag: member="bilinfn::dimu" ref="2e07ce491e973f03d763e37624d0fe79" args="" -->
[33]103int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#2e07ce491e973f03d763e37624d0fe79">dimu</a></td></tr>
[28]104
[33]105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
[28]106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22d51d10a7901331167f64f80d1af8e9"></a><!-- doxytag: member="bilinfn::dimy" ref="22d51d10a7901331167f64f80d1af8e9" args="" -->
[33]107int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#22d51d10a7901331167f64f80d1af8e9">dimy</a></td></tr>
[28]108
[33]109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
[23]110</table>
111<hr><a name="_details"></a><h2>Detailed Description</h2>
[91]112Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_48.png">. <hr><h2>Member Function Documentation</h2>
[23]113<a class="anchor" name="79c022de8dbe2b054bb9cc49345f3ef5"></a><!-- doxytag: member="bilinfn::dfdx_cond" ref="79c022de8dbe2b054bb9cc49345f3ef5" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full)" -->
114<div class="memitem">
115<div class="memproto">
116      <table class="memname">
117        <tr>
118          <td class="memname">void bilinfn::dfdx_cond           </td>
119          <td>(</td>
120          <td class="paramtype">const vec &amp;&nbsp;</td>
121          <td class="paramname"> <em>x0</em>, </td>
122        </tr>
123        <tr>
124          <td class="paramkey"></td>
125          <td></td>
126          <td class="paramtype">const vec &amp;&nbsp;</td>
127          <td class="paramname"> <em>u0</em>, </td>
128        </tr>
129        <tr>
130          <td class="paramkey"></td>
131          <td></td>
132          <td class="paramtype">mat &amp;&nbsp;</td>
133          <td class="paramname"> <em>A</em>, </td>
134        </tr>
135        <tr>
136          <td class="paramkey"></td>
137          <td></td>
138          <td class="paramtype">bool&nbsp;</td>
139          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
140        </tr>
141        <tr>
142          <td></td>
143          <td>)</td>
[139]144          <td></td><td></td><td><code> [inline, virtual]</code></td>
[23]145        </tr>
146      </table>
147</div>
148<div class="memdoc">
149
150<p>
151Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
152<p>
153<dl compact><dt><b>Parameters:</b></dt><dd>
154  <table border="0" cellspacing="2" cellpadding="0">
155    <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>
[91]156    <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>
157    <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>
[33]158    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
[23]159  </table>
160</dl>
161
162<p>Reimplemented from <a class="el" href="classdiffbifn.html#6d217a02d4fa13931258d4bebdd0feb4">diffbifn</a>.</p>
163
164</div>
165</div><p>
166<a class="anchor" name="90f2b15612b14883d6ed2b0e295cb82b"></a><!-- doxytag: member="bilinfn::dfdu_cond" ref="90f2b15612b14883d6ed2b0e295cb82b" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full=true)" -->
167<div class="memitem">
168<div class="memproto">
169      <table class="memname">
170        <tr>
171          <td class="memname">void bilinfn::dfdu_cond           </td>
172          <td>(</td>
173          <td class="paramtype">const vec &amp;&nbsp;</td>
174          <td class="paramname"> <em>x0</em>, </td>
175        </tr>
176        <tr>
177          <td class="paramkey"></td>
178          <td></td>
179          <td class="paramtype">const vec &amp;&nbsp;</td>
180          <td class="paramname"> <em>u0</em>, </td>
181        </tr>
182        <tr>
183          <td class="paramkey"></td>
184          <td></td>
185          <td class="paramtype">mat &amp;&nbsp;</td>
186          <td class="paramname"> <em>A</em>, </td>
187        </tr>
188        <tr>
189          <td class="paramkey"></td>
190          <td></td>
191          <td class="paramtype">bool&nbsp;</td>
192          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
193        </tr>
194        <tr>
195          <td></td>
196          <td>)</td>
[139]197          <td></td><td></td><td><code> [inline, virtual]</code></td>
[23]198        </tr>
199      </table>
200</div>
201<div class="memdoc">
202
203<p>
204Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
205<p>
206<dl compact><dt><b>Parameters:</b></dt><dd>
207  <table border="0" cellspacing="2" cellpadding="0">
208    <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>
[91]209    <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>
210    <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>
[33]211    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
[23]212  </table>
213</dl>
214
215<p>Reimplemented from <a class="el" href="classdiffbifn.html#1978bafd7909d15c139a08c495c24aa0">diffbifn</a>.</p>
216
217</div>
218</div><p>
219<hr>The documentation for this class was generated from the following files:<ul>
[145]220<li>work/git/mixpp/bdm/stat/<a class="el" href="libFN_8h-source.html">libFN.h</a><li>work/git/mixpp/bdm/stat/libFN.cpp</ul>
[91]221</div>
[234]222<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:50:48 2009 for mixpp by&nbsp;
[23]223<a href="http://www.doxygen.org/index.html">
[139]224<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
[23]225</body>
226</html>
Note: See TracBrowser for help on using the browser.