root/library/doc/html/classbdm_1_1bilinfn.html @ 651

Revision 651, 18.5 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

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="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1bilinfn.html">bilinfn</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::bilinfn Class Reference</h1><!-- doxytag: class="bdm::bilinfn" --><!-- doxytag: inherits="bdm::diffbifn" -->Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_51.png">. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="functions_8h_source.html">functions.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1bilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<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)" -->
81vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_52.png"> (VS: Do we really need common eval? ). <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::bilinfn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
85int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::bilinfn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
89int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
92<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)" -->
93virtual 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>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::bilinfn::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
97int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::bilinfn::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
101virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::bilinfn::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
105virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::bilinfn::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
109virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::bilinfn::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
113virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
116<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc263f8d8d1876023a9d161d17a3c621"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="dc263f8d8d1876023a9d161d17a3c621" args="()" -->
118&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> ()</td></tr>
119
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22f5fa8db5e405d567933a5a7286c1d4"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="22f5fa8db5e405d567933a5a7286c1d4" args="(const mat &amp;A0, const mat &amp;B0)" -->
121&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> (const mat &amp;A0, const mat &amp;B0)</td></tr>
122
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4cc832cf8f54b6f6d9ac0dd8c7899dd"></a><!-- doxytag: member="bdm::bilinfn::set_parameters" ref="a4cc832cf8f54b6f6d9ac0dd8c7899dd" args="(const mat &amp;A0, const mat &amp;B0)" -->
124void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#a4cc832cf8f54b6f6d9ac0dd8c7899dd">set_parameters</a> (const mat &amp;A0, const mat &amp;B0)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative initialization. <br></td></tr>
127<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="846c21e8e8d41555eb7c075f5ff86ffd"></a><!-- doxytag: member="bdm::bilinfn::eval" ref="846c21e8e8d41555eb7c075f5ff86ffd" args="(const vec &amp;x0, const vec &amp;u0)" -->
129vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#846c21e8e8d41555eb7c075f5ff86ffd">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_52.png">. <br></td></tr>
132<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>
133
134<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_53.png"> and writes result into <code>A</code> .  <a href="#33066f1054dd259df2ec5fafae4b46e6"></a><br></td></tr>
135<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>
136
137<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_55.png"> and writes result into <code>A</code> .  <a href="#9cfe2f1c115ba7c3c75849a10a4f2c08"></a><br></td></tr>
138<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::bilinfn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
140<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>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::bilinfn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
144<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>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::bilinfn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
148int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::bilinfn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
152int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::bilinfn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
156int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
159</table>
160<hr><a name="_details"></a><h2>Detailed Description</h2>
161Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_51.png">. <hr><h2>Member Function Documentation</h2>
162<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)" -->
163<div class="memitem">
164<div class="memproto">
165      <table class="memname">
166        <tr>
167          <td class="memname">void bdm::bilinfn::dfdu_cond           </td>
168          <td>(</td>
169          <td class="paramtype">const vec &amp;&nbsp;</td>
170          <td class="paramname"> <em>x0</em>, </td>
171        </tr>
172        <tr>
173          <td class="paramkey"></td>
174          <td></td>
175          <td class="paramtype">const vec &amp;&nbsp;</td>
176          <td class="paramname"> <em>u0</em>, </td>
177        </tr>
178        <tr>
179          <td class="paramkey"></td>
180          <td></td>
181          <td class="paramtype">mat &amp;&nbsp;</td>
182          <td class="paramname"> <em>A</em>, </td>
183        </tr>
184        <tr>
185          <td class="paramkey"></td>
186          <td></td>
187          <td class="paramtype">bool&nbsp;</td>
188          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
189        </tr>
190        <tr>
191          <td></td>
192          <td>)</td>
193          <td></td><td></td><td><code> [inline, virtual]</code></td>
194        </tr>
195      </table>
196</div>
197<div class="memdoc">
198
199<p>
200Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_55.png"> and writes result into <code>A</code> .
201<p>
202<dl compact><dt><b>Parameters:</b></dt><dd>
203  <table border="0" cellspacing="2" cellpadding="0">
204    <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>
205    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_1.png">, </td></tr>
206    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_54.png"> </td></tr>
207    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
208  </table>
209</dl>
210
211<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
212
213<p>References <a class="el" href="bdmerror_8h_source.html#l00047">bdm_assert_debug</a>.</p>
214
215</div>
216</div><p>
217<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)" -->
218<div class="memitem">
219<div class="memproto">
220      <table class="memname">
221        <tr>
222          <td class="memname">void bdm::bilinfn::dfdx_cond           </td>
223          <td>(</td>
224          <td class="paramtype">const vec &amp;&nbsp;</td>
225          <td class="paramname"> <em>x0</em>, </td>
226        </tr>
227        <tr>
228          <td class="paramkey"></td>
229          <td></td>
230          <td class="paramtype">const vec &amp;&nbsp;</td>
231          <td class="paramname"> <em>u0</em>, </td>
232        </tr>
233        <tr>
234          <td class="paramkey"></td>
235          <td></td>
236          <td class="paramtype">mat &amp;&nbsp;</td>
237          <td class="paramname"> <em>A</em>, </td>
238        </tr>
239        <tr>
240          <td class="paramkey"></td>
241          <td></td>
242          <td class="paramtype">bool&nbsp;</td>
243          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
244        </tr>
245        <tr>
246          <td></td>
247          <td>)</td>
248          <td></td><td></td><td><code> [inline, virtual]</code></td>
249        </tr>
250      </table>
251</div>
252<div class="memdoc">
253
254<p>
255Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_53.png"> and writes result into <code>A</code> .
256<p>
257<dl compact><dt><b>Parameters:</b></dt><dd>
258  <table border="0" cellspacing="2" cellpadding="0">
259    <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>
260    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_1.png">, </td></tr>
261    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_54.png"> </td></tr>
262    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
263  </table>
264</dl>
265
266<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
267
268<p>References <a class="el" href="bdmerror_8h_source.html#l00047">bdm_assert_debug</a>.</p>
269
270</div>
271</div><p>
272<hr>The documentation for this class was generated from the following file:<ul>
273<li><a class="el" href="functions_8h_source.html">functions.h</a></ul>
274</div>
275<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:47 2009 for mixpp by&nbsp;
276<a href="http://www.doxygen.org/index.html">
277<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
278</body>
279</html>
Note: See TracBrowser for help on using the browser.