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

Revision 397, 18.8 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[259]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">
[290]5<link href="doxygen.css" rel="stylesheet" type="text/css">
[259]6</head><body>
[396]7<!-- Generated by Doxygen 1.5.9 -->
[271]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>
[259]49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
[271]52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
[290]55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
[290]62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
[271]67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1bilinfn.html">bilinfn</a>
[259]68  </div>
69</div>
70<div class="contents">
[397]71<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_43.png">. 
[290]72<a href="#_details">More...</a>
[259]73<p>
[397]74<<<<<<< HEAD:library/doc/html/classbdm_1_1bilinfn.html
[396]75<code>#include &lt;<a class="el" href="functions_8h_source.html">functions.h</a>&gt;</code>
[397]76=======
77<code>#include &lt;<a class="el" href="functions_8h-source.html">functions.h</a>&gt;</code>
78>>>>>>> doc:library/doc/html/classbdm_1_1bilinfn.html
[290]79<p>
[259]80
81<p>
[290]82<a href="classbdm_1_1bilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
[259]83<tr><td></td></tr>
84<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
85<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)" -->
86vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
87
[397]88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_44.png"> (VS: Do we really need common eval? ). <br></td></tr>
[259]89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::bilinfn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
90int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::bilinfn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
94int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
97<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)" -->
98virtual 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>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
[287]101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::bilinfn::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
[259]103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[396]105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::bilinfn::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
106virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
[353]107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
[396]109<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)" -->
110virtual 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>
[353]111
112<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>
[396]113<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 " -->
114virtual 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>
[353]115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
[396]117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::bilinfn::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
118virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
[368]119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
[271]121<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc263f8d8d1876023a9d161d17a3c621"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="dc263f8d8d1876023a9d161d17a3c621" args="()" -->
123&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> ()</td></tr>
124
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91d7d9fcd6146ddf7eef13f02df10f79"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="91d7d9fcd6146ddf7eef13f02df10f79" args="(const mat A0, const mat B0)" -->
126&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> (const mat A0, const mat B0)</td></tr>
127
128<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)" -->
129void&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>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
132<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
[296]133<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)" -->
134vec&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>
[271]135
[397]136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_44.png">. <br></td></tr>
[271]137<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>
138
[397]139<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_45.png"> and writes result into <code>A</code> .  <a href="#33066f1054dd259df2ec5fafae4b46e6"></a><br></td></tr>
[271]140<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>
141
[397]142<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_47.png"> and writes result into <code>A</code> .  <a href="#9cfe2f1c115ba7c3c75849a10a4f2c08"></a><br></td></tr>
[259]143<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::bilinfn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
145<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>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::bilinfn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
149<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>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::bilinfn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
153int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::bilinfn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::bilinfn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
161int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
164</table>
[290]165<hr><a name="_details"></a><h2>Detailed Description</h2>
[397]166Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_43.png">. <hr><h2>Member Function Documentation</h2>
[290]167<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)" -->
[259]168<div class="memitem">
169<div class="memproto">
170      <table class="memname">
171        <tr>
[290]172          <td class="memname">void bdm::bilinfn::dfdu_cond           </td>
[259]173          <td>(</td>
174          <td class="paramtype">const vec &amp;&nbsp;</td>
175          <td class="paramname"> <em>x0</em>, </td>
176        </tr>
177        <tr>
178          <td class="paramkey"></td>
179          <td></td>
180          <td class="paramtype">const vec &amp;&nbsp;</td>
181          <td class="paramname"> <em>u0</em>, </td>
182        </tr>
183        <tr>
184          <td class="paramkey"></td>
185          <td></td>
186          <td class="paramtype">mat &amp;&nbsp;</td>
187          <td class="paramname"> <em>A</em>, </td>
188        </tr>
189        <tr>
190          <td class="paramkey"></td>
191          <td></td>
192          <td class="paramtype">bool&nbsp;</td>
[290]193          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
[259]194        </tr>
195        <tr>
196          <td></td>
197          <td>)</td>
198          <td></td><td></td><td><code> [inline, virtual]</code></td>
199        </tr>
200      </table>
201</div>
202<div class="memdoc">
203
204<p>
[397]205Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_47.png"> and writes result into <code>A</code> .
[259]206<p>
207<dl compact><dt><b>Parameters:</b></dt><dd>
208  <table border="0" cellspacing="2" cellpadding="0">
209    <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>
[397]210    <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>
211    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_46.png"> </td></tr>
[259]212    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
213  </table>
214</dl>
215
[290]216<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
[259]217
218</div>
219</div><p>
[290]220<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)" -->
[259]221<div class="memitem">
222<div class="memproto">
223      <table class="memname">
224        <tr>
[290]225          <td class="memname">void bdm::bilinfn::dfdx_cond           </td>
[259]226          <td>(</td>
227          <td class="paramtype">const vec &amp;&nbsp;</td>
228          <td class="paramname"> <em>x0</em>, </td>
229        </tr>
230        <tr>
231          <td class="paramkey"></td>
232          <td></td>
233          <td class="paramtype">const vec &amp;&nbsp;</td>
234          <td class="paramname"> <em>u0</em>, </td>
235        </tr>
236        <tr>
237          <td class="paramkey"></td>
238          <td></td>
239          <td class="paramtype">mat &amp;&nbsp;</td>
240          <td class="paramname"> <em>A</em>, </td>
241        </tr>
242        <tr>
243          <td class="paramkey"></td>
244          <td></td>
245          <td class="paramtype">bool&nbsp;</td>
[290]246          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
[259]247        </tr>
248        <tr>
249          <td></td>
250          <td>)</td>
251          <td></td><td></td><td><code> [inline, virtual]</code></td>
252        </tr>
253      </table>
254</div>
255<div class="memdoc">
256
257<p>
[397]258Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_45.png"> and writes result into <code>A</code> .
[259]259<p>
260<dl compact><dt><b>Parameters:</b></dt><dd>
261  <table border="0" cellspacing="2" cellpadding="0">
262    <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>
[397]263    <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>
264    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_46.png"> </td></tr>
[259]265    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
266  </table>
267</dl>
268
[290]269<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
[259]270
271</div>
272</div><p>
[296]273<hr>The documentation for this class was generated from the following file:<ul>
[397]274<<<<<<< HEAD:library/doc/html/classbdm_1_1bilinfn.html
[396]275<li><a class="el" href="functions_8h_source.html">functions.h</a></ul>
[259]276</div>
[396]277<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:51 2009 for mixpp by&nbsp;
[397]278=======
279<li><a class="el" href="functions_8h-source.html">functions.h</a></ul>
280</div>
281<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 23 19:52:53 2009 for mixpp by&nbsp;
282>>>>>>> doc:library/doc/html/classbdm_1_1bilinfn.html
[259]283<a href="http://www.doxygen.org/index.html">
[396]284<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
[259]285</body>
286</html>
Note: See TracBrowser for help on using the browser.