Changeset 261 for doc/html/classbdm_1_1MemDS.html

Timestamp:

02/09/09 23:08:46 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1MemDS.html (modified) (8 diffs)

doc/html/classbdm_1_1MemDS.html

@@ -12 +12 @@
       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
-      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -18 +19 @@
   <div class="tabs">
     <ul>
+      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
@@ -23 +25 @@
     </ul>
   </div>
-  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1MemDS.html">MemDS</a>
+  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1MemDS.html">MemDS</a>
   </div>
 </div>
 <div class="contents">
-<h1>bdm::MemDS Class Reference</h1><!-- doxytag: class="bdm::MemDS" --><!-- doxytag: inherits="bdm::DS" -->Class representing off-line data stored in memory.  
+<h1>bdm::MemDS Class Reference</h1><!-- doxytag: class="bdm::MemDS" --><!-- doxytag: inherits="bdm::DS" -->Memory storage of off-line data column-wise.  
 <a href="#_details">More...</a>
 <p>
@@ -37 +39 @@
 <p><center><img src="classbdm_1_1MemDS__inherit__graph.png" border="0" usemap="#bdm_1_1MemDS__inherit__map" alt="Inheritance graph"></center>
 <map name="bdm_1_1MemDS__inherit__map">
-<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="21,7,99,33"></map>
+<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="23,84,100,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 <div class="dynheader">
@@ -44 +46 @@
 <p><center><img src="classbdm_1_1MemDS__coll__graph.png" border="0" usemap="#bdm_1_1MemDS__coll__map" alt="Collaboration graph"></center>
 <map name="bdm_1_1MemDS__coll__map">
-<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="21,199,99,225"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="23,87,97,113"><area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="16,7,104,33"></map>
+<area shape="rect" href="classbdm_1_1DS.html" title="Abstract class for discrete&#45;time sources of data." alt="" coords="21,199,99,225"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="9,7,121,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="76,87,151,113"></map>
 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
 
@@ -55 +57 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="900f1e1c9eb950f87e557c068628e60e"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="900f1e1c9eb950f87e557c068628e60e" args="(vec &amp;dt, ivec &amp;indeces)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#900f1e1c9eb950f87e557c068628e60e">getdata</a> (vec &amp;dt, ivec &amp;indeces)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62083e1db465a97a2a39fc682addc83d"></a><!-- doxytag: member="bdm::MemDS::getdata" ref="62083e1db465a97a2a39fc682addc83d" args="(vec &amp;dt, const ivec &amp;indeces)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#62083e1db465a97a2a39fc682addc83d">getdata</a> (vec &amp;dt, const ivec &amp;indeces)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <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_1MemDS.html#5f72b555e0e4a61de1440c457cf57007">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>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f72b555e0e4a61de1440c457cf57007"></a><!-- doxytag: member="bdm::MemDS::linkrvs" ref="5f72b555e0e4a61de1440c457cf57007" args="(RV &amp;drv, RV &amp;urv)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>linkrvs</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>
 
-<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="#5f72b555e0e4a61de1440c457cf57007"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::MemDS::write" ref="9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
@@ -67 +69 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9af4563d430d8a3f15aa03581e52ef0"></a><!-- doxytag: member="bdm::MemDS::write" ref="d9af4563d430d8a3f15aa03581e52ef0" args="(vec &amp;ut, ivec &amp;indexes)" -->
-void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#d9af4563d430d8a3f15aa03581e52ef0">write</a> (vec &amp;ut, ivec &amp;indexes)</td></tr>
+void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indexes)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::MemDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
@@ -78 +79 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::MemDS::write" ref="6bced13f84f6bf04449728817e049e1d" 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#6bced13f84f6bf04449728817e049e1d">write</a> (vec &amp;ut, const ivec &amp;indeces)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <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="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::MemDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" 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#d8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
 
-<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>
+<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>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::MemDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" 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#9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
 
-<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>
+<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>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
-Class representing off-line data stored in memory. 
+Memory storage of off-line data column-wise. 
 <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_38.png">. Access to this matrix is via indexes <code>rowid</code> and <code>delays</code>.<p>
-The data can be loaded from a file. <hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="5f72b555e0e4a61de1440c457cf57007"></a><!-- doxytag: member="bdm::MemDS::linkrvs" ref="5f72b555e0e4a61de1440c457cf57007" args="(RV &amp;drv, RV &amp;urv)" -->
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void MemDS::linkrvs           </td>
-          <td>(</td>
-          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
-          <td class="paramname"> <em>drv</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
-          <td class="paramname"> <em>urv</em></td><td>&nbsp;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td><td></td>
-        </tr>
-      </table>
+The data can be loaded from a file. <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>
-<div class="memdoc">
-
-<p>
-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. 
-<p>
-(Inherited from m3k, may be deprecated soon). 
-<p>Reimplemented from <a class="el" href="classbdm_1_1DS.html#edd136e9046c08ac615cbe3c741de21e">bdm::DS</a>.</p>
-
-<p>References <a class="el" href="libBM_8h-source.html#l00081">bdm::RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00386">bdm::DS::Drv</a>, and <a class="el" href="libBM_8h-source.html#l00388">bdm::DS::Urv</a>.</p>
-
-</div>
-</div><p>
-<hr>The documentation for this class was generated from the following files:<ul>
-<li>work/git/mixpp/bdm/stat/<a class="el" href="libDS_8h-source.html">libDS.h</a><li>work/git/mixpp/bdm/stat/libDS.cpp</ul>
-</div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:31:27 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 15:29:53 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.6 </small></address>