root/doc/html/classUIARX.html @ 269

Revision 269, 5.3 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: UIARX 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>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
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>
27</div>
28<div class="contents">
29<h1>UIARX Class Reference</h1><!-- doxytag: class="UIARX" --><!-- doxytag: inherits="bdm::UIbuilder" --><code>#include &lt;<a class="el" href="arx__ui_8h-source.html">arx_ui.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for UIARX:</div>
33<div class="dynsection">
34<p><center><img src="classUIARX__inherit__graph.png" border="0" usemap="#UIARX__inherit__map" alt="Inheritance graph"></center>
35<map name="UIARX__inherit__map">
36<area shape="rect" href="classbdm_1_1UIbuilder.html" title="Builds computational object from a UserInfo structure." alt="" coords="5,7,120,33"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for UIARX:</div>
40<div class="dynsection">
41<p><center><img src="classUIARX__coll__graph.png" border="0" usemap="#UIARX__coll__map" alt="Collaboration graph"></center>
42<map name="UIARX__coll__map">
43<area shape="rect" href="classbdm_1_1UIbuilder.html" title="Builds computational object from a UserInfo structure." alt="" coords="5,7,120,33"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classUIARX-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9ef8d41d8f10a31343d76a73b9f0f77"></a><!-- doxytag: member="UIARX::build" ref="e9ef8d41d8f10a31343d76a73b9f0f77" args="(Setting &amp;S) const " -->
51<a class="el" href="classbdm_1_1bdmroot.html">bdmroot</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUIARX.html#e9ef8d41d8f10a31343d76a73b9f0f77">build</a> (Setting &amp;S) const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function building the computational object. <br></td></tr>
54<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c514c2eb6fc6a347f15c270a32ddebd"></a><!-- doxytag: member="UIARX::getvec" ref="3c514c2eb6fc6a347f15c270a32ddebd" args="(Setting &amp;S) const " -->
56const vec&nbsp;</td><td class="memItemRight" valign="bottom"><b>getvec</b> (Setting &amp;S) const </td></tr>
57
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e78cce143622e3a0ba66af4768bc3e8"></a><!-- doxytag: member="UIARX::getmat" ref="1e78cce143622e3a0ba66af4768bc3e8" args="(Setting &amp;S, int ncols) const " -->
59const mat&nbsp;</td><td class="memItemRight" valign="bottom"><b>getmat</b> (Setting &amp;S, int ncols) const </td></tr>
60
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f0c1a56ac46342d339c8e7944639b4b"></a><!-- doxytag: member="UIARX::getivec" ref="5f0c1a56ac46342d339c8e7944639b4b" args="(Setting &amp;S) const " -->
62const vec&nbsp;</td><td class="memItemRight" valign="bottom"><b>getivec</b> (Setting &amp;S) const </td></tr>
63
64</table>
65<hr><a name="_details"></a><h2>Detailed Description</h2>
66UI for ARX estimator<p>
67The ARX is constructed from a structure with fields: <div class="fragment"><pre class="fragment">estimator = {
68    type = <span class="stringliteral">"ARX"</span>;
69        ychns = [1];
70        rgrid =  [ 1,  1,  1,  2];
71        delays = [-1, -2, -3, -1];
72
73        <span class="comment">//optional fields</span>
74        dV0 = [1e-3, 1e-5, 1e-5, 1e-5]; <span class="comment">//default: 1e-3 for y, 1e-5 for rgr</span>
75        nu0 = 6;      <span class="comment">//default: rgrlen + 2</span>
76        frg = 1.0;    <span class="comment">// forgetting, default frg=1.0</span>
77};
78</pre></div> <hr>The documentation for this class was generated from the following file:<ul>
79<li><a class="el" href="arx__ui_8h-source.html">arx_ui.h</a></ul>
80</div>
81<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:20:23 2009 for mixpp by&nbsp;
82<a href="http://www.doxygen.org/index.html">
83<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
84</body>
85</html>
Note: See TracBrowser for help on using the browser.