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

Timestamp:

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

Author:

smidl

Message:

doc

Files:

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

library/doc/html/classbdm_1_1MemDS.html

@@ -80 +80 @@
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a339a488b93f2fc37c80d9a9573fbd421"></a><!-- doxytag: member="bdm::MemDS::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="a23522b9e7dd0bb0c365cc9cde4c05449"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="a23522b9e7dd0bb0c365cc9cde4c05449" args="(vec &amp;dt)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a23522b9e7dd0bb0c365cc9cde4c05449">getdata</a> (vec &amp;dt)</td></tr>
@@ -99 +102 @@
 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a1ea231f4066652996cde4826560d93e3">MemDS</a> ()</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf4cb6fb424f7fedfd7396f60951bbb1"></a><!-- doxytag: member="bdm::MemDS::MemDS" ref="acf4cb6fb424f7fedfd7396f60951bbb1" args="(mat &amp;Dat, ivec &amp;rowid0, ivec &amp;delays0)" -->
-&nbsp;</td><td class="memItemRight" valign="bottom"><b>MemDS</b> (mat &amp;Dat, ivec &amp;rowid0, ivec &amp;delays0)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a650ab83fbf15416520cac11a66247e39"></a><!-- doxytag: member="bdm::MemDS::MemDS" ref="a650ab83fbf15416520cac11a66247e39" args="(mat &amp;Dat, ivec &amp;rowid0)" -->
+&nbsp;</td><td class="memItemRight" valign="bottom"><b>MemDS</b> (mat &amp;Dat, ivec &amp;rowid0)</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="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::MemDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
@@ -125 +129 @@
 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::MemDS::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::MemDS::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>
@@ -144 +145 @@
 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::MemDS::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::MemDS::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>
@@ -173 +171 @@
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <p>Memory storage of off-line data column-wise. </p>
-<p>The data are stored in an internal matrix <code>Data</code> . Each column of Data corresponds to one discrete time observation <img class="formulaInl" alt="$t$" src="form_22.png"/>. Access to this matrix is via indices <code>rowid</code> and <code>delays</code>.</p>
+<p>The data are stored in an internal matrix <code>Data</code> . Each column of Data corresponds to one discrete time observation <img class="formulaInl" alt="$t$" src="form_22.png"/>. Access to this matrix is via indices <code>rowid</code>.</p>
 <p>The data can be loaded from a file. </p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="afaebfe6d7a2a43421be05d8cf7d7ae45"></a><!-- doxytag: member="bdm::MemDS::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]</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">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">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">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>
@@ -180 +220 @@
 </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>