root/doc/html/classbdm_1_1bilinfn.html @ 270

Revision 270, 15.3 kB (checked in by smidl, 16 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::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.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_1bilinfn.html">bilinfn</a>
28  </div>
29</div>
30<div class="contents">
31<h1>bdm::bilinfn Class Reference</h1><!-- doxytag: class="bdm::bilinfn" --><!-- doxytag: inherits="bdm::diffbifn" --><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::bilinfn:</div>
35<div class="dynsection">
36<p><center><img src="classbdm_1_1bilinfn__inherit__graph.png" border="0" usemap="#bdm_1_1bilinfn__inherit__map" alt="Inheritance graph"></center>
37<map name="bdm_1_1bilinfn__inherit__map">
38<area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="12,161,111,188"><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_1bilinfn-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
43Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_48.png">. <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="e36a16e72e7f9fedf3cb18d2d5505a24"></a><!-- doxytag: member="bdm::bilinfn::eval" ref="e36a16e72e7f9fedf3cb18d2d5505a24" args="(const vec &amp;x0, const vec &amp;u0)" -->
47vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#e36a16e72e7f9fedf3cb18d2d5505a24">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc263f8d8d1876023a9d161d17a3c621"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="dc263f8d8d1876023a9d161d17a3c621" args="()" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#dc263f8d8d1876023a9d161d17a3c621">bilinfn</a> ()</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a508fbb5fc013904d9b62b2231442de"></a><!-- doxytag: member="bdm::bilinfn::set_parameters" ref="5a508fbb5fc013904d9b62b2231442de" args="(const mat A0, const mat B0)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#5a508fbb5fc013904d9b62b2231442de">set_parameters</a> (const mat A0, const mat B0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#33066f1054dd259df2ec5fafae4b46e6">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full)</td></tr>
59
60<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="#33066f1054dd259df2ec5fafae4b46e6"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full=true)</td></tr>
62
63<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="#9cfe2f1c115ba7c3c75849a10a4f2c08"></a><br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188f31066bd72e1bf0ddacd1eb0e6af3"></a><!-- doxytag: member="bdm::bilinfn::eval" ref="188f31066bd72e1bf0ddacd1eb0e6af3" args="(const vec &amp;cond)" -->
65vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
66
67<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>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::bilinfn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
69int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::bilinfn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
73int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</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="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="bdm::bilinfn::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
77virtual 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>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="bdm::bilinfn::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
81int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_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="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::bilinfn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
86<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>
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="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::bilinfn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
90<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>
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="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::bilinfn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">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="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::bilinfn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">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="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::bilinfn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">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><h2>Member Function Documentation</h2>
107<a class="anchor" name="33066f1054dd259df2ec5fafae4b46e6"></a><!-- doxytag: member="bdm::bilinfn::dfdx_cond" ref="33066f1054dd259df2ec5fafae4b46e6" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full)" -->
108<div class="memitem">
109<div class="memproto">
110      <table class="memname">
111        <tr>
112          <td class="memname">void bdm::bilinfn::dfdx_cond           </td>
113          <td>(</td>
114          <td class="paramtype">const vec &amp;&nbsp;</td>
115          <td class="paramname"> <em>x0</em>, </td>
116        </tr>
117        <tr>
118          <td class="paramkey"></td>
119          <td></td>
120          <td class="paramtype">const vec &amp;&nbsp;</td>
121          <td class="paramname"> <em>u0</em>, </td>
122        </tr>
123        <tr>
124          <td class="paramkey"></td>
125          <td></td>
126          <td class="paramtype">mat &amp;&nbsp;</td>
127          <td class="paramname"> <em>A</em>, </td>
128        </tr>
129        <tr>
130          <td class="paramkey"></td>
131          <td></td>
132          <td class="paramtype">bool&nbsp;</td>
133          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
134        </tr>
135        <tr>
136          <td></td>
137          <td>)</td>
138          <td></td><td></td><td><code> [inline, virtual]</code></td>
139        </tr>
140      </table>
141</div>
142<div class="memdoc">
143
144<p>
145Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
146<p>
147<dl compact><dt><b>Parameters:</b></dt><dd>
148  <table border="0" cellspacing="2" cellpadding="0">
149    <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>
150    <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>
151    <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>
152    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
153  </table>
154</dl>
155
156<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
157
158</div>
159</div><p>
160<a class="anchor" name="9cfe2f1c115ba7c3c75849a10a4f2c08"></a><!-- doxytag: member="bdm::bilinfn::dfdu_cond" ref="9cfe2f1c115ba7c3c75849a10a4f2c08" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;F, bool full=true)" -->
161<div class="memitem">
162<div class="memproto">
163      <table class="memname">
164        <tr>
165          <td class="memname">void bdm::bilinfn::dfdu_cond           </td>
166          <td>(</td>
167          <td class="paramtype">const vec &amp;&nbsp;</td>
168          <td class="paramname"> <em>x0</em>, </td>
169        </tr>
170        <tr>
171          <td class="paramkey"></td>
172          <td></td>
173          <td class="paramtype">const vec &amp;&nbsp;</td>
174          <td class="paramname"> <em>u0</em>, </td>
175        </tr>
176        <tr>
177          <td class="paramkey"></td>
178          <td></td>
179          <td class="paramtype">mat &amp;&nbsp;</td>
180          <td class="paramname"> <em>A</em>, </td>
181        </tr>
182        <tr>
183          <td class="paramkey"></td>
184          <td></td>
185          <td class="paramtype">bool&nbsp;</td>
186          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
187        </tr>
188        <tr>
189          <td></td>
190          <td>)</td>
191          <td></td><td></td><td><code> [inline, virtual]</code></td>
192        </tr>
193      </table>
194</div>
195<div class="memdoc">
196
197<p>
198Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
199<p>
200<dl compact><dt><b>Parameters:</b></dt><dd>
201  <table border="0" cellspacing="2" cellpadding="0">
202    <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>
203    <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>
204    <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>
205    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
206  </table>
207</dl>
208
209<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
210
211</div>
212</div><p>
213<hr>The documentation for this class was generated from the following files:<ul>
214<li><a class="el" href="libFN_8h-source.html">libFN.h</a><li>libFN.cpp</ul>
215</div>
216<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 23:34:07 2009 for mixpp by&nbsp;
217<a href="http://www.doxygen.org/index.html">
218<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
219</body>
220</html>
Note: See TracBrowser for help on using the browser.