root/doc/html/classOMk1.html @ 353

Revision 353, 17.1 kB (checked in by smidl, 16 years ago)

doc

Line 
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: OMk1 Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
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>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
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>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
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>
67</div>
68<div class="contents">
69<h1>OMk1 Class Reference</h1><!-- doxytag: class="OMk1" --><!-- doxytag: inherits="bdm::diffbifn" -->model stredni hodnoty pozorovani pro k1 
70<a href="#_details">More...</a>
71<p>
72<code>#include &lt;<a class="el" href="model_8h-source.html">model.h</a>&gt;</code>
73<p>
74
75<p>
76<a href="classOMk1-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
77<tr><td></td></tr>
78<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e88ee95e5df98357069e7c3215cbdcd"></a><!-- doxytag: member="OMk1::OMk1" ref="8e88ee95e5df98357069e7c3215cbdcd" args="()" -->
80&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOMk1.html#8e88ee95e5df98357069e7c3215cbdcd">OMk1</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c12aa1b56f298cc21b22e0dde84ef8f"></a><!-- doxytag: member="OMk1::eval" ref="7c12aa1b56f298cc21b22e0dde84ef8f" args="(const vec &amp;x0, const vec &amp;u0)" -->
84vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOMk1.html#7c12aa1b56f298cc21b22e0dde84ef8f">eval</a> (const vec &amp;x0, const vec &amp;u0)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates <img class="formulaInl" alt="$f(x0,u0)$" src="form_91.png">. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOMk1.html#3a6ff61c818d25f95912351aac201cc7">dfdx_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
88
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_92.png"> and writes result into <code>A</code> .  <a href="#3a6ff61c818d25f95912351aac201cc7"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="188f31066bd72e1bf0ddacd1eb0e6af3"></a><!-- doxytag: member="OMk1::eval" ref="188f31066bd72e1bf0ddacd1eb0e6af3" args="(const vec &amp;cond)" -->
91vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#188f31066bd72e1bf0ddacd1eb0e6af3">eval</a> (const vec &amp;cond)</td></tr>
92
93<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>
94<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#6ea1dc7a482601b29c5ba36a52d20d07">dfdu_cond</a> (const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)</td></tr>
95
96<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="#6ea1dc7a482601b29c5ba36a52d20d07"></a><br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3c8f5949f13d86d2661e191d4b369b"></a><!-- doxytag: member="OMk1::_dimx" ref="1b3c8f5949f13d86d2661e191d4b369b" args="() const " -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#1b3c8f5949f13d86d2661e191d4b369b">_dimx</a> () const </td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="031458f38c97cdb3aecde16f6a06dced"></a><!-- doxytag: member="OMk1::_dimu" ref="031458f38c97cdb3aecde16f6a06dced" args="() const " -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#031458f38c97cdb3aecde16f6a06dced">_dimu</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="OMk1::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" -->
106virtual 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>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="OMk1::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " -->
110int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="OMk1::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
114virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="OMk1::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
118virtual 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>
119
120<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>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="OMk1::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" -->
122virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#a80210bbe266bf26f100f342460a313f">to_setting</a> (Setting &amp;root)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
125<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f56547d8e9378b669d3cc19d7831cbb"></a><!-- doxytag: member="OMk1::rvx" ref="5f56547d8e9378b669d3cc19d7831cbb" args="" -->
127RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#5f56547d8e9378b669d3cc19d7831cbb">rvx</a></td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the first rv. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e3e861d5ec2a7ae9524e6338e58320"></a><!-- doxytag: member="OMk1::rvu" ref="a8e3e861d5ec2a7ae9524e6338e58320" args="" -->
131RV&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a8e3e861d5ec2a7ae9524e6338e58320">rvu</a></td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indentifier of the second rv. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a193aa2c4a500139c0c4b669691e588e"></a><!-- doxytag: member="OMk1::dimx" ref="a193aa2c4a500139c0c4b669691e588e" args="" -->
135int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#a193aa2c4a500139c0c4b669691e588e">dimx</a></td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvx.count() <br></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30c45617eec89adeb4ebaa763d093fb0"></a><!-- doxytag: member="OMk1::dimu" ref="30c45617eec89adeb4ebaa763d093fb0" args="" -->
139int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1diffbifn.html#30c45617eec89adeb4ebaa763d093fb0">dimu</a></td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache for rvu.count() <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="OMk1::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" -->
143int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr>
146</table>
147<hr><a name="_details"></a><h2>Detailed Description</h2>
148model stredni hodnoty pozorovani pro k1 <hr><h2>Member Function Documentation</h2>
149<a class="anchor" name="6ea1dc7a482601b29c5ba36a52d20d07"></a><!-- doxytag: member="OMk1::dfdu_cond" ref="6ea1dc7a482601b29c5ba36a52d20d07" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
150<div class="memitem">
151<div class="memproto">
152      <table class="memname">
153        <tr>
154          <td class="memname">virtual void bdm::diffbifn::dfdu_cond           </td>
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>
175          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
176        </tr>
177        <tr>
178          <td></td>
179          <td>)</td>
180          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
181        </tr>
182      </table>
183</div>
184<div class="memdoc">
185
186<p>
187Evaluates <img class="formulaInl" alt="$A=\frac{d}{du}f(x,u)|_{x0,u0}$" src="form_94.png"> and writes result into <code>A</code> .
188<p>
189<dl compact><dt><b>Parameters:</b></dt><dd>
190  <table border="0" cellspacing="2" cellpadding="0">
191    <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>
192    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_0.png">, </td></tr>
193    <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>
194    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
195  </table>
196</dl>
197
198<p>Reimplemented in <a class="el" href="classIMk1.html#2b85f0984da3fe55849bb7b28f66e50c">IMk1</a>, <a class="el" href="classIMpmsm.html#c3f8dad22ae9855c04a1d593b45c99b5">IMpmsm</a>, <a class="el" href="classIMpmsm2o.html#27f9d89bce832056f747d985df77a726">IMpmsm2o</a>, <a class="el" href="classIMpmsmStat.html#ff740ee20100ae2a2d03a2538638f8e8">IMpmsmStat</a>, and <a class="el" href="classbdm_1_1bilinfn.html#9cfe2f1c115ba7c3c75849a10a4f2c08">bdm::bilinfn</a>.</p>
199
200</div>
201</div><p>
202<a class="anchor" name="3a6ff61c818d25f95912351aac201cc7"></a><!-- doxytag: member="OMk1::dfdx_cond" ref="3a6ff61c818d25f95912351aac201cc7" args="(const vec &amp;x0, const vec &amp;u0, mat &amp;A, bool full=true)" -->
203<div class="memitem">
204<div class="memproto">
205      <table class="memname">
206        <tr>
207          <td class="memname">void OMk1::dfdx_cond           </td>
208          <td>(</td>
209          <td class="paramtype">const vec &amp;&nbsp;</td>
210          <td class="paramname"> <em>x0</em>, </td>
211        </tr>
212        <tr>
213          <td class="paramkey"></td>
214          <td></td>
215          <td class="paramtype">const vec &amp;&nbsp;</td>
216          <td class="paramname"> <em>u0</em>, </td>
217        </tr>
218        <tr>
219          <td class="paramkey"></td>
220          <td></td>
221          <td class="paramtype">mat &amp;&nbsp;</td>
222          <td class="paramname"> <em>A</em>, </td>
223        </tr>
224        <tr>
225          <td class="paramkey"></td>
226          <td></td>
227          <td class="paramtype">bool&nbsp;</td>
228          <td class="paramname"> <em>full</em> = <code>true</code></td><td>&nbsp;</td>
229        </tr>
230        <tr>
231          <td></td>
232          <td>)</td>
233          <td></td><td></td><td><code> [inline, virtual]</code></td>
234        </tr>
235      </table>
236</div>
237<div class="memdoc">
238
239<p>
240Evaluates <img class="formulaInl" alt="$A=\frac{d}{dx}f(x,u)|_{x0,u0}$" src="form_92.png"> and writes result into <code>A</code> .
241<p>
242<dl compact><dt><b>Parameters:</b></dt><dd>
243  <table border="0" cellspacing="2" cellpadding="0">
244    <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>
245    <tr><td valign="top"></td><td valign="top"><em>x0</em>&nbsp;</td><td>numeric value of <img class="formulaInl" alt="$x$" src="form_0.png">, </td></tr>
246    <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>
247    <tr><td valign="top"></td><td valign="top"><em>A</em>&nbsp;</td><td>a place where the result will be stored. </td></tr>
248  </table>
249</dl>
250
251<p>Reimplemented from <a class="el" href="classbdm_1_1diffbifn.html#651184f808a35f236dbfea21aca1b6ac">bdm::diffbifn</a>.</p>
252
253<p>References <a class="el" href="libFN_8h-source.html#l00070">bdm::diffbifn::dimx</a>, <a class="el" href="libBM_8h-source.html#l00216">bdm::fnc::dimy</a>, and <a class="el" href="group__specmat.html#g10723ecada06221cbe64fe2736a59de1">itpp::zeros()</a>.</p>
254
255</div>
256</div><p>
257<hr>The documentation for this class was generated from the following file:<ul>
258<li><a class="el" href="model_8h-source.html">model.h</a></ul>
259</div>
260<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
261<a href="http://www.doxygen.org/index.html">
262<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
263</body>
264</html>
Note: See TracBrowser for help on using the browser.