| 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.5 --> |
|---|
| 8 | <div class="navigation" id="top"> |
|---|
| 9 | <div class="tabs"> |
|---|
| 10 | <ul> |
|---|
| 11 | <li><a href="index.html"><span>Main Page</span></a></li> |
|---|
| 12 | <li><a href="pages.html"><span>Related 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 List</span></a></li> |
|---|
| 20 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|---|
| 21 | <li><a href="functions.html"><span>Class 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 <<a class="el" href="loggers_8h-source.html">loggers.h</a>></code> |
|---|
| 30 | <p> |
|---|
| 31 | <div class="dynheader"> |
|---|
| 32 | Inheritance 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-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"> |
|---|
| 39 | Collaboration 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-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"> </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"> </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="()" --> |
|---|
| 54 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#afeaebe003110f9db1ac43edf8e53a92">init</a> ()</td></tr> |
|---|
| 55 | |
|---|
| 56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize storage. <br></td></tr> |
|---|
| 57 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="887f2bb97e8c92ca42eea1fbac34eb51"></a><!-- doxytag: member="dirfilelog::step" ref="887f2bb97e8c92ca42eea1fbac34eb51" args="(bool final=false)" --> |
|---|
| 58 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#887f2bb97e8c92ca42eea1fbac34eb51">step</a> (bool final=false)</td></tr> |
|---|
| 59 | |
|---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">consider this record to be complete <br></td></tr> |
|---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#bd95cdb46af194245f88a7b4bf4c66c7">write_buffers</a> (int Len)</td></tr> |
|---|
| 62 | |
|---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Write memory storage to disk. <a href="#bd95cdb46af194245f88a7b4bf4c66c7"></a><br></td></tr> |
|---|
| 64 | <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)" --> |
|---|
| 65 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#8d2feeb826f7249e9104d616b5a67144">logit</a> (int id, vec v)</td></tr> |
|---|
| 66 | |
|---|
| 67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">log this vector <br></td></tr> |
|---|
| 68 | <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)" --> |
|---|
| 69 | void </td><td class="memItemRight" valign="bottom"><b>itsave</b> (const char *fname)</td></tr> |
|---|
| 70 | |
|---|
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d6c6ab580b36619c4010e3ebec55378"></a><!-- doxytag: member="dirfilelog::add" ref="3d6c6ab580b36619c4010e3ebec55378" args="(RV rv, string name="")" --> |
|---|
| 72 | virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#3d6c6ab580b36619c4010e3ebec55378">add</a> (<a class="el" href="classRV.html">RV</a> rv, string name="")</td></tr> |
|---|
| 73 | |
|---|
| 74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns an identifier which will be later needed for calling the log() function <br></td></tr> |
|---|
| 75 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
|---|
| 76 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cba5ff1f74ed22910ed7d63aadf21771"></a><!-- doxytag: member="dirfilelog::dirname" ref="cba5ff1f74ed22910ed7d63aadf21771" args="" --> |
|---|
| 77 | string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#cba5ff1f74ed22910ed7d63aadf21771">dirname</a></td></tr> |
|---|
| 78 | |
|---|
| 79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">name of the directory <br></td></tr> |
|---|
| 80 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="854b7e7cc4cb40542b4a3ea06d915772"></a><!-- doxytag: member="dirfilelog::scalarnames" ref="854b7e7cc4cb40542b4a3ea06d915772" args="" --> |
|---|
| 81 | Array< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdirfilelog.html#854b7e7cc4cb40542b4a3ea06d915772">scalarnames</a></td></tr> |
|---|
| 82 | |
|---|
| 83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Automatically generated. <br></td></tr> |
|---|
| 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4195f322897ededdac66c404b848ced3"></a><!-- doxytag: member="dirfilelog::maxlen" ref="4195f322897ededdac66c404b848ced3" args="" --> |
|---|
| 85 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#4195f322897ededdac66c404b848ced3">maxlen</a></td></tr> |
|---|
| 86 | |
|---|
| 87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr> |
|---|
| 88 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3410b4c002636508c43ddcba8d394520"></a><!-- doxytag: member="dirfilelog::ind" ref="3410b4c002636508c43ddcba8d394520" args="" --> |
|---|
| 89 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#3410b4c002636508c43ddcba8d394520">ind</a></td></tr> |
|---|
| 90 | |
|---|
| 91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Currect record to be written. <br></td></tr> |
|---|
| 92 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0f5bc7b83539ad102e8f65297852d91"></a><!-- doxytag: member="dirfilelog::vectors" ref="f0f5bc7b83539ad102e8f65297852d91" args="" --> |
|---|
| 93 | Array< mat > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#f0f5bc7b83539ad102e8f65297852d91">vectors</a></td></tr> |
|---|
| 94 | |
|---|
| 95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Storage. <br></td></tr> |
|---|
| 96 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83eea0cf4fbca59474d015f751f128a7"></a><!-- doxytag: member="dirfilelog::entries" ref="83eea0cf4fbca59474d015f751f128a7" args="" --> |
|---|
| 97 | Array< <a class="el" href="classRV.html">RV</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#83eea0cf4fbca59474d015f751f128a7">entries</a></td></tr> |
|---|
| 98 | |
|---|
| 99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">RVs of all logged variables. <br></td></tr> |
|---|
| 100 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39cb79e839ca8f8bb9dcbc8c5b9c7786"></a><!-- doxytag: member="dirfilelog::names" ref="39cb79e839ca8f8bb9dcbc8c5b9c7786" args="" --> |
|---|
| 101 | Array< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#39cb79e839ca8f8bb9dcbc8c5b9c7786">names</a></td></tr> |
|---|
| 102 | |
|---|
| 103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> |
|---|
| 104 | </table> |
|---|
| 105 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
|---|
| 106 | Logging into dirfile with buffer in memory. |
|---|
| 107 | <p> |
|---|
| 108 | Dirfile is a special format used by the kst program. See documentation of kst for description.<p> |
|---|
| 109 | This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor & Destructor Documentation</h2> |
|---|
| 110 | <a class="anchor" name="802eeb6fc4ebf11d97638fd5dc651c68"></a><!-- doxytag: member="dirfilelog::dirfilelog" ref="802eeb6fc4ebf11d97638fd5dc651c68" args="(std::string dirname0, int maxlen0)" --> |
|---|
| 111 | <div class="memitem"> |
|---|
| 112 | <div class="memproto"> |
|---|
| 113 | <table class="memname"> |
|---|
| 114 | <tr> |
|---|
| 115 | <td class="memname">dirfilelog::dirfilelog </td> |
|---|
| 116 | <td>(</td> |
|---|
| 117 | <td class="paramtype">std::string </td> |
|---|
| 118 | <td class="paramname"> <em>dirname0</em>, </td> |
|---|
| 119 | </tr> |
|---|
| 120 | <tr> |
|---|
| 121 | <td class="paramkey"></td> |
|---|
| 122 | <td></td> |
|---|
| 123 | <td class="paramtype">int </td> |
|---|
| 124 | <td class="paramname"> <em>maxlen0</em></td><td> </td> |
|---|
| 125 | </tr> |
|---|
| 126 | <tr> |
|---|
| 127 | <td></td> |
|---|
| 128 | <td>)</td> |
|---|
| 129 | <td></td><td></td><td width="100%"><code> [inline]</code></td> |
|---|
| 130 | </tr> |
|---|
| 131 | </table> |
|---|
| 132 | </div> |
|---|
| 133 | <div class="memdoc"> |
|---|
| 134 | |
|---|
| 135 | <p> |
|---|
| 136 | Default constructor. |
|---|
| 137 | <p> |
|---|
| 138 | <dl compact><dt><b>Parameters:</b></dt><dd> |
|---|
| 139 | <table border="0" cellspacing="2" cellpadding="0"> |
|---|
| 140 | <tr><td valign="top"></td><td valign="top"><em>dirname0</em> </td><td>name of the directory in which to store the results </td></tr> |
|---|
| 141 | <tr><td valign="top"></td><td valign="top"><em>maxlen0</em> </td><td>length of the memory buffers, when full the buffers will be dumped to HDD and returned to the beginning. </td></tr> |
|---|
| 142 | </table> |
|---|
| 143 | </dl> |
|---|
| 144 | |
|---|
| 145 | </div> |
|---|
| 146 | </div><p> |
|---|
| 147 | <hr><h2>Member Function Documentation</h2> |
|---|
| 148 | <a class="anchor" name="bd95cdb46af194245f88a7b4bf4c66c7"></a><!-- doxytag: member="dirfilelog::write_buffers" ref="bd95cdb46af194245f88a7b4bf4c66c7" args="(int Len)" --> |
|---|
| 149 | <div class="memitem"> |
|---|
| 150 | <div class="memproto"> |
|---|
| 151 | <table class="memname"> |
|---|
| 152 | <tr> |
|---|
| 153 | <td class="memname">void dirfilelog::write_buffers </td> |
|---|
| 154 | <td>(</td> |
|---|
| 155 | <td class="paramtype">int </td> |
|---|
| 156 | <td class="paramname"> <em>Len</em> </td> |
|---|
| 157 | <td> ) </td> |
|---|
| 158 | <td width="100%"></td> |
|---|
| 159 | </tr> |
|---|
| 160 | </table> |
|---|
| 161 | </div> |
|---|
| 162 | <div class="memdoc"> |
|---|
| 163 | |
|---|
| 164 | <p> |
|---|
| 165 | Write memory storage to disk. |
|---|
| 166 | <p> |
|---|
| 167 | <dl compact><dt><b>Parameters:</b></dt><dd> |
|---|
| 168 | <table border="0" cellspacing="2" cellpadding="0"> |
|---|
| 169 | <tr><td valign="top"></td><td valign="top"><em>Len</em> </td><td>length of buffer to be written, if 0 the file is truncated at 0. </td></tr> |
|---|
| 170 | </table> |
|---|
| 171 | </dl> |
|---|
| 172 | |
|---|
| 173 | <p>References <a class="el" href="loggers_8h-source.html#l00101">dirname</a>, <a class="el" href="loggers_8h-source.html#l00031">logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00068">memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00103">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00072">memlog::vectors</a>.</p> |
|---|
| 174 | |
|---|
| 175 | <p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00018">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00108">step()</a>.</p> |
|---|
| 176 | |
|---|
| 177 | </div> |
|---|
| 178 | </div><p> |
|---|
| 179 | <hr>The documentation for this class was generated from the following files:<ul> |
|---|
| 180 | <li>work/mixpp/bdm/stat/<a class="el" href="loggers_8h-source.html">loggers.h</a><li>work/mixpp/bdm/stat/loggers.cpp</ul> |
|---|
| 181 | </div> |
|---|
| 182 | <hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 23:06:38 2008 for mixpp by |
|---|
| 183 | <a href="http://www.doxygen.org/index.html"> |
|---|
| 184 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
|---|
| 185 | </body> |
|---|
| 186 | </html> |
|---|
