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

Revision 591, 18.7 kB (checked in by smidl, 15 years ago)

doc

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