root/doc/html/classbdm_1_1bilinfn.html @ 269

Revision 269, 16.7 kB (checked in by smidl, 17 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="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[259]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[259]22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
[261]27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1bilinfn.html">bilinfn</a>
[259]28  </div>
29</div>
30<div class="contents">
31<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_48.png">. 
32<a href="#_details">More...</a>
33<p>
34<code>#include &lt;<a class="el" href="libFN_8h-source.html">libFN.h</a>&gt;</code>
35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::bilinfn:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1bilinfn__inherit__graph.png" border="0" usemap="#bdm_1_1bilinfn__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1bilinfn__inherit__map">
[261]41<area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="12,161,111,188"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
[259]42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43<div class="dynheader">
44Collaboration diagram for bdm::bilinfn:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1bilinfn__coll__graph.png" border="0" usemap="#bdm_1_1bilinfn__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1bilinfn__coll__map">
[261]48<area shape="rect" href="classbdm_1_1diffbifn.html" title="Class representing a differentiable function of two variables ." alt="" coords="29,199,128,225"><area shape="rect" href="classbdm_1_1fnc.html" title="Class representing function &#160;of variable &#160;represented by rv." alt="" coords="5,87,83,113"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="45,7,157,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="107,87,181,113"></map>
[259]49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
50
51<p>
52<a href="classbdm_1_1bilinfn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
53<tr><td></td></tr>
54<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e36a16e72e7f9fedf3cb18d2d5505a24"></a><!-- doxytag: member="bdm::bilinfn::eval" ref="e36a16e72e7f9fedf3cb18d2d5505a24" args="(const vec &amp;x0, const vec &amp;u0)" -->
56vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#e36a16e72e7f9fedf3cb18d2d5505a24">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png">. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e86e5081f13964ee64342f8e988032c"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="1e86e5081f13964ee64342f8e988032c" args="(const RV &amp;rvx0, const RV &amp;rvu0)" -->
60&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#1e86e5081f13964ee64342f8e988032c">bilinfn</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvx0, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvu0)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c99f91d7752e131275b219df731868bd"></a><!-- doxytag: member="bdm::bilinfn::bilinfn" ref="c99f91d7752e131275b219df731868bd" args="(const RV &amp;rvx0, const RV &amp;rvu0, const mat &amp;A0, const mat &amp;B0)" -->
64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bilinfn.html#c99f91d7752e131275b219df731868bd">bilinfn</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvx0, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvu0, const mat &amp;A0, const mat &amp;B0)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alternative constructor. <br></td></tr>
67<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>
68
69<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_1.png"> and writes result into <code>A</code> .  <a href="#33066f1054dd259df2ec5fafae4b46e6"></a><br></td></tr>
70<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>
71
72<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_2.png"> and writes result into <code>A</code> .  <a href="#9cfe2f1c115ba7c3c75849a10a4f2c08"></a><br></td></tr>
73<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)" -->
74vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_49.png"> (VS: Do we really need common eval? ). <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="bdm::bilinfn::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
78int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="bdm::bilinfn::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
82int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
85<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)" -->
86virtual 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>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2277a400fc9f4d6c0bf24dc7156183f"></a><!-- doxytag: member="bdm::bilinfn::_dimy" ref="a2277a400fc9f4d6c0bf24dc7156183f" args="() const " -->
90int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#a2277a400fc9f4d6c0bf24dc7156183f">_dimy</a> () const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
93<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="bdm::bilinfn::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
95<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>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="bdm::bilinfn::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
99<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>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="bdm::bilinfn::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
103int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="bdm::bilinfn::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
107int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::bilinfn::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
111int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
114</table>
115<hr><a name="_details"></a><h2>Detailed Description</h2>
116Class representing function <img class="formulaInl" alt="$f(x,u) = Ax+Bu$" src="form_48.png">. <hr><h2>Member Function Documentation</h2>
117<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)" -->
118<div class="memitem">
119<div class="memproto">
120      <table class="memname">
121        <tr>
122          <td class="memname">void bdm::bilinfn::dfdx_cond           </td>
123          <td>(</td>
124          <td class="paramtype">const vec &amp;&nbsp;</td>
125          <td class="paramname"> <em>x0</em>, </td>
126        </tr>
127        <tr>
128          <td class="paramkey"></td>
129          <td></td>
130          <td class="paramtype">const vec &amp;&nbsp;</td>
131          <td class="paramname"> <em>u0</em>, </td>
132        </tr>
133        <tr>
134          <td class="paramkey"></td>
135          <td></td>
136          <td class="paramtype">mat &amp;&nbsp;</td>
137          <td class="paramname"> <em>A</em>, </td>
138        </tr>
139        <tr>
140          <td class="paramkey"></td>
141          <td></td>
142          <td class="paramtype">bool&nbsp;</td>
143          <td class="paramname"> <em>full</em></td><td>&nbsp;</td>
144        </tr>
145        <tr>
146          <td></td>
147          <td>)</td>
148          <td></td><td></td><td><code> [inline, virtual]</code></td>
149        </tr>
150      </table>
151</div>
152<div class="memdoc">
153
154<p>
155Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_1.png"> and writes result into <code>A</code> .
156<p>
157<dl compact><dt><b>Parameters:</b></dt><dd>
158  <table border="0" cellspacing="2" cellpadding="0">
159    <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>
160    <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>
161    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
162    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
163  </table>
164</dl>
165
166<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
167
168</div>
169</div><p>
170<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)" -->
171<div class="memitem">
172<div class="memproto">
173      <table class="memname">
174        <tr>
175          <td class="memname">void bdm::bilinfn::dfdu_cond           </td>
176          <td>(</td>
177          <td class="paramtype">const vec &amp;&nbsp;</td>
178          <td class="paramname"> <em>x0</em>, </td>
179        </tr>
180        <tr>
181          <td class="paramkey"></td>
182          <td></td>
183          <td class="paramtype">const vec &amp;&nbsp;</td>
184          <td class="paramname"> <em>u0</em>, </td>
185        </tr>
186        <tr>
187          <td class="paramkey"></td>
188          <td></td>
189          <td class="paramtype">mat &amp;&nbsp;</td>
190          <td class="paramname"> <em>A</em>, </td>
191        </tr>
192        <tr>
193          <td class="paramkey"></td>
194          <td></td>
195          <td class="paramtype">bool&nbsp;</td>
196          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
197        </tr>
198        <tr>
199          <td></td>
200          <td>)</td>
201          <td></td><td></td><td><code> [inline, virtual]</code></td>
202        </tr>
203      </table>
204</div>
205<div class="memdoc">
206
207<p>
208Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_2.png"> and writes result into <code>A</code> .
209<p>
210<dl compact><dt><b>Parameters:</b></dt><dd>
211  <table border="0" cellspacing="2" cellpadding="0">
212    <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>
213    <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>
214    <tr><td valign="top"></td><td valign="top"><em>u0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$u$" src="form_50.png"> </td></tr>
215    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
216  </table>
217</dl>
218
219<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">bdm::diffbifn</a>.</p>
220
221</div>
222</div><p>
223<hr>The documentation for this class was generated from the following files:<ul>
[261]224<li><a class="el" href="libFN_8h-source.html">libFN.h</a><li>libFN.cpp</ul>
[259]225</div>
[269]226<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:21:08 2009 for mixpp by&nbsp;
[259]227<a href="http://www.doxygen.org/index.html">
228<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
229</body>
230</html>
Note: See TracBrowser for help on using the browser.