root/doc/html/classdirfilelog.html @ 187

Revision 181, 13.6 kB (checked in by smidl, 16 years ago)

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