root/doc/html/classbdm_1_1bilinfn.html @ 375

Revision 375, 18.3 kB (checked in by smidl, 16 years ago)

doc - \ to /

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>
[290]7<!-- Generated by Doxygen 1.5.8 -->
[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">
[323]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_90.png">. 
[290]72<a href="#_details">More...</a>
[259]73<p>
[290]74<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
75<p>
[259]76
77<p>
[290]78<a href="classbdm_1_1bilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
[259]79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<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)" -->
82vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
83
[323]84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_91.png"> (VS: Do we really need common eval? ). <br></td></tr>
[259]85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::bilinfn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
86int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::bilinfn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
90int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</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="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="bdm::bilinfn::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
94virtual 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>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
[287]97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::bilinfn::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
[259]99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[368]101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::bilinfn::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
102virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
[353]103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::bilinfn::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
107
108<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>
[354]109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::bilinfn::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
110virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr>
[353]111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
[368]113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::bilinfn::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
114virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
[271]117<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc263f8d8d1876023a9d161d17a3c621"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="dc263f8d8d1876023a9d161d17a3c621" args="()" -->
119&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> ()</td></tr>
120
121<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)" -->
122&nbsp;</td><td class="memItemRight" valign="bottom"><b>bilinfn</b> (const mat A0, const mat B0)</td></tr>
123
124<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)" -->
125void&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>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
128<tr><td colspan="2"><div class="groupHeader">Mathematical operations</div></td></tr>
[296]129<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)" -->
130vec&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]131
[323]132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_91.png">. <br></td></tr>
[271]133<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>
134
[323]135<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_92.png"> and writes result into <code>A</code> .  <a href="#33066f1054dd259df2ec5fafae4b46e6"></a><br></td></tr>
[271]136<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>
137
[323]138<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_94.png"> and writes result into <code>A</code> .  <a href="#9cfe2f1c115ba7c3c75849a10a4f2c08"></a><br></td></tr>
[259]139<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::bilinfn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
141<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>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::bilinfn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" 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#a8e3e861d5ec2a7ae9524e6338e58320">rvu</a></td></tr>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::bilinfn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
149int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
152<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::bilinfn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
153int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::bilinfn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
160</table>
[290]161<hr><a name="_details"></a><h2>Detailed Description</h2>
[323]162Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_90.png">. <hr><h2>Member Function Documentation</h2>
[290]163<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]164<div class="memitem">
165<div class="memproto">
166      <table class="memname">
167        <tr>
[290]168          <td class="memname">void bdm::bilinfn::dfdu_cond           </td>
[259]169          <td>(</td>
170          <td class="paramtype">const vec &amp;&nbsp;</td>
171          <td class="paramname"> <em>x0</em>, </td>
172        </tr>
173        <tr>
174          <td class="paramkey"></td>
175          <td></td>
176          <td class="paramtype">const vec &amp;&nbsp;</td>
177          <td class="paramname"> <em>u0</em>, </td>
178        </tr>
179        <tr>
180          <td class="paramkey"></td>
181          <td></td>
182          <td class="paramtype">mat &amp;&nbsp;</td>
183          <td class="paramname"> <em>A</em>, </td>
184        </tr>
185        <tr>
186          <td class="paramkey"></td>
187          <td></td>
188          <td class="paramtype">bool&nbsp;</td>
[290]189          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
[259]190        </tr>
191        <tr>
192          <td></td>
193          <td>)</td>
194          <td></td><td></td><td><code> [inline, virtual]</code></td>
195        </tr>
196      </table>
197</div>
198<div class="memdoc">
199
200<p>
[323]201Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_94.png"> and writes result into <code>A</code> .
[259]202<p>
203<dl compact><dt><b>Parameters:</b></dt><dd>
204  <table border="0" cellspacing="2" cellpadding="0">
205    <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>
[354]206    <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>
[323]207    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_93.png"> </td></tr>
[259]208    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
209  </table>
210</dl>
211
[290]212<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
[259]213
214</div>
215</div><p>
[290]216<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]217<div class="memitem">
218<div class="memproto">
219      <table class="memname">
220        <tr>
[290]221          <td class="memname">void bdm::bilinfn::dfdx_cond           </td>
[259]222          <td>(</td>
223          <td class="paramtype">const vec &amp;&nbsp;</td>
224          <td class="paramname"> <em>x0</em>, </td>
225        </tr>
226        <tr>
227          <td class="paramkey"></td>
228          <td></td>
229          <td class="paramtype">const vec &amp;&nbsp;</td>
230          <td class="paramname"> <em>u0</em>, </td>
231        </tr>
232        <tr>
233          <td class="paramkey"></td>
234          <td></td>
235          <td class="paramtype">mat &amp;&nbsp;</td>
236          <td class="paramname"> <em>A</em>, </td>
237        </tr>
238        <tr>
239          <td class="paramkey"></td>
240          <td></td>
241          <td class="paramtype">bool&nbsp;</td>
[290]242          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
[259]243        </tr>
244        <tr>
245          <td></td>
246          <td>)</td>
247          <td></td><td></td><td><code> [inline, virtual]</code></td>
248        </tr>
249      </table>
250</div>
251<div class="memdoc">
252
253<p>
[323]254Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_92.png"> and writes result into <code>A</code> .
[259]255<p>
256<dl compact><dt><b>Parameters:</b></dt><dd>
257  <table border="0" cellspacing="2" cellpadding="0">
258    <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>
[354]259    <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>
[323]260    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_93.png"> </td></tr>
[259]261    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
262  </table>
263</dl>
264
[290]265<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
[259]266
267</div>
268</div><p>
[296]269<hr>The documentation for this class was generated from the following file:<ul>
270<li><a class="el" href="libFN_8h-source.html">libFN.h</a></ul>
[259]271</div>
[375]272<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 13:47:08 2009 for mixpp by&nbsp;
[259]273<a href="http://www.doxygen.org/index.html">
[290]274<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
[259]275</body>
276</html>
Note: See TracBrowser for help on using the browser.