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

Revision 614, 24.5 kB (checked in by smidl, 15 years ago)

doc

RevLine 
[591]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
[312]5<title>mixpp: bdm::CsvFileDS Class Reference</title>
[591]6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.1 -->
[271]11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
[259]52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
[271]55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[290]57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
[290]64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
[312]69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1CsvFileDS.html">CsvFileDS</a>
[259]70  </div>
71</div>
72<div class="contents">
[591]73<h1>bdm::CsvFileDS Class Reference</h1><!-- doxytag: class="bdm::CsvFileDS" --><!-- doxytag: inherits="bdm::FileDS" -->
[608]74<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. 
[591]75<a href="#_details">More...</a></p>
[259]76
[591]77<p><code>#include &lt;<a class="el" href="datasources_8h_source.html">datasources.h</a>&gt;</code></p>
[259]78
[591]79<p><a href="classbdm_1_1CsvFileDS-members.html">List of all members.</a></p>
80<table border="0" cellpadding="0" cellspacing="0">
81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d9d56cdf6b8d0236e32a80e11c238b0"></a><!-- doxytag: member="bdm::CsvFileDS::CsvFileDS" ref="a8d9d56cdf6b8d0236e32a80e11c238b0" args="(const string &amp;fname, const string &amp;orientation=&quot;BY_COL&quot;)" -->
83&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1CsvFileDS.html#a8d9d56cdf6b8d0236e32a80e11c238b0">CsvFileDS</a> (const string &amp;fname, const string &amp;orientation=&quot;BY_COL&quot;)</td></tr>
84<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>
85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bf36650e9d1af2d0743ffe8a3fcff14"></a><!-- doxytag: member="bdm::CsvFileDS::getdata" ref="a0bf36650e9d1af2d0743ffe8a3fcff14" args="(vec &amp;dt)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a0bf36650e9d1af2d0743ffe8a3fcff14">getdata</a> (vec &amp;dt)</td></tr>
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns full vector of observed data=[output, input]. <br/></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c546e8d9eb71e079e046e3d2f69c6c4"></a><!-- doxytag: member="bdm::CsvFileDS::getdata" ref="a3c546e8d9eb71e079e046e3d2f69c6c4" args="(vec &amp;dt, const ivec &amp;indices)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a3c546e8d9eb71e079e046e3d2f69c6c4">getdata</a> (vec &amp;dt, const ivec &amp;indices)</td></tr>
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns data records at indeces. <br/></td></tr>
91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6af63065097147b390e684a7842a26a"></a><!-- doxytag: member="bdm::CsvFileDS::ndat" ref="aa6af63065097147b390e684a7842a26a" args="()" -->
92int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#aa6af63065097147b390e684a7842a26a">ndat</a> ()</td></tr>
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns number of data in the file; <br/></td></tr>
94<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a998f590eeddee97ae6918671e40756b8"></a><!-- doxytag: member="bdm::CsvFileDS::log_add" ref="a998f590eeddee97ae6918671e40756b8" args="(logger &amp;L)" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1FileDS.html#a998f590eeddee97ae6918671e40756b8">log_add</a> (<a class="el" href="classbdm_1_1logger.html">logger</a> &amp;L)</td></tr>
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59d44ef34a523127dd79c076461c43b6"></a><!-- doxytag: member="bdm::CsvFileDS::logit" ref="a59d44ef34a523127dd79c076461c43b6" args="(logger &amp;L)" -->
98void&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>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">no sense to log this type <br/></td></tr>
[614]100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a339a488b93f2fc37c80d9a9573fbd421"></a><!-- doxytag: member="bdm::CsvFileDS::max_length" ref="a339a488b93f2fc37c80d9a9573fbd421" args="()" -->
101int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a339a488b93f2fc37c80d9a9573fbd421">max_length</a> ()</td></tr>
102<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>
[591]103<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)" -->
[271]104void&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>
[591]105<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a7f17598fe2b458707ba932865beef5"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="a9a7f17598fe2b458707ba932865beef5" args="(vec &amp;ut)" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a9a7f17598fe2b458707ba932865beef5">write</a> (vec &amp;ut)</td></tr>
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variable and schedule it for application. <br/></td></tr>
108<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4349a043d00fd82c8d5f5c39673787e5"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="a4349a043d00fd82c8d5f5c39673787e5" args="(vec &amp;ut, ivec &amp;indices)" -->
[271]109void&nbsp;</td><td class="memItemRight" valign="bottom"><b>write</b> (vec &amp;ut, ivec &amp;indices)</td></tr>
[591]110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bced13f84f6bf04449728817e049e1d"></a><!-- doxytag: member="bdm::CsvFileDS::write" ref="a6bced13f84f6bf04449728817e049e1d" args="(vec &amp;ut, const ivec &amp;indeces)" -->
111virtual 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>
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accepts action variables at specific indeces. <br/></td></tr>
113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::CsvFileDS::step" ref="a21916feb3e5ff960855c09b06a0d279b" args="()" -->
114void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr>
[608]115<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>
[614]116<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>
[608]117<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::CsvFileDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " -->
118virtual 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>
[591]119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::CsvFileDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " -->
121const <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#aa6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr>
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
[608]123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::CsvFileDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " -->
124const <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#ac09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr>
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br/></td></tr>
126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a92d77fd97fdb6bf1c8edb1e38c6bbc"></a><!-- doxytag: member="bdm::CsvFileDS::set_drv" ref="a3a92d77fd97fdb6bf1c8edb1e38c6bbc" args="(const RV &amp;yrv, const RV &amp;urv)" -->
127virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a3a92d77fd97fdb6bf1c8edb1e38c6bbc">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;yrv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;urv)</td></tr>
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set random variables <br/></td></tr>
[591]129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::CsvFileDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
130virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
132<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 " -->
133virtual 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>
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
135<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::CsvFileDS::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
136virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
138<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
139<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa724f4cbfc32e79bacc044253234e260"></a><!-- doxytag: member="bdm::CsvFileDS::Data" ref="aa724f4cbfc32e79bacc044253234e260" args="" -->
140mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#aa724f4cbfc32e79bacc044253234e260">Data</a></td></tr>
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal matrix of data <br/></td></tr>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a681ee3831f68f4f20ed54e04e8b3f107"></a><!-- doxytag: member="bdm::CsvFileDS::time" ref="a681ee3831f68f4f20ed54e04e8b3f107" args="" -->
143int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a681ee3831f68f4f20ed54e04e8b3f107">time</a></td></tr>
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">active column in the Data matrix <br/></td></tr>
145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a865814d49913dcf672bb20a4334d3dc4"></a><!-- doxytag: member="bdm::CsvFileDS::rowid" ref="a865814d49913dcf672bb20a4334d3dc4" args="" -->
146ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a865814d49913dcf672bb20a4334d3dc4">rowid</a></td></tr>
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of rows that are presented in Dt <br/></td></tr>
148<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::CsvFileDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" -->
[608]149int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr>
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code> <br/></td></tr>
[591]151<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::CsvFileDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" -->
[608]152int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr>
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of data <br/></td></tr>
154<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::CsvFileDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" -->
155int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr>
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of output <br/></td></tr>
[591]157<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::CsvFileDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" -->
158<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#ad8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr>
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data returned by <code><a class="el" href="classbdm_1_1DS.html#ac1ec862dec7164fee3284c6f9a51b0ba" title="Returns full vector of observed data=[output, input].">getdata()</a></code>. <br/></td></tr>
160<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ac5970128fd39f4f6226723cd1de702"></a><!-- doxytag: member="bdm::CsvFileDS::Urv" ref="a9ac5970128fd39f4f6226723cd1de702" args="" -->
161<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#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr>
162<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of data witten by by <code><a class="el" href="classbdm_1_1DS.html#af5baeee8528e5e4c5c7a344b2e3f192a" title="Accepts action variable and schedule it for application.">write()</a></code>. <br/></td></tr>
[608]163<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::CsvFileDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" -->
164<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#aeb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr>
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of output data. <br/></td></tr>
[591]166<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::CsvFileDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" -->
167int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr>
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remember its own index in Logger L. <br/></td></tr>
169<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56b74ec21485846ccfad461f33b0e7a"></a><!-- doxytag: member="bdm::CsvFileDS::L_ut" ref="ab56b74ec21485846ccfad461f33b0e7a" args="" -->
[264]170int&nbsp;</td><td class="memItemRight" valign="bottom"><b>L_ut</b></td></tr>
[259]171</table>
[591]172<hr/><a name="_details"></a><h2>Detailed Description</h2>
[608]173<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>
[614]174<hr/><h2>Member Function Documentation</h2>
175<a class="anchor" id="afaebfe6d7a2a43421be05d8cf7d7ae45"></a><!-- doxytag: member="bdm::CsvFileDS::from_setting" ref="afaebfe6d7a2a43421be05d8cf7d7ae45" args="(const Setting &amp;set)" -->
176<div class="memitem">
177<div class="memproto">
178      <table class="memname">
179        <tr>
180          <td class="memname">void bdm::MemDS::from_setting </td>
181          <td>(</td>
182          <td class="paramtype">const Setting &amp;&nbsp;</td>
183          <td class="paramname"> <em>set</em></td>
184          <td>&nbsp;)&nbsp;</td>
185          <td><code> [inline, virtual, inherited]</code></td>
186        </tr>
187      </table>
188</div>
189<div class="memdoc">
190<p>Create object from the following structure </p>
191<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;;
192                   <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>
193                   --- optional ---
194                   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>
195                   time = 0;               <span class="comment">// Index of the first column to user_info,</span>
196                   <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>
197                }
198</pre></div><p>If the optional fields are not given, they will be filled as follows: </p>
199<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];
200                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>);
201                      sizes=( 1    1    1 ...);
202                          times=( 0    0    0 ...);
203                          };
204                time = 0;
205</pre></div><p> If <code>rowid</code> is given, <code>drv</code> will be named after indeces in rowids.</p>
206<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>
207
208<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">bdm::root</a>.</p>
209
210<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>
211
212<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>
213
214</div>
215</div>
[591]216<hr/>The documentation for this class was generated from the following files:<ul>
217<li><a class="el" href="datasources_8h_source.html">datasources.h</a></li>
218<li>datasources.cpp</li>
219</ul>
[397]220</div>
[614]221<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:42 2009 for mixpp by&nbsp;
[259]222<a href="http://www.doxygen.org/index.html">
[591]223<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[259]224</body>
225</html>
Note: See TracBrowser for help on using the browser.