Changeset 368 for doc/html/classbdm_1_1ArxDS.html

Timestamp:

06/08/09 18:02:55 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1ArxDS.html (modified) (3 diffs)

doc/html/classbdm_1_1ArxDS.html

@@ -123 +123 @@
 
 <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" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ArxDS.html#6b8f76d576de14824df0257582cf7a33">from_setting</a> (const Setting &amp;root)</td></tr>
+
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::ArxDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" 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#ed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>
@@ -135 +137 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::ArxDS::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
-virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::ArxDS::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
+virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::ArxDS::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
-virtual 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>
-
-<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>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::ArxDS::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::ArxDS::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7b3cc6cd059ff3d7f4462cedff4bdeb"></a><!-- doxytag: member="bdm::ArxDS::Rrv" ref="c7b3cc6cd059ff3d7f4462cedff4bdeb" args="" -->
@@ -209 +211 @@
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
-Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <hr>The documentation for this class was generated from the following files:<ul>
+Generator of <a class="el" href="classbdm_1_1ARX.html" title="Linear Autoregressive model with Gaussian noise.">ARX</a> data. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="6b8f76d576de14824df0257582cf7a33"></a><!-- doxytag: member="bdm::ArxDS::from_setting" ref="6b8f76d576de14824df0257582cf7a33" args="(const Setting &amp;root)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ArxDS::from_setting           </td>
+          <td>(</td>
+          <td class="paramtype">const Setting &amp;&nbsp;</td>
+          <td class="paramname"> <em>root</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> using factorized description!<p>
+The <a class="el" href="classbdm_1_1ArxDS.html" title="Generator of ARX data.">ArxDS</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">        system = {
+                type = <span class="stringliteral">"ArxDS"</span>;
+                <span class="comment">// description of y variables</span>
+                y = {type=<span class="stringliteral">"rv"</span>; names=[<span class="stringliteral">"y"</span>, <span class="stringliteral">"u"</span>];};
+                <span class="comment">// description of u variable</span>
+                u = {type=<span class="stringliteral">"rv"</span>; names=[];}
+                <span class="comment">// description of regressor</span>
+                <a class="code" href="classbdm_1_1ArxDS.html#b2d7530264499b92c3aa32454b960abe" title="temporary variable for regressor">rgr</a> = {type=<span class="stringliteral">"rv"</span>;
+                        names = [<span class="stringliteral">"y"</span>,<span class="stringliteral">"y"</span>,<span class="stringliteral">"y"</span>,<span class="stringliteral">"u"</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">"L_theta"</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>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p>
+
+<p>References <a class="el" href="libBM_8h-source.html#l00120">bdm::RV::_dsize()</a>, <a class="el" href="user__info_8h-source.html#l00249">bdm::UI::get()</a>, <a class="el" href="libDS_8h-source.html#l00168">set_drv()</a>, <a class="el" href="libDS_8h-source.html#l00188">set_options()</a>, and <a class="el" href="libDS_8h-source.html#l00165">set_parameters()</a>.</p>
+
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="libDS_8h-source.html">libDS.h</a><li>libDS.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>