Changeset 608 for library/doc/html/classbdm_1_1CsvFileDS.html
- Timestamp:
- 09/12/09 11:41:43 (15 years ago)
- Files:
-
- 1 modified
Legend:
- Unmodified
- Added
- Removed
-
library/doc/html/classbdm_1_1CsvFileDS.html
r591 r608 72 72 <div class="contents"> 73 73 <h1>bdm::CsvFileDS Class Reference</h1><!-- doxytag: class="bdm::CsvFileDS" --><!-- doxytag: inherits="bdm::FileDS" --> 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_ 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.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. 75 75 <a href="#_details">More...</a></p> 76 76 … … 110 110 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21916feb3e5ff960855c09b06a0d279b"></a><!-- doxytag: member="bdm::CsvFileDS::step" ref="a21916feb3e5ff960855c09b06a0d279b" args="()" --> 111 111 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1MemDS.html#a21916feb3e5ff960855c09b06a0d279b">step</a> ()</td></tr> 112 <tr><td class="mdescLeft"> </td><td class="mdescRight">Moves from <img class="formulaInl" alt="$ t $" src="form_1 2.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>113 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a ed2113851294ed96abe60fc3f05aa660"></a><!-- doxytag: member="bdm::CsvFileDS::_drv" ref="aed2113851294ed96abe60fc3f05aa660" args="() const " -->114 virtual <a class="el" href="classbdm_1_1RV.html">RV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aed2113851294ed96abe60fc3f05aa660">_drv</a> () const </td></tr>112 <tr><td class="mdescLeft"> </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> 113 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069497b610296be053d862a2493be0ce"></a><!-- doxytag: member="bdm::CsvFileDS::_drv" ref="a069497b610296be053d862a2493be0ce" args="() const " --> 114 virtual const <a class="el" href="classbdm_1_1RV.html">RV</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a069497b610296be053d862a2493be0ce">_drv</a> () const </td></tr> 115 115 <tr><td class="mdescLeft"> </td><td class="mdescRight">access function <br/></td></tr> 116 116 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a9a375da64c82fc227bda3418a1f33"></a><!-- doxytag: member="bdm::CsvFileDS::_urv" ref="aa6a9a375da64c82fc227bda3418a1f33" args="() const " --> 117 117 const <a class="el" href="classbdm_1_1RV.html">RV</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aa6a9a375da64c82fc227bda3418a1f33">_urv</a> () const </td></tr> 118 118 <tr><td class="mdescLeft"> </td><td class="mdescRight">access function <br/></td></tr> 119 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821297dfd839d68691324f024e57252f"></a><!-- doxytag: member="bdm::CsvFileDS::set_drv" ref="a821297dfd839d68691324f024e57252f" args="(const RV &drv, const RV &urv)" --> 120 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a821297dfd839d68691324f024e57252f">set_drv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &drv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &urv)</td></tr> 121 <tr><td class="mdescLeft"> </td><td class="mdescRight">set random rvariables <br/></td></tr> 119 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac09878f86907329ac631a3df8755c558"></a><!-- doxytag: member="bdm::CsvFileDS::_yrv" ref="ac09878f86907329ac631a3df8755c558" args="() const " --> 120 const <a class="el" href="classbdm_1_1RV.html">RV</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ac09878f86907329ac631a3df8755c558">_yrv</a> () const </td></tr> 121 <tr><td class="mdescLeft"> </td><td class="mdescRight">access function <br/></td></tr> 122 <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 &yrv, const RV &urv)" --> 123 virtual void </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> &yrv, const <a class="el" href="classbdm_1_1RV.html">RV</a> &urv)</td></tr> 124 <tr><td class="mdescLeft"> </td><td class="mdescRight">set random variables <br/></td></tr> 122 125 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::CsvFileDS::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 123 126 virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> … … 146 149 <tr><td class="mdescLeft"> </td><td class="mdescRight">vector of delays that are presented in Dt <br/></td></tr> 147 150 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af96cae44624e79638a91ec4f2c7c81a9"></a><!-- doxytag: member="bdm::CsvFileDS::dtsize" ref="af96cae44624e79638a91ec4f2c7c81a9" args="" --> 148 int </td><td class="memItemRight" valign="bottom"><b>dtsize</b></td></tr> 151 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#af96cae44624e79638a91ec4f2c7c81a9">dtsize</a></td></tr> 152 <tr><td class="mdescLeft"> </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> 149 153 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7467046a0bd05bc992cc5e1bdedb983"></a><!-- doxytag: member="bdm::CsvFileDS::utsize" ref="ad7467046a0bd05bc992cc5e1bdedb983" args="" --> 150 int </td><td class="memItemRight" valign="bottom"><b>utsize</b></td></tr> 154 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad7467046a0bd05bc992cc5e1bdedb983">utsize</a></td></tr> 155 <tr><td class="mdescLeft"> </td><td class="mdescRight">size of data <br/></td></tr> 156 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a4b29aa6e9f3bf17bcc4b28567e8bd"></a><!-- doxytag: member="bdm::CsvFileDS::ytsize" ref="a22a4b29aa6e9f3bf17bcc4b28567e8bd" args="" --> 157 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a22a4b29aa6e9f3bf17bcc4b28567e8bd">ytsize</a></td></tr> 158 <tr><td class="mdescLeft"> </td><td class="mdescRight">size of output <br/></td></tr> 151 159 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8db125ac35f3b8eeb773fc9a4cb45ec"></a><!-- doxytag: member="bdm::CsvFileDS::Drv" ref="ad8db125ac35f3b8eeb773fc9a4cb45ec" args="" --> 152 160 <a class="el" href="classbdm_1_1RV.html">RV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ad8db125ac35f3b8eeb773fc9a4cb45ec">Drv</a></td></tr> … … 155 163 <a class="el" href="classbdm_1_1RV.html">RV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#a9ac5970128fd39f4f6226723cd1de702">Urv</a></td></tr> 156 164 <tr><td class="mdescLeft"> </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> 165 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9de2a85f0d8257d79d9b68c05c4995"></a><!-- doxytag: member="bdm::CsvFileDS::Yrv" ref="aeb9de2a85f0d8257d79d9b68c05c4995" args="" --> 166 <a class="el" href="classbdm_1_1RV.html">RV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#aeb9de2a85f0d8257d79d9b68c05c4995">Yrv</a></td></tr> 167 <tr><td class="mdescLeft"> </td><td class="mdescRight">Description of output data. <br/></td></tr> 157 168 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b7bdb9d98a11ab587aa0ad803bb867"></a><!-- doxytag: member="bdm::CsvFileDS::L_dt" ref="ab4b7bdb9d98a11ab587aa0ad803bb867" args="" --> 158 169 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1DS.html#ab4b7bdb9d98a11ab587aa0ad803bb867">L_dt</a></td></tr> … … 162 173 </table> 163 174 <hr/><a name="_details"></a><h2>Detailed Description</h2> 164 <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_ 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. </p>175 <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> 165 176 <hr/>The documentation for this class was generated from the following files:<ul> 166 177 <li><a class="el" href="datasources_8h_source.html">datasources.h</a></li> … … 168 179 </ul> 169 180 </div> 170 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:502009 for mixpp by 181 <hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 8 22:11:33 2009 for mixpp by 171 182 <a href="http://www.doxygen.org/index.html"> 172 183 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>