Show
Ignore:
Timestamp:
02/09/09 23:08:46 (16 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/html/classbdm_1_1DS.html

    r259 r261  
    1212      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li> 
    1313      <li><a href="modules.html"><span>Modules</span></a></li> 
    14       <li class="current"><a href="annotated.html"><span>Classes</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> 
    1516      <li><a href="files.html"><span>Files</span></a></li> 
    1617    </ul> 
    … …  
    1819  <div class="tabs"> 
    1920    <ul> 
     21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li> 
    2022      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> 
    2123      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li> 
    … …  
    2325    </ul> 
    2426  </div> 
    25   <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1DS.html">DS</a> 
     27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1DS.html">DS</a> 
    2628  </div> 
    2729</div> 
    2830<div class="contents"> 
    29 <h1>bdm::DS Class Reference</h1><!-- doxytag: class="bdm::DS" -->Abstract class for discrete-time sources of data.   
     31<h1>bdm::DS Class Reference</h1><!-- doxytag: class="bdm::DS" --><!-- doxytag: inherits="bdm::bdmroot" -->Abstract class for discrete-time sources of data.   
    3032<a href="#_details">More...</a> 
    3133<p> 
    … …  
    3739<p><center><img src="classbdm_1_1DS__inherit__graph.png" border="0" usemap="#bdm_1_1DS__inherit__map" alt="Inheritance graph"></center> 
    3840<map name="bdm_1_1DS__inherit__map"> 
    39 <area shape="rect" href="classbdm_1_1MemDS.html" title="Class representing off&#45;line data stored in memory." alt="" coords="5,84,115,111"><area shape="rect" href="classpmsmDS.html" title="Simulator of PMSM machine with predefined profile on omega." alt="" coords="139,84,219,111"></map> 
     41<area shape="rect" href="classbdm_1_1ArxDS.html" title="Generator of ARX data." alt="" coords="5,161,104,188"><area shape="rect" href="classbdm_1_1MemDS.html" title="Memory storage of off&#45;line data column&#45;wise." alt="" coords="128,161,237,188"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="63,7,175,33"></map> 
    4042<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    4143<div class="dynheader"> 
    … …  
    4446<p><center><img src="classbdm_1_1DS__coll__graph.png" border="0" usemap="#bdm_1_1DS__coll__map" alt="Collaboration graph"></center> 
    4547<map name="bdm_1_1DS__coll__map"> 
    46 <area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="12,87,87,113"><area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="5,7,93,33"></map> 
     48<area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="72,87,147,113"></map> 
    4749<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> 
    4850 
    … …  
    5153<tr><td></td></tr> 
    5254<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    53 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbffe794e02eb88b5856b83119b7c23c"></a><!-- doxytag: member="bdm::DS::getdata" ref="cbffe794e02eb88b5856b83119b7c23c" args="(vec &amp;dt)" --> 
    54 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#cbffe794e02eb88b5856b83119b7c23c">getdata</a> (vec &amp;dt)</td></tr> 
     55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf34c9273f54cb706354fe81af3a9c1a"></a><!-- doxytag: member="bdm::DS::DS" ref="bf34c9273f54cb706354fe81af3a9c1a" args="(const RV &amp;Drv0, const RV &amp;Urv0)" --> 
     56&nbsp;</td><td class="memItemRight" valign="bottom"><b>DS</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;Drv0, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;Urv0)</td></tr> 
     57 
     58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1ec862dec7164fee3284c6f9a51b0ba"></a><!-- doxytag: member="bdm::DS::getdata" ref="c1ec862dec7164fee3284c6f9a51b0ba" args="(vec &amp;dt)" --> 
     59virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba">getdata</a> (vec &amp;dt)</td></tr> 
    5560 
    5661<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr> 
    57 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78b6b53e58c0759a673138117aba03d1"></a><!-- doxytag: member="bdm::DS::getdata" ref="78b6b53e58c0759a673138117aba03d1" args="(vec &amp;dt, ivec &amp;indeces)" --> 
    58 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#78b6b53e58c0759a673138117aba03d1">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr> 
     62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0bf451c7fea73ff4150ff9e83da4832"></a><!-- doxytag: member="bdm::DS::getdata" ref="a0bf451c7fea73ff4150ff9e83da4832" args="(vec &amp;dt, const ivec &amp;indeces)" --> 
     63virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a0bf451c7fea73ff4150ff9e83da4832">getdata</a> (vec &amp;dt, const ivec &amp;indeces)</td></tr> 
    5964 
    6065<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr> 
    61 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="653a30e5bb76fb231429dae52216c851"></a><!-- doxytag: member="bdm::DS::write" ref="653a30e5bb76fb231429dae52216c851" args="(vec &amp;ut)" --> 
    62 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#653a30e5bb76fb231429dae52216c851">write</a> (vec &amp;ut)</td></tr> 
     66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5baeee8528e5e4c5c7a344b2e3f192a"></a><!-- doxytag: member="bdm::DS::write" ref="f5baeee8528e5e4c5c7a344b2e3f192a" args="(vec &amp;ut)" --> 
     67virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a">write</a> (vec &amp;ut)</td></tr> 
    6368 
    6469<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr> 
    65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87a8b6284611b008c8aadb7235f1939a"></a><!-- doxytag: member="bdm::DS::write" ref="87a8b6284611b008c8aadb7235f1939a" args="(vec &amp;ut, ivec &amp;indeces)" --> 
    66 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#87a8b6284611b008c8aadb7235f1939a">write</a> (vec &amp;ut, ivec &amp;indeces)</td></tr> 
     70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::DS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" --> 
     71virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr> 
    6772 
    6873<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr> 
    69 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#edd136e9046c08ac615cbe3c741de21e">linkrvs</a> (<a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr> 
    70  
    71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.  <a href="#edd136e9046c08ac615cbe3c741de21e"></a><br></td></tr> 
    72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="478b4438640c36e7dca1c269a31ff11e"></a><!-- doxytag: member="bdm::DS::step" ref="478b4438640c36e7dca1c269a31ff11e" args="()" --> 
    73 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#478b4438640c36e7dca1c269a31ff11e">step</a> ()</td></tr> 
     74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a14c64d881e838ddc3a5617ee8a973b"></a><!-- doxytag: member="bdm::DS::step" ref="9a14c64d881e838ddc3a5617ee8a973b" args="()=0" --> 
     75virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9a14c64d881e838ddc3a5617ee8a973b">step</a> ()=0</td></tr> 
    7476 
    7577<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$t$" src="form_38.png"> to <img class="formulaInl" alt="$t+1$" src="form_39.png">, i.e. perfroms the actions and reads response of the system. <br></td></tr> 
    … …  
    7880<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr> 
    7981 
    80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#cbffe794e02eb88b5856b83119b7c23c" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr> 
     82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Observed variables, returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data.">getdata()</a></code>. <br></td></tr> 
    8183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::DS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" --> 
    8284<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr> 
    8385 
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classbdm_1_1DS.html#653a30e5bb76fb231429dae52216c851" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr> 
     86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Action variables, accepted by <code><a class="el" href="classbdm_1_1DS.html#f5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br></td></tr> 
    8587</table> 
    8688<hr><a name="_details"></a><h2>Detailed Description</h2> 
    8789Abstract class for discrete-time sources of data.  
    8890<p> 
    89 The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). <hr><h2>Member Function Documentation</h2> 
    90 <a class="anchor" name="edd136e9046c08ac615cbe3c741de21e"></a><!-- doxytag: member="bdm::DS::linkrvs" ref="edd136e9046c08ac615cbe3c741de21e" args="(RV &amp;drv, RV &amp;urv)" --> 
    91 <div class="memitem"> 
    92 <div class="memproto"> 
    93       <table class="memname"> 
    94         <tr> 
    95           <td class="memname">void bdm::DS::linkrvs           </td> 
    96           <td>(</td> 
    97           <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td> 
    98           <td class="paramname"> <em>drv</em>, </td> 
    99         </tr> 
    100         <tr> 
    101           <td class="paramkey"></td> 
    102           <td></td> 
    103           <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td> 
    104           <td class="paramname"> <em>urv</em></td><td>&nbsp;</td> 
    105         </tr> 
    106         <tr> 
    107           <td></td> 
    108           <td>)</td> 
    109           <td></td><td></td><td></td> 
    110         </tr> 
    111       </table> 
     91The class abstracts operations of: (i) data aquisition, (ii) data-preprocessing, (iii) scaling of data, and (iv) data resampling from the task of estimation and control. Moreover, for controlled systems, it is able to receive the desired control action and perform it in the next step. (Or as soon as possible). <hr>The documentation for this class was generated from the following file:<ul> 
     92<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul> 
    11293</div> 
    113 <div class="memdoc"> 
    114  
    115 <p> 
    116 Method that assigns random variables to the datasource. Typically, the datasource will be constructed without knowledge of random variables. This method will associate existing variables with RVs.  
    117 <p> 
    118 (Inherited from m3k, may be deprecated soon).  
    119 <p>Reimplemented in <a class="el" href="classbdm_1_1MemDS.html#5f72b555e0e4a61de1440c457cf57007">bdm::MemDS</a>.</p> 
    120  
    121 </div> 
    122 </div><p> 
    123 <hr>The documentation for this class was generated from the following file:<ul> 
    124 <li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a></ul> 
    125 </div> 
    126 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:31:23 2009 for mixpp by&nbsp; 
     94<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 15:29:53 2009 for mixpp by&nbsp; 
    12795<a href="http://www.doxygen.org/index.html"> 
    12896<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>