Changeset 608 for library/doc/html/classbdm_1_1ArxDS.html

Timestamp:

09/12/09 11:41:43 (15 years ago)

Author:

smidl

Message:

doc

Files:

• library/doc/html/classbdm_1_1ArxDS.html (modified) (7 diffs)

library/doc/html/classbdm_1_1ArxDS.html

@@ -94 +94 @@
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57dfa26b23cc03d53b123fa7e0474b19"></a><!-- doxytag: member="bdm::ArxDS::step" ref="a57dfa26b23cc03d53b123fa7e0474b19" args="()" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a57dfa26b23cc03d53b123fa7e0474b19">step</a> ()</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_12.png"/> to <img class="formulaInl" alt="$ t+1 $" src="form_13.png"/>, i.e. perfroms the actions and reads response of the system. <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_18.png"/> to <img class="formulaInl" alt="$ t+1 $" src="form_19.png"/>, i.e. perfroms the actions and reads response of the system. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c8b418677a48041adacac8e8e9c9849"></a><!-- doxytag: member="bdm::ArxDS::ArxDS" ref="a7c8b418677a48041adacac8e8e9c9849" args="()" -->
 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a7c8b418677a48041adacac8e8e9c9849">ArxDS</a> ()</td></tr>
@@ -114 +114 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> for logging into <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a> L. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a9b109ee7bba9774057b107383b6ecc24">from_setting</a> (const Setting &amp;set)</td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="aed2113851294ed96abe60fc3f05aa660" args="() const " -->
-virtual <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#aed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
+virtual const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a069497b610296be053d862a2493be0ce">_drv</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::ArxDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
 const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aa6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821297dfd839d68691324f024e57252f"></a><!-- doxytag: member="bdm::ArxDS::set_drv" ref="a821297dfd839d68691324f024e57252f" args="(const RV &amp;drv, const RV &amp;urv)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a821297dfd839d68691324f024e57252f">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;drv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::ArxDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " -->
+const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ac09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::ArxDS::set_drv" ref="a3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3a92d77fd97fdb6bf1c8edb1e38c6bbc">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;yrv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::ArxDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
@@ -138 +141 @@
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa11a3f3fbeea1d17b66b073017964597"></a><!-- doxytag: member="bdm::ArxDS::H" ref="aa11a3f3fbeea1d17b66b073017964597" args="" -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#aa11a3f3fbeea1d17b66b073017964597">H</a></td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">History, ordered as <img class="formulaInl" alt="$[y_t, u_t, y_{t-1 }, u_{t-1}, \ldots]$" src="form_17.png"/>. <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">History, ordered as <img class="formulaInl" alt="$[y_t, u_t, y_{t-1 }, u_{t-1}, \ldots]$" src="form_24.png"/>. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a392b87be85675cb3d55fa4953d671bb5"></a><!-- doxytag: member="bdm::ArxDS::U" ref="a392b87be85675cb3d55fa4953d671bb5" args="" -->
 vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#a392b87be85675cb3d55fa4953d671bb5">U</a></td></tr>
@@ -162 +165 @@
 int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dt_size</b></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::ArxDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code> <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::ArxDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
-int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::ArxDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::ArxDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
 <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#ad8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
@@ -171 +179 @@
 <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#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::ArxDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
+<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#aeb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::ArxDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
@@ -197 +208 @@
 <p><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> using factorized description!</p>
 <p>The <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> is constructed from a structure with fields: </p>
-<div class="fragment"><pre class="fragment">        system = {
-                type = <span class="stringliteral">&quot;ArxDS&quot;</span>;
-                <span class="comment">// description of y variables</span>
-                y = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[<span class="stringliteral">&quot;y&quot;</span>, <span class="stringliteral">&quot;u&quot;</span>];};
-                <span class="comment">// description of u variable</span>
-                u = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[];}
-                <span class="comment">// description of regressor</span>
-                <a class="code" href="classbdm_1_1ArxDS.html#ab2d7530264499b92c3aa32454b960abe" title="temporary variable for regressor">rgr</a> = {type=<span class="stringliteral">&quot;rv&quot;</span>;
-                        names = [<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;u&quot;</span>];
-                        times = [-1, -2, -3, -1];
-                }
-
-                <span class="comment">// theta</span>
-                theta = [0.8, -0.3, 0.4, 1.0,
-                                 0.0, 0.0, 0.0, 0.0];
-                <span class="comment">// offset (optional)</span>
-                offset = [0.0, 0.0];
-                <span class="comment">//variance</span>
-                r = [0.1, 0.0,
-                         0.0, 1.0];
-                <span class="comment">//options: L_theta = log value of theta,</span>
-                opt = <span class="stringliteral">&quot;L_theta&quot;</span>;
-        };
+<div class="fragment"><pre class="fragment">                system = {
+                        type = <span class="stringliteral">&quot;ArxDS&quot;</span>;
+                        <span class="comment">// description of y variables</span>
+                        y = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[<span class="stringliteral">&quot;y&quot;</span>, <span class="stringliteral">&quot;u&quot;</span>];};
+                        <span class="comment">// description of u variable</span>
+                        u = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[];}
+                        <span class="comment">// description of regressor</span>
+                        <a class="code" href="classbdm_1_1ArxDS.html#ab2d7530264499b92c3aa32454b960abe" title="temporary variable for regressor">rgr</a> = {type=<span class="stringliteral">&quot;rv&quot;</span>;
+                                names = [<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;y&quot;</span>,<span class="stringliteral">&quot;u&quot;</span>];
+                                times = [-1, -2, -3, -1];
+                        }
+
+                        <span class="comment">// theta</span>
+                        theta = [0.8, -0.3, 0.4, 1.0,
+                                         0.0, 0.0, 0.0, 0.0];
+                        <span class="comment">// offset (optional)</span>
+                        offset = [0.0, 0.0];
+                        <span class="comment">//variance</span>
+                        r = [0.1, 0.0,
+                                 0.0, 1.0];
+                        <span class="comment">//options: L_theta = log value of theta,</span>
+                        opt = <span class="stringliteral">&quot;L_theta&quot;</span>;
+                };
 </pre></div><p>Result is <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data source offering with full history as Drv. </p>
 
 <p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
 
-<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, <a class="el" href="datasources_8h_source.html#l00180">set_drv()</a>, <a class="el" href="datasources_8h_source.html#l00200">set_options()</a>, and <a class="el" href="datasources_8h_source.html#l00176">set_parameters()</a>.</p>
+<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, <a class="el" href="datasources_8h_source.html#l00282">set_drv()</a>, <a class="el" href="datasources_8h_source.html#l00302">set_options()</a>, and <a class="el" href="datasources_8h_source.html#l00278">set_parameters()</a>.</p>
 
 </div>
@@ -233 +244 @@
 </ul>
 </div>
-<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp;
+<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>