Show
Ignore:
Timestamp:
03/06/09 15:03:45 (16 years ago)
Author:
smidl
Message:

correction of ARX tutorial

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/html/classbdm_1_1dirfilelog.html

    r287 r290  
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
    33<title>mixpp: bdm::dirfilelog Class Reference</title> 
     4<link href="tabs.css" rel="stylesheet" type="text/css"> 
    45<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    5 <link href="tabs.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.6 --> 
     7<!-- Generated by Doxygen 1.5.8 --> 
    88<script type="text/javascript"> 
    99<!-- 
    … …  
    5353      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li> 
    5454      <li><a href="modules.html"><span>Modules</span></a></li> 
    55       <li class="current"><a href="classes.html"><span>Classes</span></a></li> 
     55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 
    5656      <li><a href="files.html"><span>Files</span></a></li> 
    5757    </ul> 
    … …  
    5959  <div class="tabs"> 
    6060    <ul> 
    61       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li> 
    6261      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> 
     62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li> 
    6363      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li> 
    6464      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> 
    … …  
    6969</div> 
    7070<div class="contents"> 
    71 <h1>bdm::dirfilelog Class Reference</h1><!-- doxytag: class="bdm::dirfilelog" --><!-- doxytag: inherits="bdm::memlog" --><code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code> 
    72 <p> 
    73 <div class="dynheader"> 
    74 Inheritance diagram for bdm::dirfilelog:</div> 
    75 <div class="dynsection"> 
    76  
    77 <p><center><img src="classbdm_1_1dirfilelog.png" usemap="#bdm::dirfilelog_map" border="0" alt=""></center> 
    78 <map name="bdm::dirfilelog_map"> 
    79 <area href="classbdm_1_1memlog.html" alt="bdm::memlog" shape="rect" coords="0,112,90,136"> 
    80 <area href="classbdm_1_1logger.html" alt="bdm::logger" shape="rect" coords="0,56,90,80"> 
    81 <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,90,24"> 
    82 </map> 
    83 </div> 
    84  
    85 <p> 
    86 <a href="classbdm_1_1dirfilelog-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 
    87 Logging into dirfile with buffer in memory.  
    88 <p> 
    89 Dirfile is a special format used by the kst program. See documentation of kst for description.<p> 
    90 This format is used to store scalars, hence multivariate RVs must be separated. <table border="0" cellpadding="0" cellspacing="0"> 
     71<h1>bdm::dirfilelog Class Reference</h1><!-- doxytag: class="bdm::dirfilelog" --><!-- doxytag: inherits="bdm::memlog" -->Logging into dirfile with buffer in memory.   
     72<a href="#_details">More...</a> 
     73<p> 
     74<code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code> 
     75<p> 
     76 
     77<p> 
     78<a href="classbdm_1_1dirfilelog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    9179<tr><td></td></tr> 
    9280<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    … …  
    149137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> 
    150138</table> 
    151 <hr><h2>Constructor &amp; Destructor Documentation</h2> 
     139<hr><a name="_details"></a><h2>Detailed Description</h2> 
     140Logging into dirfile with buffer in memory.  
     141<p> 
     142Dirfile is a special format used by the kst program. See documentation of kst for description.<p> 
     143This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2> 
    152144<a class="anchor" name="534cdc903068764f1f243ae8fc0316a3"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="534cdc903068764f1f243ae8fc0316a3" args="(std::string dirname0, int maxlen0)" --> 
    153145<div class="memitem"> 
    … …  
    188180</div><p> 
    189181<hr><h2>Member Function Documentation</h2> 
     182<a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" --> 
     183<div class="memitem"> 
     184<div class="memproto"> 
     185      <table class="memname"> 
     186        <tr> 
     187          <td class="memname">virtual int bdm::logger::add           </td> 
     188          <td>(</td> 
     189          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td> 
     190          <td class="paramname"> <em>rv</em>, </td> 
     191        </tr> 
     192        <tr> 
     193          <td class="paramkey"></td> 
     194          <td></td> 
     195          <td class="paramtype">string&nbsp;</td> 
     196          <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
     197        </tr> 
     198        <tr> 
     199          <td></td> 
     200          <td>)</td> 
     201          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td> 
     202        </tr> 
     203      </table> 
     204</div> 
     205<div class="memdoc"> 
     206 
     207<p> 
     208returns 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>.  
     209<p>References <a class="el" href="libBM_8h-source.html#l00122">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00492">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00494">bdm::logger::names</a>.</p> 
     210 
     211<p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00069">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00150">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00710">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00586">bdm::DS::log_add()</a>.</p> 
     212 
     213</div> 
     214</div><p> 
    190215<a class="anchor" name="f595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="f595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" --> 
    191216<div class="memitem"> 
    … …  
    213238</dl> 
    214239 
    215 <p>References <a class="el" href="loggers_8h-source.html#l00068">dirname</a>, <a class="el" href="libBM_8h-source.html#l00481">bdm::logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00031">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00070">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00035">bdm::memlog::vectors</a>.</p> 
     240<p>References <a class="el" href="loggers_8h-source.html#l00068">dirname</a>, <a class="el" href="libBM_8h-source.html#l00492">bdm::logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00031">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00070">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00035">bdm::memlog::vectors</a>.</p> 
    216241 
    217242<p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00134">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00026">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00123">step()</a>.</p> 
    218  
    219 </div> 
    220 </div><p> 
    221 <a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" --> 
    222 <div class="memitem"> 
    223 <div class="memproto"> 
    224       <table class="memname"> 
    225         <tr> 
    226           <td class="memname">virtual int bdm::logger::add           </td> 
    227           <td>(</td> 
    228           <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td> 
    229           <td class="paramname"> <em>rv</em>, </td> 
    230         </tr> 
    231         <tr> 
    232           <td class="paramkey"></td> 
    233           <td></td> 
    234           <td class="paramtype">string&nbsp;</td> 
    235           <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
    236         </tr> 
    237         <tr> 
    238           <td></td> 
    239           <td>)</td> 
    240           <td></td><td></td><td><code> [inline, virtual, inherited]</code></td> 
    241         </tr> 
    242       </table> 
    243 </div> 
    244 <div class="memdoc"> 
    245  
    246 <p> 
    247 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>.  
    248 <p>References <a class="el" href="libBM_8h-source.html#l00481">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00483">bdm::logger::names</a>.</p> 
    249  
    250 <p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00069">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00150">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00699">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00575">bdm::DS::log_add()</a>.</p> 
    251243 
    252244</div> 
    … …  
    255247<li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul> 
    256248</div> 
    257 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Mar 4 18:50:25 2009 for mixpp by&nbsp; 
     249<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 15:01:39 2009 for mixpp by&nbsp; 
    258250<a href="http://www.doxygen.org/index.html"> 
    259 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 
     251<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
    260252</body> 
    261253</html>