root/doc/html/classdirfilelog.html @ 255

Revision 234, 13.7 kB (checked in by smidl, 15 years ago)

doc

Line 
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">
3<title>mixpp: dirfilelog Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25</div>
26<div class="contents">
27<h1>dirfilelog Class Reference</h1><!-- doxytag: class="dirfilelog" --><!-- doxytag: inherits="memlog" -->Logging into dirfile with buffer in memory. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code>
31<p>
32<div class="dynheader">
33Inheritance diagram for dirfilelog:</div>
34<div class="dynsection">
35<p><center><img src="classdirfilelog__inherit__graph.png" border="0" usemap="#dirfilelog__inherit__map" alt="Inheritance graph"></center>
36<map name="dirfilelog__inherit__map">
37<area shape="rect" href="classmemlog.html" title="Logging into matrices in data format in memory." alt="" coords="7,82,73,106"><area shape="rect" href="classlogger.html" title="Class for storing results (and semi&#45;results) of an experiment." alt="" coords="12,7,68,31"></map>
38<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39<div class="dynheader">
40Collaboration diagram for dirfilelog:</div>
41<div class="dynsection">
42<p><center><img src="classdirfilelog__coll__graph.png" border="0" usemap="#dirfilelog__coll__map" alt="Collaboration graph"></center>
43<map name="dirfilelog__coll__map">
44<area shape="rect" href="classmemlog.html" title="Logging into matrices in data format in memory." alt="" coords="5,84,72,108"><area shape="rect" href="classlogger.html" title="Class for storing results (and semi&#45;results) of an experiment." alt="" coords="11,7,67,31"></map>
45<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
46
47<p>
48<a href="classdirfilelog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
49<tr><td></td></tr>
50<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#802eeb6fc4ebf11d97638fd5dc651c68">dirfilelog</a> (std::string dirname0, int maxlen0)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#802eeb6fc4ebf11d97638fd5dc651c68"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="afeaebe003110f9db1ac43edf8e53a92"></a><!-- doxytag: member="dirfilelog::init" ref="afeaebe003110f9db1ac43edf8e53a92" args="()" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#afeaebe003110f9db1ac43edf8e53a92">init</a> ()</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5fe9483a041591bfe6f3d6393b02aa7"></a><!-- doxytag: member="dirfilelog::step" ref="f5fe9483a041591bfe6f3d6393b02aa7" args="()" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#f5fe9483a041591bfe6f3d6393b02aa7">step</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d671baf6f88444d7fe25a5b8a80834a"></a><!-- doxytag: member="dirfilelog::finalize" ref="4d671baf6f88444d7fe25a5b8a80834a" args="()" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#4d671baf6f88444d7fe25a5b8a80834a">finalize</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#bd95cdb46af194245f88a7b4bf4c66c7">write_buffers</a> (int Len)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#bd95cdb46af194245f88a7b4bf4c66c7"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3974df074f1df270d56f13ade374c1be"></a><!-- doxytag: member="dirfilelog::logit" ref="3974df074f1df270d56f13ade374c1be" args="(int id, const vec &amp;v)" -->
70void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#3974df074f1df270d56f13ade374c1be">logit</a> (int id, const vec &amp;v)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65571ebbb16577b5211adbb27baf769c"></a><!-- doxytag: member="dirfilelog::itsave" ref="65571ebbb16577b5211adbb27baf769c" args="(const char *fname)" -->
74void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#65571ebbb16577b5211adbb27baf769c">itsave</a> (const char *fname)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb250a559b71e07a1a6aa92f2185c1b"></a><!-- doxytag: member="dirfilelog::add" ref="cfb250a559b71e07a1a6aa92f2185c1b" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
78virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#cfb250a559b71e07a1a6aa92f2185c1b">add</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv, string name=&quot;&quot;)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns an identifier which will be later needed for calling the log() function <br></td></tr>
81<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cba5ff1f74ed22910ed7d63aadf21771"></a><!-- doxytag: member="dirfilelog::dirname" ref="cba5ff1f74ed22910ed7d63aadf21771" args="" -->
83string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#cba5ff1f74ed22910ed7d63aadf21771">dirname</a></td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="854b7e7cc4cb40542b4a3ea06d915772"></a><!-- doxytag: member="dirfilelog::scalarnames" ref="854b7e7cc4cb40542b4a3ea06d915772" args="" -->
87Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#854b7e7cc4cb40542b4a3ea06d915772">scalarnames</a></td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4195f322897ededdac66c404b848ced3"></a><!-- doxytag: member="dirfilelog::maxlen" ref="4195f322897ededdac66c404b848ced3" args="" -->
91int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#4195f322897ededdac66c404b848ced3">maxlen</a></td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3410b4c002636508c43ddcba8d394520"></a><!-- doxytag: member="dirfilelog::ind" ref="3410b4c002636508c43ddcba8d394520" args="" -->
95int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#3410b4c002636508c43ddcba8d394520">ind</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0f5bc7b83539ad102e8f65297852d91"></a><!-- doxytag: member="dirfilelog::vectors" ref="f0f5bc7b83539ad102e8f65297852d91" args="" -->
99Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#f0f5bc7b83539ad102e8f65297852d91">vectors</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83eea0cf4fbca59474d015f751f128a7"></a><!-- doxytag: member="dirfilelog::entries" ref="83eea0cf4fbca59474d015f751f128a7" args="" -->
103Array&lt; <a class="el" href="classRV.html">RV</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#83eea0cf4fbca59474d015f751f128a7">entries</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39cb79e839ca8f8bb9dcbc8c5b9c7786"></a><!-- doxytag: member="dirfilelog::names" ref="39cb79e839ca8f8bb9dcbc8c5b9c7786" args="" -->
107Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#39cb79e839ca8f8bb9dcbc8c5b9c7786">names</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
110</table>
111<hr><a name="_details"></a><h2>Detailed Description</h2>
112Logging into dirfile with buffer in memory.
113<p>
114Dirfile is a special format used by the kst program. See documentation of kst for description.<p>
115This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2>
116<a class="anchor" name="802eeb6fc4ebf11d97638fd5dc651c68"></a><!-- doxytag: member="dirfilelog::dirfilelog" ref="802eeb6fc4ebf11d97638fd5dc651c68" args="(std::string dirname0, int maxlen0)" -->
117<div class="memitem">
118<div class="memproto">
119      <table class="memname">
120        <tr>
121          <td class="memname">dirfilelog::dirfilelog           </td>
122          <td>(</td>
123          <td class="paramtype">std::string&nbsp;</td>
124          <td class="paramname"> <em>dirname0</em>, </td>
125        </tr>
126        <tr>
127          <td class="paramkey"></td>
128          <td></td>
129          <td class="paramtype">int&nbsp;</td>
130          <td class="paramname"> <em>maxlen0</em></td><td>&nbsp;</td>
131        </tr>
132        <tr>
133          <td></td>
134          <td>)</td>
135          <td></td><td></td><td><code> [inline]</code></td>
136        </tr>
137      </table>
138</div>
139<div class="memdoc">
140
141<p>
142Default constructor.
143<p>
144<dl compact><dt><b>Parameters:</b></dt><dd>
145  <table border="0" cellspacing="2" cellpadding="0">
146    <tr><td valign="top"></td><td valign="top"><em>dirname0</em>&nbsp;</td><td>name of the directory in which to store the results </td></tr>
147    <tr><td valign="top"></td><td valign="top"><em>maxlen0</em>&nbsp;</td><td>length of the memory buffers, when full the buffers will be dumped to HDD and returned to the beginning. </td></tr>
148  </table>
149</dl>
150
151</div>
152</div><p>
153<hr><h2>Member Function Documentation</h2>
154<a class="anchor" name="bd95cdb46af194245f88a7b4bf4c66c7"></a><!-- doxytag: member="dirfilelog::write_buffers" ref="bd95cdb46af194245f88a7b4bf4c66c7" args="(int Len)" -->
155<div class="memitem">
156<div class="memproto">
157      <table class="memname">
158        <tr>
159          <td class="memname">void dirfilelog::write_buffers           </td>
160          <td>(</td>
161          <td class="paramtype">int&nbsp;</td>
162          <td class="paramname"> <em>Len</em>          </td>
163          <td>&nbsp;)&nbsp;</td>
164          <td></td>
165        </tr>
166      </table>
167</div>
168<div class="memdoc">
169
170<p>
171Write memory storage to disk.
172<p>
173<dl compact><dt><b>Parameters:</b></dt><dd>
174  <table border="0" cellspacing="2" cellpadding="0">
175    <tr><td valign="top"></td><td valign="top"><em>Len</em>&nbsp;</td><td>length of buffer to be written, if 0 the file is truncated at 0. </td></tr>
176  </table>
177</dl>
178
179<p>References <a class="el" href="loggers_8h-source.html#l00107">dirname</a>, <a class="el" href="loggers_8h-source.html#l00031">logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00071">memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00109">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00075">memlog::vectors</a>.</p>
180
181<p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00133">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00025">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00122">step()</a>.</p>
182
183</div>
184</div><p>
185<hr>The documentation for this class was generated from the following files:<ul>
186<li>work/git/mixpp/bdm/stat/<a class="el" href="loggers_8h-source.html">loggers.h</a><li>work/git/mixpp/bdm/stat/loggers.cpp</ul>
187</div>
188<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 15 10:50:53 2009 for mixpp by&nbsp;
189<a href="http://www.doxygen.org/index.html">
190<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
191</body>
192</html>
Note: See TracBrowser for help on using the browser.