Changeset 614 for library/doc/html/classbdm_1_1CsvFileDS.html

Timestamp:

09/13/09 23:14:58 (15 years ago)

Author:

smidl

Message:

doc

Files:

• library/doc/html/classbdm_1_1CsvFileDS.html (modified) (6 diffs)

library/doc/html/classbdm_1_1CsvFileDS.html

@@ -98 +98 @@
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a59d44ef34a523127dd79c076461c43b6">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a339a488b93f2fc37c80d9a9573fbd421"></a><!-- doxytag: member="bdm::CsvFileDS::max_length" ref="a339a488b93f2fc37c80d9a9573fbd421" args="()" -->
+int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a339a488b93f2fc37c80d9a9573fbd421">max_length</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns maximum number of provided data, by default it is set to maximum allowed length, shorter <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> should overload this method! See, <a class="el" href="classbdm_1_1MemDS.html#a339a488b93f2fc37c80d9a9573fbd421" title="Returns maximum number of provided data, by default it is set to maximum allowed...">MemDS.max_length()</a>. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6428f2778254e8304fb5a799b7f815a"></a><!-- doxytag: member="bdm::CsvFileDS::set_rvs" ref="ae6428f2778254e8304fb5a799b7f815a" args="(RV &amp;drv, RV &amp;urv)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvs</b> (<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>
@@ -111 +114 @@
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a21916feb3e5ff960855c09b06a0d279b">step</a> ()</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#afaebfe6d7a2a43421be05d8cf7d7ae45">from_setting</a> (const Setting &amp;set)</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::CsvFileDS::_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>
@@ -126 +130 @@
 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">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" align="right" valign="top"><a class="anchor" id="a0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::CsvFileDS::from_setting" ref="a0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</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" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::CsvFileDS::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
@@ -145 +146 @@
 ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a166522aed4d3b12d9b3c2afaf6673301"></a><!-- doxytag: member="bdm::CsvFileDS::delays" ref="a166522aed4d3b12d9b3c2afaf6673301" args="" -->
-ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a166522aed4d3b12d9b3c2afaf6673301">delays</a></td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of delays that are presented in Dt <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::CsvFileDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
@@ -174 +172 @@
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <p>CSV file data storage The constructor creates <code>Data</code> matrix from the records in a CSV file <code>fname</code>. The orientation can be of two types: 1. <code>BY_COL</code> which is default - the data are stored in columns; one column per time <img class="formulaInl" alt="$t$" src="form_22.png"/>, one row per data item. 2. <code>BY_ROW</code> if the data are stored the classical CSV style. Then each column stores the values for data item, for ex. <img class="formulaInl" alt="$[y_{t} y_{t-1} ...]$" src="form_23.png"/>, one row for each discrete time instant. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="afaebfe6d7a2a43421be05d8cf7d7ae45"></a><!-- doxytag: member="bdm::CsvFileDS::from_setting" ref="afaebfe6d7a2a43421be05d8cf7d7ae45" args="(const Setting &amp;set)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void bdm::MemDS::from_setting </td>
+          <td>(</td>
+          <td class="paramtype">const Setting &amp;&nbsp;</td>
+          <td class="paramname"> <em>set</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, virtual, inherited]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Create object from the following structure </p>
+<div class="fragment"><pre class="fragment">                { <span class="keyword">class </span>= &quot;<a class="code" href="classbdm_1_1MemDS.html#a1ea231f4066652996cde4826560d93e3" title="Default constructor.">MemDS</a>&quot;;
+                   <a class="code" href="classbdm_1_1MemDS.html#aa724f4cbfc32e79bacc044253234e260" title="internal matrix of data">Data</a> = (...);            <span class="comment">// Data matrix or data vector</span>
+                   --- optional ---
+                   drv = {<span class="keyword">class</span>=<span class="stringliteral">&quot;RV&quot;</span>; ...} <span class="comment">// Identification how rows of the matrix Data will be known to others</span>
+                   time = 0;               <span class="comment">// Index of the first column to user_info,</span>
+                   <a class="code" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4" title="vector of rows that are presented in Dt">rowid</a> = [1,2,3...];     <span class="comment">// ids of rows to be used</span>
+                }
+</pre></div><p>If the optional fields are not given, they will be filled as follows: </p>
+<div class="fragment"><pre class="fragment">                <a class="code" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4" title="vector of rows that are presented in Dt">rowid</a>= [0, 1, 2, ...number_of_rows_of_Data];
+                drv = {names=(<span class="stringliteral">&quot;ch0&quot;</span>, <span class="stringliteral">&quot;ch1&quot;</span>, <span class="stringliteral">&quot;ch2&quot;</span>, ...<span class="stringliteral">&quot;number_of_rows_of_Data&quot;</span>);
+                      sizes=( 1    1    1 ...);
+                          times=( 0    0    0 ...);
+                          };
+                time = 0;
+</pre></div><p> If <code>rowid</code> is given, <code>drv</code> will be named after indeces in rowids.</p>
+<p>Hence the data provided by method <code><a class="el" href="classbdm_1_1MemDS.html#a23522b9e7dd0bb0c365cc9cde4c05449" title="Returns full vector of observed data=[output, input].">getdata()</a></code> will be full column of matrix Data starting from the first record. </p>
+
+<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
+
+<p>Reimplemented in <a class="el" href="classbdm_1_1ITppFileDS.html#afd192da176625a909fa853458b604566">bdm::ITppFileDS</a>, and <a class="el" href="classbdm_1_1mxArrayDS.html#a3f8986832001f54ef808edaf3988d025">bdm::mxArrayDS</a>.</p>
+
+<p>References <a class="el" href="datasources_8h_source.html#l00032">bdm::MemDS::Data</a>, <a class="el" href="bdmbase_8h_source.html#l00951">bdm::DS::dtsize</a>, <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, <a class="el" href="datasources_8h_source.html#l00036">bdm::MemDS::rowid</a>, <a class="el" href="bdmbase_8h_source.html#l01023">bdm::DS::set_drv()</a>, <a class="el" href="datasources_8h_source.html#l00034">bdm::MemDS::time</a>, and <a class="el" href="bdmbase_8h_source.html#l00953">bdm::DS::utsize</a>.</p>
+
+</div>
+</div>
 <hr/>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="datasources_8h_source.html">datasources.h</a></li>
@@ -179 +219 @@
 </ul>
 </div>
-<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by&nbsp;
+<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:42 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>