Show
Ignore:
Timestamp:
10/12/09 13:49:39 (15 years ago)
Author:
mido
Message:

\doc directory cleaned a bit

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1dirfilelog.html

    r641 r651  
    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"/> 
     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"> 
    53<title>mixpp: bdm::dirfilelog Class Reference</title> 
    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 --> 
     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.9 --> 
    118<script type="text/javascript"> 
    129<!-- 
    … …  
    7168</div> 
    7269<div class="contents"> 
    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 <hr/><a name="_details"></a><h2>Detailed Description</h2> 
    77 <p>Logging into dirfile with buffer in memory. </p> 
    78 <p>Dirfile is a special format used by the kst program. See documentation of kst for description.</p> 
    79 <p>This format is used to store scalars, hence multivariate RVs must be separated. </p> 
    80  
    81 <p><code>#include &lt;<a class="el" href="loggers_8h_source.html">loggers.h</a>&gt;</code></p> 
    82  
    83 <p><a href="classbdm_1_1dirfilelog-members.html">List of all members.</a></p> 
    84 <table border="0" cellpadding="0" cellspacing="0"> 
    85 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    86 <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> 
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#a15e1c0228c8ecefb372b364742748dff"></a><br/></td></tr> 
    88 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a3bd8a83cbd6299e279544bc81493d"></a><!-- doxytag: member="bdm::dirfilelog::init" ref="a78a3bd8a83cbd6299e279544bc81493d" args="()" --> 
    89 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a78a3bd8a83cbd6299e279544bc81493d">init</a> ()</td></tr> 
    90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br/></td></tr> 
    91 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af79660645d09aa2d8bdd18923a721662"></a><!-- doxytag: member="bdm::dirfilelog::step" ref="af79660645d09aa2d8bdd18923a721662" args="()" --> 
    92 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#af79660645d09aa2d8bdd18923a721662">step</a> ()</td></tr> 
    93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br/></td></tr> 
    94 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a521d7ba159f97a0182392df27953804f"></a><!-- doxytag: member="bdm::dirfilelog::finalize" ref="a521d7ba159f97a0182392df27953804f" args="()" --> 
    95 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a521d7ba159f97a0182392df27953804f">finalize</a> ()</td></tr> 
    96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br/></td></tr> 
    97 <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> 
    98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#af595c0df25f5fa5d8c27ea1e375d9c51"></a><br/></td></tr> 
    99 <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> 
    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="#aa32de0f314a30392d69f07458643514e"></a><br/></td></tr> 
    101 <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)" --> 
    102 void&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> 
    103 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br/></td></tr> 
    104 <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)" --> 
    105 void&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> 
    106 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br/></td></tr> 
    107 <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)" --> 
    108 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr> 
    109 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br/></td></tr> 
    110 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="a47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
    111 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> 
    112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">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>. <br/></td></tr> 
    113 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::dirfilelog::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
    114 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr> 
    116 <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 " --> 
    117 virtual 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> 
    118 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr> 
    119 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::dirfilelog::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
    120 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    121 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr> 
    122 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> 
    123 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="a985eb02770f01e25cdceff32ff53a9c5" args="" --> 
    124 string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a985eb02770f01e25cdceff32ff53a9c5">dirname</a></td></tr> 
    125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br/></td></tr> 
    126 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="a7805040fe1ffa2a048c33980bc995793" args="" --> 
    127 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#a7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr> 
    128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br/></td></tr> 
    129 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::dirfilelog::maxlen" ref="aa690ebd91430b5973855c9b4c9cf1b1d" args="" --> 
    130 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#aa690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr> 
    131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br/></td></tr> 
    132 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::dirfilelog::ind" ref="a70cec1d3549a82796ad7b6f0d07a4570" args="" --> 
    133 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr> 
    134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br/></td></tr> 
    135 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="a1fed143162f2de6ef1c1b6557964f24e" args="" --> 
    136 Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
    137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br/></td></tr> 
    138 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::dirfilelog::itfilename" ref="a11fdf8ffca0f509ff637b0c3ac161c1f" args="" --> 
    139 string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr> 
    140 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br/></td></tr> 
    141 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="ac54566a4554089443a20b2a49ed1a61f" args="" --> 
    142 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#ac54566a4554089443a20b2a49ed1a61f">entries</a></td></tr> 
    143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br/></td></tr> 
    144 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="a68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
    145 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
    146 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br/></td></tr> 
     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="()" --> 
     84void&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="()" --> 
     88void&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="()" --> 
     92void&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)" --> 
     102void&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)" --> 
     106void&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)" --> 
     110void&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"><a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
     114virtual 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> 
     115 
     116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns an identifier which will be later needed for calling the <code><a class="el" href="classbdm_1_1logger.html#e30f695619931b3c372ab280e452d309" 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#e30f695619931b3c372ab280e452d309" title="log this vector">logit()</a></code>. <br></td></tr> 
     117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::dirfilelog::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     118virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     119 
     120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
     121<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 " --> 
     122virtual 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> 
     123 
     124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
     125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::dirfilelog::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     126virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
     127 
     128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
     129<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
     130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="985eb02770f01e25cdceff32ff53a9c5" args="" --> 
     131string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#985eb02770f01e25cdceff32ff53a9c5">dirname</a></td></tr> 
     132 
     133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br></td></tr> 
     134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="7805040fe1ffa2a048c33980bc995793" args="" --> 
     135Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr> 
     136 
     137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br></td></tr> 
     138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::dirfilelog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" --> 
     139int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr> 
     140 
     141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr> 
     142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::dirfilelog::ind" ref="70cec1d3549a82796ad7b6f0d07a4570" args="" --> 
     143int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr> 
     144 
     145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr> 
     146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" --> 
     147Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
     148 
     149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr> 
     150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::dirfilelog::itfilename" ref="11fdf8ffca0f509ff637b0c3ac161c1f" args="" --> 
     151string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr> 
     152 
     153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br></td></tr> 
     154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> 
     155Array&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> 
     156 
     157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr> 
     158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
     159Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
     160 
     161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> 
    147162</table> 
    148 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 
    149 <a class="anchor" id="a15e1c0228c8ecefb372b364742748dff"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="a15e1c0228c8ecefb372b364742748dff" args="(string dirname0, int maxlen0)" --> 
     163<hr><a name="_details"></a><h2>Detailed Description</h2> 
     164Logging into dirfile with buffer in memory.  
     165<p> 
     166Dirfile is a special format used by the kst program. See documentation of kst for description.<p> 
     167This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2> 
     168<a class="anchor" name="15e1c0228c8ecefb372b364742748dff"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="15e1c0228c8ecefb372b364742748dff" args="(string dirname0, int maxlen0)" --> 
    150169<div class="memitem"> 
    151170<div class="memproto"> 
    152171      <table class="memname"> 
    153172        <tr> 
    154           <td class="memname">bdm::dirfilelog::dirfilelog </td> 
     173          <td class="memname">bdm::dirfilelog::dirfilelog           </td> 
    155174          <td>(</td> 
    156175          <td class="paramtype">string&nbsp;</td> 
    … …  
    172191<div class="memdoc"> 
    173192 
    174 <p>Default constructor. </p> 
    175 <dl><dt><b>Parameters:</b></dt><dd> 
     193<p> 
     194Default constructor.  
     195<p> 
     196<dl compact><dt><b>Parameters:</b></dt><dd> 
    176197  <table border="0" cellspacing="2" cellpadding="0"> 
    177198    <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> 
    178199    <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> 
    179200  </table> 
    180   </dd> 
    181201</dl> 
    182202 
    183203</div> 
    184 </div> 
    185 <hr/><h2>Member Function Documentation</h2> 
    186 <a class="anchor" id="aa32de0f314a30392d69f07458643514e"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="aa32de0f314a30392d69f07458643514e" args="(const Setting &amp;set)" --> 
     204</div><p> 
     205<hr><h2>Member Function Documentation</h2> 
     206<a class="anchor" name="a32de0f314a30392d69f07458643514e"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="a32de0f314a30392d69f07458643514e" args="(const Setting &amp;set)" --> 
    187207<div class="memitem"> 
    188208<div class="memproto"> 
    189209      <table class="memname"> 
    190210        <tr> 
    191           <td class="memname">void bdm::dirfilelog::from_setting </td> 
     211          <td class="memname">void bdm::dirfilelog::from_setting           </td> 
    192212          <td>(</td> 
    193213          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    194           <td class="paramname"> <em>set</em></td> 
     214          <td class="paramname"> <em>set</em>          </td> 
    195215          <td>&nbsp;)&nbsp;</td> 
    196216          <td><code> [virtual]</code></td> 
    … …  
    200220<div class="memdoc"> 
    201221 
    202 <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> 
    203 <div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#af9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = { 
    204                 <span class="keyword">class </span>= &quot;<a class="code" href="classbdm_1_1dirfilelog.html#a15e1c0228c8ecefb372b364742748dff" title="Default constructor.">dirfilelog</a>&quot;; 
    205                 <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> 
    206                 <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> 
     222<p> 
     223<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).  
     224<p> 
     225<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = { 
     226                <span class="keyword">class </span>= "<a class="code" href="classbdm_1_1dirfilelog.html#15e1c0228c8ecefb372b364742748dff" title="Default constructor.">dirfilelog</a>"; 
     227                <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> 
     228                <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> 
    207229        } 
    208230</pre></div>  
    209 <p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#a7352b474bc54c35ab7c9297c5b958629">bdm::memlog</a>.</p> 
     231<p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#7352b474bc54c35ab7c9297c5b958629">bdm::memlog</a>.</p> 
    210232 
    211233<p>References <a class="el" href="loggers_8h_source.html#l00151">dirname</a>, <a class="el" href="loggers_8h_source.html#l00029">bdm::memlog::maxlen</a>, and <a class="el" href="loggers_8h_source.html#l00153">scalarnames</a>.</p> 
    212234 
    213235</div> 
    214 </div> 
    215 <a class="anchor" id="af595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="af595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" --> 
     236</div><p> 
     237<a class="anchor" name="f595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="f595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" --> 
    216238<div class="memitem"> 
    217239<div class="memproto"> 
    218240      <table class="memname"> 
    219241        <tr> 
    220           <td class="memname">void bdm::dirfilelog::write_buffers </td> 
     242          <td class="memname">void bdm::dirfilelog::write_buffers           </td> 
    221243          <td>(</td> 
    222244          <td class="paramtype">int&nbsp;</td> 
    223           <td class="paramname"> <em>Len</em></td> 
     245          <td class="paramname"> <em>Len</em>          </td> 
    224246          <td>&nbsp;)&nbsp;</td> 
    225247          <td></td> 
    … …  
    229251<div class="memdoc"> 
    230252 
    231 <p>Write memory storage to disk. </p> 
    232 <dl><dt><b>Parameters:</b></dt><dd> 
     253<p> 
     254Write memory storage to disk.  
     255<p> 
     256<dl compact><dt><b>Parameters:</b></dt><dd> 
    233257  <table border="0" cellspacing="2" cellpadding="0"> 
    234258    <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> 
    235259  </table> 
    236   </dd> 
    237260</dl> 
    238261 
    … …  
    242265 
    243266</div> 
    244 </div> 
    245 <hr/>The documentation for this class was generated from the following files:<ul> 
    246 <li><a class="el" href="loggers_8h_source.html">loggers.h</a></li> 
    247 <li>loggers.cpp</li> 
    248 </ul> 
    249 </div> 
    250 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 27 00:49:05 2009 for mixpp by&nbsp; 
     267</div><p> 
     268<hr>The documentation for this class was generated from the following files:<ul> 
     269<li><a class="el" href="loggers_8h_source.html">loggers.h</a><li>loggers.cpp</ul> 
     270</div> 
     271<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp; 
    251272<a href="http://www.doxygen.org/index.html"> 
    252 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
     273<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    253274</body> 
    254275</html>