Show
Ignore:
Timestamp:
08/30/09 22:13:15 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1dirfilelog.html

    r590 r591  
    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"> 
     1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     2<html xmlns="http://www.w3.org/1999/xhtml"> 
     3<head> 
     4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
    35<title>mixpp: bdm::dirfilelog Class Reference</title> 
    4 <link href="tabs.css" rel="stylesheet" type="text/css"> 
    5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 
    6 </head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     6<link href="tabs.css" rel="stylesheet" type="text/css"/> 
     7<link href="doxygen.css" rel="stylesheet" type="text/css"/> 
     8</head> 
     9<body> 
     10<!-- Generated by Doxygen 1.6.1 --> 
    811<script type="text/javascript"> 
    912<!-- 
    … …  
    6871</div> 
    6972<div class="contents"> 
    70 <h1>bdm::dirfilelog Class Reference</h1><!-- doxytag: class="bdm::dirfilelog" --><!-- doxytag: inherits="bdm::memlog" -->Logging into dirfile with buffer in memory.   
    71 <a href="#_details">More...</a> 
    72 <p> 
    73 <code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code> 
    74 <p> 
    75  
    76 <p> 
    77 <a href="classbdm_1_1dirfilelog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    78 <tr><td></td></tr> 
    79 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    80 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#15e1c0228c8ecefb372b364742748dff">dirfilelog</a> (string dirname0, int maxlen0)</td></tr> 
    81  
    82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#15e1c0228c8ecefb372b364742748dff"></a><br></td></tr> 
    83 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78a3bd8a83cbd6299e279544bc81493d"></a><!-- doxytag: member="bdm::dirfilelog::init" ref="78a3bd8a83cbd6299e279544bc81493d" args="()" --> 
    84 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#78a3bd8a83cbd6299e279544bc81493d">init</a> ()</td></tr> 
    85  
    86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br></td></tr> 
    87 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f79660645d09aa2d8bdd18923a721662"></a><!-- doxytag: member="bdm::dirfilelog::step" ref="f79660645d09aa2d8bdd18923a721662" args="()" --> 
    88 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#f79660645d09aa2d8bdd18923a721662">step</a> ()</td></tr> 
    89  
    90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr> 
    91 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="521d7ba159f97a0182392df27953804f"></a><!-- doxytag: member="bdm::dirfilelog::finalize" ref="521d7ba159f97a0182392df27953804f" args="()" --> 
    92 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#521d7ba159f97a0182392df27953804f">finalize</a> ()</td></tr> 
    93  
    94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr> 
    95 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#f595c0df25f5fa5d8c27ea1e375d9c51">write_buffers</a> (int Len)</td></tr> 
    96  
    97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#f595c0df25f5fa5d8c27ea1e375d9c51"></a><br></td></tr> 
    98 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a32de0f314a30392d69f07458643514e">from_setting</a> (const Setting &amp;set)</td></tr> 
    99  
    100 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format).  <a href="#a32de0f314a30392d69f07458643514e"></a><br></td></tr> 
    101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="364e58c5d7058776c2a9cfa7d58dad6d"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="364e58c5d7058776c2a9cfa7d58dad6d" args="(int id, const vec &amp;v)" --> 
    102 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#364e58c5d7058776c2a9cfa7d58dad6d">logit</a> (int id, const vec &amp;v)</td></tr> 
    103  
    104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr> 
    105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b57dbd3dff49a98c6ce8fccccb170af"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="2b57dbd3dff49a98c6ce8fccccb170af" args="(int id, const double &amp;d)" --> 
    106 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#2b57dbd3dff49a98c6ce8fccccb170af">logit</a> (int id, const double &amp;d)</td></tr> 
    107  
    108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr> 
    109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a74b7a3d889607391594279112aef1f"></a><!-- doxytag: member="bdm::dirfilelog::itsave" ref="6a74b7a3d889607391594279112aef1f" args="(const char *fname)" --> 
    110 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr> 
    111  
    112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr> 
    113 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#47aa3b098a81d02a8ffaea2c9fa09ac7">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string prefix=&quot;&quot;)</td></tr> 
    114  
    115 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::dirfilelog::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
    116 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    117  
    118 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    119 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::dirfilelog::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
    120 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    121  
    122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::dirfilelog::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
    124 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    125  
    126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    127 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    128 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="985eb02770f01e25cdceff32ff53a9c5" args="" --> 
    129 string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#985eb02770f01e25cdceff32ff53a9c5">dirname</a></td></tr> 
    130  
    131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br></td></tr> 
    132 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="7805040fe1ffa2a048c33980bc995793" args="" --> 
    133 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr> 
    134  
    135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br></td></tr> 
    136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::dirfilelog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" --> 
    137 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr> 
    138  
    139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr> 
    140 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::dirfilelog::ind" ref="70cec1d3549a82796ad7b6f0d07a4570" args="" --> 
    141 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr> 
    142  
    143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr> 
    144 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" --> 
    145 Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
    146  
    147 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr> 
    148 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::dirfilelog::itfilename" ref="11fdf8ffca0f509ff637b0c3ac161c1f" args="" --> 
    149 string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr> 
    150  
    151 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br></td></tr> 
    152 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> 
    153 Array&lt; <a class="el" href="classbdm_1_1RV.html">RV</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#c54566a4554089443a20b2a49ed1a61f">entries</a></td></tr> 
    154  
    155 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr> 
    156 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
    157 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
    158  
    159 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> 
     73<h1>bdm::dirfilelog Class Reference</h1><!-- doxytag: class="bdm::dirfilelog" --><!-- doxytag: inherits="bdm::memlog" --> 
     74<p>Logging into dirfile with buffer in memory.   
     75<a href="#_details">More...</a></p> 
     76 
     77<p><code>#include &lt;<a class="el" href="loggers_8h_source.html">loggers.h</a>&gt;</code></p> 
     78 
     79<p><a href="classbdm_1_1dirfilelog-members.html">List of all members.</a></p> 
     80<table border="0" cellpadding="0" cellspacing="0"> 
     81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
     82<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a15e1c0228c8ecefb372b364742748dff">dirfilelog</a> (string dirname0, int maxlen0)</td></tr> 
     83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#a15e1c0228c8ecefb372b364742748dff"></a><br/></td></tr> 
     84<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a3bd8a83cbd6299e279544bc81493d"></a><!-- doxytag: member="bdm::dirfilelog::init" ref="a78a3bd8a83cbd6299e279544bc81493d" args="()" --> 
     85void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a78a3bd8a83cbd6299e279544bc81493d">init</a> ()</td></tr> 
     86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br/></td></tr> 
     87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af79660645d09aa2d8bdd18923a721662"></a><!-- doxytag: member="bdm::dirfilelog::step" ref="af79660645d09aa2d8bdd18923a721662" args="()" --> 
     88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#af79660645d09aa2d8bdd18923a721662">step</a> ()</td></tr> 
     89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br/></td></tr> 
     90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a521d7ba159f97a0182392df27953804f"></a><!-- doxytag: member="bdm::dirfilelog::finalize" ref="a521d7ba159f97a0182392df27953804f" args="()" --> 
     91void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a521d7ba159f97a0182392df27953804f">finalize</a> ()</td></tr> 
     92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br/></td></tr> 
     93<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#af595c0df25f5fa5d8c27ea1e375d9c51">write_buffers</a> (int Len)</td></tr> 
     94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#af595c0df25f5fa5d8c27ea1e375d9c51"></a><br/></td></tr> 
     95<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#aa32de0f314a30392d69f07458643514e">from_setting</a> (const Setting &amp;set)</td></tr> 
     96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format).  <a href="#aa32de0f314a30392d69f07458643514e"></a><br/></td></tr> 
     97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a364e58c5d7058776c2a9cfa7d58dad6d"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="a364e58c5d7058776c2a9cfa7d58dad6d" args="(int id, const vec &amp;v)" --> 
     98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a364e58c5d7058776c2a9cfa7d58dad6d">logit</a> (int id, const vec &amp;v)</td></tr> 
     99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br/></td></tr> 
     100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b57dbd3dff49a98c6ce8fccccb170af"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="a2b57dbd3dff49a98c6ce8fccccb170af" args="(int id, const double &amp;d)" --> 
     101void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a2b57dbd3dff49a98c6ce8fccccb170af">logit</a> (int id, const double &amp;d)</td></tr> 
     102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br/></td></tr> 
     103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a74b7a3d889607391594279112aef1f"></a><!-- doxytag: member="bdm::dirfilelog::itsave" ref="a6a74b7a3d889607391594279112aef1f" args="(const char *fname)" --> 
     104void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr> 
     105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br/></td></tr> 
     106<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a47aa3b098a81d02a8ffaea2c9fa09ac7">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string prefix=&quot;&quot;)</td></tr> 
     107<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::dirfilelog::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
     108virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr> 
     110<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::dirfilelog::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     111virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
     112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr> 
     113<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::dirfilelog::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     114virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
     115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr> 
     116<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> 
     117<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="a985eb02770f01e25cdceff32ff53a9c5" args="" --> 
     118string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a985eb02770f01e25cdceff32ff53a9c5">dirname</a></td></tr> 
     119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br/></td></tr> 
     120<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="a7805040fe1ffa2a048c33980bc995793" args="" --> 
     121Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr> 
     122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br/></td></tr> 
     123<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::dirfilelog::maxlen" ref="aa690ebd91430b5973855c9b4c9cf1b1d" args="" --> 
     124int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#aa690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr> 
     125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br/></td></tr> 
     126<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::dirfilelog::ind" ref="a70cec1d3549a82796ad7b6f0d07a4570" args="" --> 
     127int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr> 
     128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br/></td></tr> 
     129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="a1fed143162f2de6ef1c1b6557964f24e" args="" --> 
     130Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
     131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br/></td></tr> 
     132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::dirfilelog::itfilename" ref="a11fdf8ffca0f509ff637b0c3ac161c1f" args="" --> 
     133string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr> 
     134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br/></td></tr> 
     135<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="ac54566a4554089443a20b2a49ed1a61f" args="" --> 
     136Array&lt; <a class="el" href="classbdm_1_1RV.html">RV</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#ac54566a4554089443a20b2a49ed1a61f">entries</a></td></tr> 
     137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br/></td></tr> 
     138<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="a68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
     139Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
     140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br/></td></tr> 
    160141</table> 
    161 <hr><a name="_details"></a><h2>Detailed Description</h2> 
    162 Logging into dirfile with buffer in memory.  
    163 <p> 
    164 Dirfile is a special format used by the kst program. See documentation of kst for description.<p> 
    165 This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2> 
    166 <a class="anchor" name="15e1c0228c8ecefb372b364742748dff"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="15e1c0228c8ecefb372b364742748dff" args="(string dirname0, int maxlen0)" --> 
    167 <div class="memitem"> 
    168 <div class="memproto"> 
    169       <table class="memname"> 
    170         <tr> 
    171           <td class="memname">bdm::dirfilelog::dirfilelog           </td> 
     142<hr/><a name="_details"></a><h2>Detailed Description</h2> 
     143<p>Logging into dirfile with buffer in memory. </p> 
     144<p>Dirfile is a special format used by the kst program. See documentation of kst for description.</p> 
     145<p>This format is used to store scalars, hence multivariate RVs must be separated. </p> 
     146<hr/><h2>Constructor &amp; Destructor Documentation</h2> 
     147<a class="anchor" id="a15e1c0228c8ecefb372b364742748dff"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="a15e1c0228c8ecefb372b364742748dff" args="(string dirname0, int maxlen0)" --> 
     148<div class="memitem"> 
     149<div class="memproto"> 
     150      <table class="memname"> 
     151        <tr> 
     152          <td class="memname">bdm::dirfilelog::dirfilelog </td> 
    172153          <td>(</td> 
    173154          <td class="paramtype">string&nbsp;</td> 
    … …  
    189170<div class="memdoc"> 
    190171 
    191 <p> 
    192 Default constructor.  
    193 <p> 
    194 <dl compact><dt><b>Parameters:</b></dt><dd> 
     172<p>Default constructor. </p> 
     173<dl><dt><b>Parameters:</b></dt><dd> 
    195174  <table border="0" cellspacing="2" cellpadding="0"> 
    196175    <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> 
    197176    <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> 
    198177  </table> 
     178  </dd> 
    199179</dl> 
    200180 
    201181</div> 
    202 </div><p> 
    203 <hr><h2>Member Function Documentation</h2> 
    204 <a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
    205 <div class="memitem"> 
    206 <div class="memproto"> 
    207       <table class="memname"> 
    208         <tr> 
    209           <td class="memname">virtual int bdm::logger::add           </td> 
     182</div> 
     183<hr/><h2>Member Function Documentation</h2> 
     184<a class="anchor" id="a47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="a47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
     185<div class="memitem"> 
     186<div class="memproto"> 
     187      <table class="memname"> 
     188        <tr> 
     189          <td class="memname">virtual int bdm::logger::add </td> 
    210190          <td>(</td> 
    211191          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td> 
    … …  
    226206</div> 
    227207<div class="memdoc"> 
    228  
    229 <p> 
    230 returns an identifier which will be later needed for calling the <code><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9" title="log this vector">logit()</a></code> function For empty <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> it returns -1, this entry will be ignored by <code><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9" title="log this vector">logit()</a></code>.  
    231 <p>References <a class="el" href="bdmbase_8h-source.html#l00670">bdm::logger::entries</a>, and <a class="el" href="bdmbase_8h-source.html#l00672">bdm::logger::names</a>.</p> 
    232  
    233 <p>Referenced by <a class="el" href="datasources_8h-source.html#l00203">bdm::ArxDS::log_add()</a>, <a class="el" href="bdmbase_8h-source.html#l00966">bdm::BM::log_add()</a>, and <a class="el" href="bdmbase_8h-source.html#l00790">bdm::DS::log_add()</a>.</p> 
    234  
    235 </div> 
    236 </div><p> 
    237 <a class="anchor" name="a32de0f314a30392d69f07458643514e"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="a32de0f314a30392d69f07458643514e" args="(const Setting &amp;set)" --> 
    238 <div class="memitem"> 
    239 <div class="memproto"> 
    240       <table class="memname"> 
    241         <tr> 
    242           <td class="memname">void bdm::dirfilelog::from_setting           </td> 
     208<p>returns an identifier which will be later needed for calling the <code><a class="el" href="classbdm_1_1logger.html#ae30f695619931b3c372ab280e452d309" title="log this vector">logit()</a></code> function For empty <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> it returns -1, this entry will be ignored by <code><a class="el" href="classbdm_1_1logger.html#ae30f695619931b3c372ab280e452d309" title="log this vector">logit()</a></code>. </p> 
     209 
     210<p>References <a class="el" href="bdmbase_8h_source.html#l00670">bdm::logger::entries</a>, and <a class="el" href="bdmbase_8h_source.html#l00672">bdm::logger::names</a>.</p> 
     211 
     212<p>Referenced by <a class="el" href="datasources_8h_source.html#l00310">bdm::stateDS::log_add()</a>, <a class="el" href="datasources_8h_source.html#l00203">bdm::ArxDS::log_add()</a>, <a class="el" href="bdmbase_8h_source.html#l00966">bdm::BM::log_add()</a>, and <a class="el" href="bdmbase_8h_source.html#l00790">bdm::DS::log_add()</a>.</p> 
     213 
     214</div> 
     215</div> 
     216<a class="anchor" id="aa32de0f314a30392d69f07458643514e"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="aa32de0f314a30392d69f07458643514e" args="(const Setting &amp;set)" --> 
     217<div class="memitem"> 
     218<div class="memproto"> 
     219      <table class="memname"> 
     220        <tr> 
     221          <td class="memname">void bdm::dirfilelog::from_setting </td> 
    243222          <td>(</td> 
    244223          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    245           <td class="paramname"> <em>set</em>          </td> 
     224          <td class="paramname"> <em>set</em></td> 
    246225          <td>&nbsp;)&nbsp;</td> 
    247226          <td><code> [virtual]</code></td> 
    … …  
    251230<div class="memdoc"> 
    252231 
    253 <p> 
    254 <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format).  
    255 <p> 
    256 <div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = { 
    257                 <span class="keyword">class </span>= "<a class="code" href="classbdm_1_1dirfilelog.html#15e1c0228c8ecefb372b364742748dff" title="Default constructor.">dirfilelog</a>"; 
    258                 <a class="code" href="classbdm_1_1dirfilelog.html#985eb02770f01e25cdceff32ff53a9c5" title="name of the directory">dirname</a> = <span class="stringliteral">"directory_for_files"</span>; <span class="comment">// resulting files will be stored there</span> 
    259                 <a class="code" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d" title="Maximum length of vectors stored in memory.">maxlen</a> = 100;                    <span class="comment">// size of memory buffer, when full results are written to disk</span> 
     232<p><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format). </p> 
     233<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#af9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = { 
     234                <span class="keyword">class </span>= &quot;<a class="code" href="classbdm_1_1dirfilelog.html#a15e1c0228c8ecefb372b364742748dff" title="Default constructor.">dirfilelog</a>&quot;; 
     235                <a class="code" href="classbdm_1_1dirfilelog.html#a985eb02770f01e25cdceff32ff53a9c5" title="name of the directory">dirname</a> = <span class="stringliteral">&quot;directory_for_files&quot;</span>; <span class="comment">// resulting files will be stored there</span> 
     236                <a class="code" href="classbdm_1_1memlog.html#aa690ebd91430b5973855c9b4c9cf1b1d" title="Maximum length of vectors stored in memory.">maxlen</a> = 100;                    <span class="comment">// size of memory buffer, when full results are written to disk</span> 
    260237        } 
    261238</pre></div>  
    262 <p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#7352b474bc54c35ab7c9297c5b958629">bdm::memlog</a>.</p> 
    263  
    264 <p>References <a class="el" href="loggers_8h-source.html#l00102">dirname</a>, <a class="el" href="loggers_8h-source.html#l00029">bdm::memlog::maxlen</a>, and <a class="el" href="loggers_8h-source.html#l00104">scalarnames</a>.</p> 
    265  
    266 </div> 
    267 </div><p> 
    268 <a class="anchor" name="f595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="f595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" --> 
    269 <div class="memitem"> 
    270 <div class="memproto"> 
    271       <table class="memname"> 
    272         <tr> 
    273           <td class="memname">void bdm::dirfilelog::write_buffers           </td> 
     239<p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#a7352b474bc54c35ab7c9297c5b958629">bdm::memlog</a>.</p> 
     240 
     241<p>References <a class="el" href="loggers_8h_source.html#l00102">dirname</a>, <a class="el" href="loggers_8h_source.html#l00029">bdm::memlog::maxlen</a>, and <a class="el" href="loggers_8h_source.html#l00104">scalarnames</a>.</p> 
     242 
     243</div> 
     244</div> 
     245<a class="anchor" id="af595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="af595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" --> 
     246<div class="memitem"> 
     247<div class="memproto"> 
     248      <table class="memname"> 
     249        <tr> 
     250          <td class="memname">void bdm::dirfilelog::write_buffers </td> 
    274251          <td>(</td> 
    275252          <td class="paramtype">int&nbsp;</td> 
    276           <td class="paramname"> <em>Len</em>          </td> 
     253          <td class="paramname"> <em>Len</em></td> 
    277254          <td>&nbsp;)&nbsp;</td> 
    278255          <td></td> 
    … …  
    282259<div class="memdoc"> 
    283260 
    284 <p> 
    285 Write memory storage to disk.  
    286 <p> 
    287 <dl compact><dt><b>Parameters:</b></dt><dd> 
     261<p>Write memory storage to disk. </p> 
     262<dl><dt><b>Parameters:</b></dt><dd> 
    288263  <table border="0" cellspacing="2" cellpadding="0"> 
    289264    <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> 
    290265  </table> 
     266  </dd> 
    291267</dl> 
    292268 
    293 <p>References <a class="el" href="bdmerror_8h-source.html#l00047">bdm_assert_debug</a>, <a class="el" href="loggers_8h-source.html#l00102">dirname</a>, <a class="el" href="bdmbase_8h-source.html#l00670">bdm::logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00029">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00104">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00033">bdm::memlog::vectors</a>.</p> 
    294  
    295 <p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00169">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00055">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00159">step()</a>.</p> 
    296  
    297 </div> 
    298 </div><p> 
    299 <hr>The documentation for this class was generated from the following files:<ul> 
    300 <li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul> 
    301 </div> 
    302 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
     269<p>References <a class="el" href="bdmerror_8h_source.html#l00047">bdm_assert_debug</a>, <a class="el" href="loggers_8h_source.html#l00102">dirname</a>, <a class="el" href="bdmbase_8h_source.html#l00670">bdm::logger::entries</a>, <a class="el" href="loggers_8h_source.html#l00029">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h_source.html#l00104">scalarnames</a>, and <a class="el" href="loggers_8h_source.html#l00033">bdm::memlog::vectors</a>.</p> 
     270 
     271<p>Referenced by <a class="el" href="loggers_8cpp_source.html#l00169">finalize()</a>, <a class="el" href="loggers_8cpp_source.html#l00055">init()</a>, and <a class="el" href="loggers_8cpp_source.html#l00159">step()</a>.</p> 
     272 
     273</div> 
     274</div> 
     275<hr/>The documentation for this class was generated from the following files:<ul> 
     276<li><a class="el" href="loggers_8h_source.html">loggers.h</a></li> 
     277<li>loggers.cpp</li> 
     278</ul> 
     279</div> 
     280<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp; 
    303281<a href="http://www.doxygen.org/index.html"> 
    304 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     282<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
    305283</body> 
    306284</html>