root/doc/html/classmemlog.html @ 172

Revision 171, 9.1 kB (checked in by smidl, 16 years ago)

New documentation

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: memlog 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>memlog Class Reference</h1><!-- doxytag: class="memlog" --><!-- doxytag: inherits="logger" -->Logging into matrices in data format 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 memlog:</div>
33<div class="dynsection">
34<p><center><img src="classmemlog__inherit__graph.png" border="0" usemap="#memlog__inherit__map" alt="Inheritance graph"></center>
35<map name="memlog__inherit__map">
36<area shape="rect" href="classdirfilelog.html" title="Logging into dirfile with buffer in memory." alt="" coords="5,156,75,180"><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 memlog:</div>
40<div class="dynsection">
41<p><center><img src="classmemlog__coll__graph.png" border="0" usemap="#memlog__coll__map" alt="Collaboration graph"></center>
42<map name="memlog__coll__map">
43<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="classmemlog-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"><a class="anchor" name="e056e819c5a65d4431bfe7955b1efe97"></a><!-- doxytag: member="memlog::memlog" ref="e056e819c5a65d4431bfe7955b1efe97" args="(int maxlen0)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#e056e819c5a65d4431bfe7955b1efe97">memlog</a> (int maxlen0)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b081ef5acb4816e6b5fcb56c19cc7e47"></a><!-- doxytag: member="memlog::init" ref="b081ef5acb4816e6b5fcb56c19cc7e47" args="()" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#b081ef5acb4816e6b5fcb56c19cc7e47">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="c97961eda9cda9f0e63c703cf21e5804"></a><!-- doxytag: member="memlog::step" ref="c97961eda9cda9f0e63c703cf21e5804" args="()" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#c97961eda9cda9f0e63c703cf21e5804">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="8d2feeb826f7249e9104d616b5a67144"></a><!-- doxytag: member="memlog::logit" ref="8d2feeb826f7249e9104d616b5a67144" args="(int id, vec v)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#8d2feeb826f7249e9104d616b5a67144">logit</a> (int id, vec v)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65571ebbb16577b5211adbb27baf769c"></a><!-- doxytag: member="memlog::itsave" ref="65571ebbb16577b5211adbb27baf769c" args="(const char *fname)" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#65571ebbb16577b5211adbb27baf769c">itsave</a> (const char *fname)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb250a559b71e07a1a6aa92f2185c1b"></a><!-- doxytag: member="memlog::add" ref="cfb250a559b71e07a1a6aa92f2185c1b" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
71virtual 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>
72
73<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>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51c1aa8a84a14097b51607a187ae3617"></a><!-- doxytag: member="memlog::finalize" ref="51c1aa8a84a14097b51607a187ae3617" args="()" -->
75virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#51c1aa8a84a14097b51607a187ae3617">finalize</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
78<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4195f322897ededdac66c404b848ced3"></a><!-- doxytag: member="memlog::maxlen" ref="4195f322897ededdac66c404b848ced3" args="" -->
80int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#4195f322897ededdac66c404b848ced3">maxlen</a></td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3410b4c002636508c43ddcba8d394520"></a><!-- doxytag: member="memlog::ind" ref="3410b4c002636508c43ddcba8d394520" args="" -->
84int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#3410b4c002636508c43ddcba8d394520">ind</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0f5bc7b83539ad102e8f65297852d91"></a><!-- doxytag: member="memlog::vectors" ref="f0f5bc7b83539ad102e8f65297852d91" args="" -->
88Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmemlog.html#f0f5bc7b83539ad102e8f65297852d91">vectors</a></td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83eea0cf4fbca59474d015f751f128a7"></a><!-- doxytag: member="memlog::entries" ref="83eea0cf4fbca59474d015f751f128a7" args="" -->
92Array&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>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39cb79e839ca8f8bb9dcbc8c5b9c7786"></a><!-- doxytag: member="memlog::names" ref="39cb79e839ca8f8bb9dcbc8c5b9c7786" args="" -->
96Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#39cb79e839ca8f8bb9dcbc8c5b9c7786">names</a></td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
99</table>
100<hr><a name="_details"></a><h2>Detailed Description</h2>
101Logging into matrices in data format in memory.
102<p>
103More?... <hr>The documentation for this class was generated from the following files:<ul>
104<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>
105</div>
106<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:53 2008 for mixpp by&nbsp;
107<a href="http://www.doxygen.org/index.html">
108<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
109</body>
110</html>
Note: See TracBrowser for help on using the browser.