Show
Ignore:
Timestamp:
08/29/09 20:54:10 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 copied

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1Controller.html

    r538 r590  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
    3 <title>mixpp: bdm::fnc Class Reference</title> 
     3<title>mixpp: bdm::Controller Class Reference</title> 
    44<link href="tabs.css" rel="stylesheet" type="text/css"> 
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    … …  
    6464    </ul> 
    6565  </div> 
    66   <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1fnc.html">fnc</a> 
     66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1Controller.html">Controller</a> 
    6767  </div> 
    6868</div> 
    6969<div class="contents"> 
    70 <h1>bdm::fnc Class Reference</h1><!-- doxytag: class="bdm::fnc" --><!-- doxytag: inherits="bdm::root" -->Class representing function <img class="formulaInl" alt="$f(x)$" src="form_0.png"> of variable <img class="formulaInl" alt="$x$" src="form_1.png"> represented by <code>rv</code>.   
    71 <a href="#_details">More...</a> 
    72 <p> 
    73 <code>#include &lt;<a class="el" href="bdmbase_8h-source.html">bdmbase.h</a>&gt;</code> 
     70<h1>bdm::Controller Class Reference</h1><!-- doxytag: class="bdm::Controller" --><!-- doxytag: inherits="bdm::root" --><code>#include &lt;<a class="el" href="ctrlbase_8h-source.html">ctrlbase.h</a>&gt;</code> 
    7471<p> 
    7572 
    7673<p> 
    77 <a href="classbdm_1_1fnc-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
     74<a href="classbdm_1_1Controller-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    7875<tr><td></td></tr> 
    7976<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65e9fb11f6cc7884018d8f229bcabbb7"></a><!-- doxytag: member="bdm::fnc::fnc" ref="65e9fb11f6cc7884018d8f229bcabbb7" args="()" --> 
    81 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#65e9fb11f6cc7884018d8f229bcabbb7">fnc</a> ()</td></tr> 
     77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8bf38082502020d56dbd48806018774"></a><!-- doxytag: member="bdm::Controller::adapt" ref="d8bf38082502020d56dbd48806018774" args="(const vec &amp;data)" --> 
     78virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#d8bf38082502020d56dbd48806018774">adapt</a> (const vec &amp;data)</td></tr> 
    8279 
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr> 
    84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6277b11d7fffc7ef8a2fa3e84ae5bad4"></a><!-- doxytag: member="bdm::fnc::eval" ref="6277b11d7fffc7ef8a2fa3e84ae5bad4" args="(const vec &amp;cond)" --> 
    85 virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#6277b11d7fffc7ef8a2fa3e84ae5bad4">eval</a> (const vec &amp;cond)</td></tr> 
     80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function processing new observations and adapting control strategy accordingly <br></td></tr> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7103224088fcd72bc44eeb08ad5ce180"></a><!-- doxytag: member="bdm::Controller::ctrlaction" ref="7103224088fcd72bc44eeb08ad5ce180" args="(const vec &amp;data)" --> 
     82virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#7103224088fcd72bc44eeb08ad5ce180">ctrlaction</a> (const vec &amp;data)</td></tr> 
    8683 
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function evaluates numerical value of <img class="formulaInl" alt="$f(x)$" src="form_0.png"> at <img class="formulaInl" alt="$x=$" src="form_6.png"> <code>cond</code> <br></td></tr> 
    88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0786e40fade2663a70d654c1dda5d73e"></a><!-- doxytag: member="bdm::fnc::condition" ref="0786e40fade2663a70d654c1dda5d73e" args="(const vec &amp;val)" --> 
    89 virtual 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> 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns designed control action <br></td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8dfccd2b84552efcdc7f595c021ff77"></a><!-- doxytag: member="bdm::Controller::from_setting" ref="a8dfccd2b84552efcdc7f595c021ff77" args="(const Setting &amp;set)" --> 
     86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#a8dfccd2b84552efcdc7f595c021ff77">from_setting</a> (const Setting &amp;set)</td></tr> 
    9087 
    91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function substitutes given value into an appropriate position <br></td></tr> 
    92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="083832294da9d1e40804158b979c4341"></a><!-- doxytag: member="bdm::fnc::dimension" ref="083832294da9d1e40804158b979c4341" args="() const " --> 
    93 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#083832294da9d1e40804158b979c4341">dimension</a> () const </td></tr> 
     88<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> 
     89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c5b40a9e65abc1434c8a34c9752e25d"></a><!-- doxytag: member="bdm::Controller::_urv" ref="5c5b40a9e65abc1434c8a34c9752e25d" args="()" --> 
     90const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#5c5b40a9e65abc1434c8a34c9752e25d">_urv</a> ()</td></tr> 
    9491 
    9592<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
    96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::fnc::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="258f7c6435343b088ed02a304cab99b0"></a><!-- doxytag: member="bdm::Controller::_yrv" ref="258f7c6435343b088ed02a304cab99b0" args="()" --> 
     94const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#258f7c6435343b088ed02a304cab99b0">_yrv</a> ()</td></tr> 
     95 
     96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51e1fbd42ba80789f31b5bc14068f498"></a><!-- doxytag: member="bdm::Controller::_drv" ref="51e1fbd42ba80789f31b5bc14068f498" args="()" --> 
     98const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Controller.html#51e1fbd42ba80789f31b5bc14068f498">_drv</a> ()</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="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::Controller::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
    97102virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    98103 
    99104<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" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::fnc::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" --> 
    101 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr> 
    102  
    103 <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> 
    104 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::fnc::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::Controller::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
    105106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    106107 
    107108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    108 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::fnc::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::Controller::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
    109110virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    110111 
    111112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    112 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    113 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52156cb4a52a62d51fc7455985797a62"></a><!-- doxytag: member="bdm::fnc::dimy" ref="52156cb4a52a62d51fc7455985797a62" args="" --> 
    114 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1fnc.html#52156cb4a52a62d51fc7455985797a62">dimy</a></td></tr> 
    115  
    116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of the output vector. <br></td></tr> 
    117113</table> 
    118114<hr><a name="_details"></a><h2>Detailed Description</h2> 
    119 Class representing function <img class="formulaInl" alt="$f(x)$" src="form_0.png"> of variable <img class="formulaInl" alt="$x$" src="form_1.png"> represented by <code>rv</code>. <hr>The documentation for this class was generated from the following file:<ul> 
    120 <li><a class="el" href="bdmbase_8h-source.html">bdmbase.h</a></ul> 
     115Base class for adaptive controllers The base class is however non-adaptive, method <code><a class="el" href="classbdm_1_1Controller.html#d8bf38082502020d56dbd48806018774" title="function processing new observations and adapting control strategy accordingly">adapt()</a></code> is empty. <dl class="note" compact><dt><b>Note:</b></dt><dd>advanced Controllers will probably include estimator as their internal attribute (e.g. dual controllers) </dd></dl> 
     116<hr>The documentation for this class was generated from the following file:<ul> 
     117<li><a class="el" href="ctrlbase_8h-source.html">ctrlbase.h</a></ul> 
    121118</div> 
    122 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp; 
     119<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
    123120<a href="http://www.doxygen.org/index.html"> 
    124121<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>