root/doc/html/classbilinfn.html @ 99

Revision 99, 15.3 kB (checked in by smidl, 16 years ago)

doc

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: 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>
7<!-- Generated by Doxygen 1.5.5 -->
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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<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">. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for bilinfn:</div>
33<div class="dynsection">
34<p><center><img src="classbilinfn__inherit__graph.png" border="0" usemap="#bilinfn__inherit__map" alt="Inheritance graph"></center>
35<map name="bilinfn__inherit__map">
36<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>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for bilinfn:</div>
40<div class="dynsection">
41<p><center><img src="classbilinfn__coll__graph.png" border="0" usemap="#bilinfn__coll__map" alt="Collaboration graph"></center>
42<map name="bilinfn__coll__map">
43<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>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classbilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<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)" -->
51vec&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>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
54<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)" -->
55&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>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
58<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)" -->
59&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>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
62<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>
63
64<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>
65<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>
66
67<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>
68<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)" -->
69vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#ad7673e16aa1a046b131b24c731c4632">eval</a> (const vec &amp;cond)</td></tr>
70
71<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>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="436de7a7301ea9eac7d6081b893bbf57"></a><!-- doxytag: member="bilinfn::_dimx" ref="436de7a7301ea9eac7d6081b893bbf57" args="() const " -->
73int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#436de7a7301ea9eac7d6081b893bbf57">_dimx</a> () const </td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc8779acbff170611aff0ee70cee3879"></a><!-- doxytag: member="bilinfn::_dimu" ref="fc8779acbff170611aff0ee70cee3879" args="() const " -->
77int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#fc8779acbff170611aff0ee70cee3879">_dimu</a> () const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8891973d0ca48ce38e1886df45ca298"></a><!-- doxytag: member="bilinfn::_dimy" ref="a8891973d0ca48ce38e1886df45ca298" args="() const " -->
81int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#a8891973d0ca48ce38e1886df45ca298">_dimy</a> () const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
84<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bcf96b86250c3cbd465ba5ee62474b75"></a><!-- doxytag: member="bilinfn::rvx" ref="bcf96b86250c3cbd465ba5ee62474b75" args="" -->
86<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>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c41c74c7942dba51ef0b0bfed963447d"></a><!-- doxytag: member="bilinfn::rvu" ref="c41c74c7942dba51ef0b0bfed963447d" args="" -->
90<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>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6918bc0a9dad656b4cddc028137eb78"></a><!-- doxytag: member="bilinfn::dimx" ref="f6918bc0a9dad656b4cddc028137eb78" args="" -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#f6918bc0a9dad656b4cddc028137eb78">dimx</a></td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e07ce491e973f03d763e37624d0fe79"></a><!-- doxytag: member="bilinfn::dimu" ref="2e07ce491e973f03d763e37624d0fe79" args="" -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdiffbifn.html#2e07ce491e973f03d763e37624d0fe79">dimu</a></td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22d51d10a7901331167f64f80d1af8e9"></a><!-- doxytag: member="bilinfn::dimy" ref="22d51d10a7901331167f64f80d1af8e9" args="" -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfnc.html#22d51d10a7901331167f64f80d1af8e9">dimy</a></td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
105</table>
106<hr><a name="_details"></a><h2>Detailed Description</h2>
107Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_48.png">. <hr><h2>Member Function Documentation</h2>
108<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)" -->
109<div class="memitem">
110<div class="memproto">
111      <table class="memname">
112        <tr>
113          <td class="memname">void bilinfn::dfdx_cond           </td>
114          <td>(</td>
115          <td class="paramtype">const vec &amp;&nbsp;</td>
116          <td class="paramname"> <em>x0</em>, </td>
117        </tr>
118        <tr>
119          <td class="paramkey"></td>
120          <td></td>
121          <td class="paramtype">const vec &amp;&nbsp;</td>
122          <td class="paramname"> <em>u0</em>, </td>
123        </tr>
124        <tr>
125          <td class="paramkey"></td>
126          <td></td>
127          <td class="paramtype">mat &amp;&nbsp;</td>
128          <td class="paramname"> <em>A</em>, </td>
129        </tr>
130        <tr>
131          <td class="paramkey"></td>
132          <td></td>
133          <td class="paramtype">bool&nbsp;</td>
134          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
135        </tr>
136        <tr>
137          <td></td>
138          <td>)</td>
139          <td></td><td></td><td width="100%"><code> [inline, virtual]</code></td>
140        </tr>
141      </table>
142</div>
143<div class="memdoc">
144
145<p>
146Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
147<p>
148<dl compact><dt><b>Parameters:</b></dt><dd>
149  <table border="0" cellspacing="2" cellpadding="0">
150    <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>
151    <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>
152    <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>
153    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
154  </table>
155</dl>
156
157<p>Reimplemented from <a class="el" href="classdiffbifn.html#6d217a02d4fa13931258d4bebdd0feb4">diffbifn</a>.</p>
158
159</div>
160</div><p>
161<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)" -->
162<div class="memitem">
163<div class="memproto">
164      <table class="memname">
165        <tr>
166          <td class="memname">void bilinfn::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 width="100%"><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 from <a class="el" href="classdiffbifn.html#1978bafd7909d15c139a08c495c24aa0">diffbifn</a>.</p>
211
212</div>
213</div><p>
214<hr>The documentation for this class was generated from the following files:<ul>
215<li>work/mixpp/bdm/stat/<a class="el" href="libFN_8h-source.html">libFN.h</a><li>work/mixpp/bdm/stat/libFN.cpp</ul>
216</div>
217<hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 16:15:24 2008 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.5 </small></address>
220</body>
221</html>
Note: See TracBrowser for help on using the browser.