root/library/doc/html/classbdm_1_1CsvFileDS.html @ 538

Revision 538, 18.9 kB (checked in by smidl, 15 years ago)

Documentation regenerated

RevLine 
[259]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
[312]3<title>mixpp: bdm::CsvFileDS Class Reference</title>
[259]4<link href="tabs.css" rel="stylesheet" type="text/css">
[290]5<link href="doxygen.css" rel="stylesheet" type="text/css">
[259]6</head><body>
[538]7<!-- Generated by Doxygen 1.5.8 -->
[271]8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
[259]49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
[271]52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[290]54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
[290]61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
[312]66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1CsvFileDS.html">CsvFileDS</a>
[259]67  </div>
68</div>
69<div class="contents">
[397]70<h1>bdm::CsvFileDS Class Reference</h1><!-- doxytag: class="bdm::CsvFileDS" --><!-- doxytag: inherits="bdm::FileDS" -->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_15.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_16.png">, one row for each discrete time instant. 
[312]71<a href="#_details">More...</a>
[259]72<p>
[538]73<code>#include &lt;<a class="el" href="datasources_8h-source.html">datasources.h</a>&gt;</code>
[312]74<p>
[259]75
76<p>
[312]77<a href="classbdm_1_1CsvFileDS-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
[259]78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
[312]80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d9d56cdf6b8d0236e32a80e11c238b0"></a><!-- doxytag: member="bdm::CsvFileDS::CsvFileDS" ref="8d9d56cdf6b8d0236e32a80e11c238b0" args="(const string &amp;fname, const string &amp;orientation=&quot;BY_COL&quot;)" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1CsvFileDS.html#8d9d56cdf6b8d0236e32a80e11c238b0">CsvFileDS</a> (const string &amp;fname, const string &amp;orientation=&quot;BY_COL&quot;)</td></tr>
[259]82
[312]83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor - create <a class="el" href="classbdm_1_1DS.html" title="Abstract class for discrete-time sources of data.">DS</a> from a CSV file. <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bf36650e9d1af2d0743ffe8a3fcff14"></a><!-- doxytag: member="bdm::CsvFileDS::getdata" ref="0bf36650e9d1af2d0743ffe8a3fcff14" args="(vec &amp;dt)" -->
[287]85void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#0bf36650e9d1af2d0743ffe8a3fcff14">getdata</a> (vec &amp;dt)</td></tr>
86
[264]87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br></td></tr>
[312]88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed680c40e53fd838c044dc223421c0fe"></a><!-- doxytag: member="bdm::CsvFileDS::getdata" ref="ed680c40e53fd838c044dc223421c0fe" args="(vec &amp;dt, const ivec &amp;indeces)" -->
[287]89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#ed680c40e53fd838c044dc223421c0fe">getdata</a> (vec &amp;dt, const ivec &amp;indeces)</td></tr>
[259]90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br></td></tr>
[312]92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6af63065097147b390e684a7842a26a"></a><!-- doxytag: member="bdm::CsvFileDS::ndat" ref="a6af63065097147b390e684a7842a26a" args="()" -->
[287]93int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a6af63065097147b390e684a7842a26a">ndat</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns number of data in the file; <br></td></tr>
[353]96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="998f590eeddee97ae6918671e40756b8"></a><!-- doxytag: member="bdm::CsvFileDS::log_add" ref="998f590eeddee97ae6918671e40756b8" args="(logger &amp;L)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#998f590eeddee97ae6918671e40756b8">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59d44ef34a523127dd79c076461c43b6"></a><!-- doxytag: member="bdm::CsvFileDS::logit" ref="59d44ef34a523127dd79c076461c43b6" args="(logger &amp;L)" -->
101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#59d44ef34a523127dd79c076461c43b6">logit</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br></td></tr>
[312]104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6428f2778254e8304fb5a799b7f815a"></a><!-- doxytag: member="bdm::CsvFileDS::set_rvs" ref="e6428f2778254e8304fb5a799b7f815a" args="(RV &amp;drv, RV &amp;urv)" -->
[271]105void&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>
[259]106
[312]107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
[259]108void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br></td></tr>
[312]111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4349a043d00fd82c8d5f5c39673787e5"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="4349a043d00fd82c8d5f5c39673787e5" args="(vec &amp;ut, ivec &amp;indices)" -->
[271]112void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indices)</td></tr>
[259]113
[312]114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
[287]115virtual 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>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br></td></tr>
[312]118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::CsvFileDS::step" ref="21916feb3e5ff960855c09b06a0d279b" args="()" -->
[259]119void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
120
[397]121<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>
[312]122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::CsvFileDS::_drv" ref="ed2113851294ed96abe60fc3f05aa660" args="() const " -->
[269]123virtual <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>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[312]126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::CsvFileDS::_urv" ref="a6a9a375da64c82fc227bda3418a1f33" args="() const " -->
[269]127const <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#a6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
[353]130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="821297dfd839d68691324f024e57252f"></a><!-- doxytag: member="bdm::CsvFileDS::set_drv" ref="821297dfd839d68691324f024e57252f" args="(const RV &amp;drv, const RV &amp;urv)" -->
131virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#821297dfd839d68691324f024e57252f">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>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random rvariables <br></td></tr>
[396]134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::CsvFileDS::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
135virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
[353]136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
[396]138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::CsvFileDS::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" -->
139virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr>
[353]140
141<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>
[396]142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::CsvFileDS::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
143virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
[353]144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
[396]146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::CsvFileDS::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
147virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
[368]148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
[259]150<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
[312]151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a724f4cbfc32e79bacc044253234e260"></a><!-- doxytag: member="bdm::CsvFileDS::Data" ref="a724f4cbfc32e79bacc044253234e260" args="" -->
[287]152mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a724f4cbfc32e79bacc044253234e260">Data</a></td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal matrix of data <br></td></tr>
[312]155<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="681ee3831f68f4f20ed54e04e8b3f107"></a><!-- doxytag: member="bdm::CsvFileDS::time" ref="681ee3831f68f4f20ed54e04e8b3f107" args="" -->
[287]156int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#681ee3831f68f4f20ed54e04e8b3f107">time</a></td></tr>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active column in the Data matrix <br></td></tr>
[312]159<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="865814d49913dcf672bb20a4334d3dc4"></a><!-- doxytag: member="bdm::CsvFileDS::rowid" ref="865814d49913dcf672bb20a4334d3dc4" args="" -->
[287]160ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
161
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br></td></tr>
[312]163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="166522aed4d3b12d9b3c2afaf6673301"></a><!-- doxytag: member="bdm::CsvFileDS::delays" ref="166522aed4d3b12d9b3c2afaf6673301" args="" -->
[287]164ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#166522aed4d3b12d9b3c2afaf6673301">delays</a></td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of delays that are presented in Dt <br></td></tr>
[312]167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::CsvFileDS::dtsize" ref="f96cae44624e79638a91ec4f2c7c81a9" args="" -->
[270]168int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr>
169
[312]170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::CsvFileDS::utsize" ref="d7467046a0bd05bc992cc5e1bdedb983" args="" -->
[270]171int&nbsp;</td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr>
172
[312]173<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::CsvFileDS::Drv" ref="d8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
[259]174<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>
175
[270]176<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#c1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br></td></tr>
[312]177<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::CsvFileDS::Urv" ref="9ac5970128fd39f4f6226723cd1de702" args="" -->
[259]178<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>
179
[270]180<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by 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>
[312]181<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::CsvFileDS::L_dt" ref="b4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
[264]182int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#b4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
183
184<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br></td></tr>
[312]185<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::CsvFileDS::L_ut" ref="b56b74ec21485846ccfad461f33b0e7a" args="" -->
[264]186int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
187
[259]188</table>
[290]189<hr><a name="_details"></a><h2>Detailed Description</h2>
[397]190CSV 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_15.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_16.png">, one row for each discrete time instant. <hr>The documentation for this class was generated from the following files:<ul>
[538]191<li><a class="el" href="datasources_8h-source.html">datasources.h</a><li>datasources.cpp</ul>
[397]192</div>
[538]193<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp;
[259]194<a href="http://www.doxygen.org/index.html">
[538]195<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
[259]196</body>
197</html>
Note: See TracBrowser for help on using the browser.