root/library/doc/html/classbdm_1_1diffbifn.html @ 614

Revision 614, 18.0 kB (checked in by smidl, 15 years ago)

doc

Line 
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"/>
5<title>mixpp: bdm::diffbifn Class Reference</title>
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 -->
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>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
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>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
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>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1diffbifn.html">diffbifn</a>
70  </div>
71</div>
72<div class="contents">
73<h1>bdm::diffbifn Class Reference</h1><!-- doxytag: class="bdm::diffbifn" --><!-- doxytag: inherits="bdm::fnc" -->
74<p>Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_50.png"/>. 
75<a href="#_details">More...</a></p>
76
77<p><code>#include &lt;<a class="el" href="functions_8h_source.html">functions.h</a>&gt;</code></p>
78
79<p><a href="classbdm_1_1diffbifn-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::diffbifn::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_52.png"/> (VS: Do we really need common eval? ). <br/></td></tr>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5462c05b58cd38367ff946836bb82d3"></a><!-- doxytag: member="bdm::diffbifn::eval" ref="ab5462c05b58cd38367ff946836bb82d3" args="(const vec &amp;x0, const vec &amp;u0)" -->
86virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#ab5462c05b58cd38367ff946836bb82d3">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_52.png"/>. <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a651184f808a35f236dbfea21aca1b6ac">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
89<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="#a651184f808a35f236dbfea21aca1b6ac"></a><br/></td></tr>
90<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a6ea1dc7a482601b29c5ba36a52d20d07">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
91<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="#a6ea1dc7a482601b29c5ba36a52d20d07"></a><br/></td></tr>
92<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92ff29d748e445b440453a38d0b09681"></a><!-- doxytag: member="bdm::diffbifn::diffbifn" ref="a92ff29d748e445b440453a38d0b09681" args="()" -->
93&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a92ff29d748e445b440453a38d0b09681">diffbifn</a> ()</td></tr>
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor (dimy is not set!). <br/></td></tr>
95<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::diffbifn::_dimx" ref="a1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
96int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
98<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::diffbifn::_dimu" ref="a031458f38c97cdb3aecde16f6a06dced" args="() const " -->
99int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
101<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="bdm::diffbifn::condition" ref="a0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
102virtual 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>
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br/></td></tr>
104<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::diffbifn::dimension" ref="a083832294da9d1e40804158b979c4341" args="() const " -->
105int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::diffbifn::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
108virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::diffbifn::from_setting" ref="a0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
111virtual 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>
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>
113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::diffbifn::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
114virtual 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>
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
116<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::diffbifn::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
117virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
119<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::diffbifn::rvx" ref="a5f56547d8e9378b669d3cc19d7831cbb" args="" -->
121<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>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br/></td></tr>
123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::diffbifn::rvu" ref="aa8e3e861d5ec2a7ae9524e6338e58320" args="" -->
124<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>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::diffbifn::dimx" ref="aa193aa2c4a500139c0c4b669691e588e" args="" -->
127int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#aa193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br/></td></tr>
129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::diffbifn::dimu" ref="a30c45617eec89adeb4ebaa763d093fb0" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br/></td></tr>
132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::diffbifn::dimy" ref="a52156cb4a52a62d51fc7455985797a62" args="" -->
133int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br/></td></tr>
135</table>
136<hr/><a name="_details"></a><h2>Detailed Description</h2>
137<p>Class representing a differentiable function of two variables <img class="formulaInl" alt="$f(x,u)$" src="form_50.png"/>. </p>
138<p>Function of two variables.</p>
139<p>TODO: 1) Technically, it could have a common parent (e.g. <code><a class="el" href="classbdm_1_1fnc.html" title="Class representing function  of variable  represented by rv.">fnc</a></code> ) with other functions. For now, we keep it as it is. 2) It could be generalized into multivariate form, (which was original meaning of <code><a class="el" href="classbdm_1_1fnc.html" title="Class representing function  of variable  represented by rv.">fnc</a></code> ). </p>
140<hr/><h2>Member Function Documentation</h2>
141<a class="anchor" id="a6ea1dc7a482601b29c5ba36a52d20d07"></a><!-- doxytag: member="bdm::diffbifn::dfdu_cond" ref="a6ea1dc7a482601b29c5ba36a52d20d07" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
142<div class="memitem">
143<div class="memproto">
144      <table class="memname">
145        <tr>
146          <td class="memname">virtual void bdm::diffbifn::dfdu_cond </td>
147          <td>(</td>
148          <td class="paramtype">const vec &amp;&nbsp;</td>
149          <td class="paramname"> <em>x0</em>, </td>
150        </tr>
151        <tr>
152          <td class="paramkey"></td>
153          <td></td>
154          <td class="paramtype">const vec &amp;&nbsp;</td>
155          <td class="paramname"> <em>u0</em>, </td>
156        </tr>
157        <tr>
158          <td class="paramkey"></td>
159          <td></td>
160          <td class="paramtype">mat &amp;&nbsp;</td>
161          <td class="paramname"> <em>A</em>, </td>
162        </tr>
163        <tr>
164          <td class="paramkey"></td>
165          <td></td>
166          <td class="paramtype">bool&nbsp;</td>
167          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
168        </tr>
169        <tr>
170          <td></td>
171          <td>)</td>
172          <td></td><td></td><td><code> [inline, virtual]</code></td>
173        </tr>
174      </table>
175</div>
176<div class="memdoc">
177
178<p>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> . </p>
179<dl><dt><b>Parameters:</b></dt><dd>
180  <table border="0" cellspacing="2" cellpadding="0">
181    <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>
182    <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>
183    <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>
184    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
185  </table>
186  </dd>
187</dl>
188
189<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#a9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>.</p>
190
191</div>
192</div>
193<a class="anchor" id="a651184f808a35f236dbfea21aca1b6ac"></a><!-- doxytag: member="bdm::diffbifn::dfdx_cond" ref="a651184f808a35f236dbfea21aca1b6ac" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
194<div class="memitem">
195<div class="memproto">
196      <table class="memname">
197        <tr>
198          <td class="memname">virtual void bdm::diffbifn::dfdx_cond </td>
199          <td>(</td>
200          <td class="paramtype">const vec &amp;&nbsp;</td>
201          <td class="paramname"> <em>x0</em>, </td>
202        </tr>
203        <tr>
204          <td class="paramkey"></td>
205          <td></td>
206          <td class="paramtype">const vec &amp;&nbsp;</td>
207          <td class="paramname"> <em>u0</em>, </td>
208        </tr>
209        <tr>
210          <td class="paramkey"></td>
211          <td></td>
212          <td class="paramtype">mat &amp;&nbsp;</td>
213          <td class="paramname"> <em>A</em>, </td>
214        </tr>
215        <tr>
216          <td class="paramkey"></td>
217          <td></td>
218          <td class="paramtype">bool&nbsp;</td>
219          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
220        </tr>
221        <tr>
222          <td></td>
223          <td>)</td>
224          <td></td><td></td><td><code> [inline, virtual]</code></td>
225        </tr>
226      </table>
227</div>
228<div class="memdoc">
229
230<p>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> . </p>
231<dl><dt><b>Parameters:</b></dt><dd>
232  <table border="0" cellspacing="2" cellpadding="0">
233    <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>
234    <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>
235    <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>
236    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
237  </table>
238  </dd>
239</dl>
240
241<p>Reimplemented in <a class="el" href="classbdm_1_1bilinfn.html#a33066f1054dd259df2ec5fafae4b46e6">bdm::bilinfn</a>.</p>
242
243</div>
244</div>
245<hr/>The documentation for this class was generated from the following file:<ul>
246<li><a class="el" href="functions_8h_source.html">functions.h</a></li>
247</ul>
248</div>
249<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:43 2009 for mixpp by&nbsp;
250<a href="http://www.doxygen.org/index.html">
251<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
252</body>
253</html>
Note: See TracBrowser for help on using the browser.