Show
Ignore:
Timestamp:
06/02/09 10:08:06 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1logger.html

    r323 r353  
    8383 
    8484<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr> 
    85 <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#cfb4807e20b3d00f3d33e55ada528dc1">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string name=&quot;&quot;)</td></tr> 
     85<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> 
    8686 
    8787<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="397c014b0aaf3581516e2a105d26a5c9"></a><!-- doxytag: member="bdm::logger::logit" ref="397c014b0aaf3581516e2a105d26a5c9" args="(int id, const vec &amp;v)=0" --> 
     
    8989 
    9090<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr> 
     91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3f1697214a9281b80f0914f08d4246c"></a><!-- doxytag: member="bdm::logger::logit" ref="a3f1697214a9281b80f0914f08d4246c" args="(int id, const double &amp;d)=0" --> 
     92virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a3f1697214a9281b80f0914f08d4246c">logit</a> (int id, const double &amp;d)=0</td></tr> 
     93 
     94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr> 
    9195<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" --> 
    9296virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr> 
     
    101105 
    102106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the storage. <br></td></tr> 
     107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::logger::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" --> 
     108virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr> 
     109 
     110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
     111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::logger::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
     112virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr> 
     113 
     114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> 
     115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="bdm::logger::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" --> 
     116virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#a80210bbe266bf26f100f342460a313f">to_setting</a> (Setting &amp;root)</td></tr> 
     117 
     118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    103119<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    104120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> 
    105 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> 
     121<a class="el" href="classitpp_1_1Array.html">Array</a>&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> 
    106122 
    107123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr> 
    108124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
    109 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
     125<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
    110126 
    111127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> 
     
    115131<p> 
    116132This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a>. Specializations of this abstract class for specific storage method are designed. <hr><h2>Member Function Documentation</h2> 
    117 <a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::logger::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" --> 
     133<a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::logger::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
    118134<div class="memitem"> 
    119135<div class="memproto"> 
     
    129145          <td></td> 
    130146          <td class="paramtype">string&nbsp;</td> 
    131           <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
     147          <td class="paramname"> <em>prefix</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
    132148        </tr> 
    133149        <tr> 
     
    142158<p> 
    143159returns 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>.  
    144 <p>References <a class="el" href="libBM_8h-source.html#l00122">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00492">entries</a>, and <a class="el" href="libBM_8h-source.html#l00494">names</a>.</p> 
     160<p>References <a class="el" href="libBM_8h-source.html#l00145">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00515">entries</a>, <a class="el" href="array_8h-source.html#l00157">itpp::Array&lt; T &gt;::length()</a>, <a class="el" href="libBM_8h-source.html#l00517">names</a>, and <a class="el" href="array_8h-source.html#l00161">itpp::Array&lt; T &gt;::set_length()</a>.</p> 
    145161 
    146 <p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00153">pmsmCRB::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00083">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00177">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00711">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00587">bdm::DS::log_add()</a>.</p> 
     162<p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00201">pmsmCRBMz::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00169">pmsmCRB::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00093">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00181">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00741">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00612">bdm::DS::log_add()</a>.</p> 
    147163 
    148164</div> 
     
    151167<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul> 
    152168</div> 
    153 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:45 2009 for mixpp by&nbsp; 
     169<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp; 
    154170<a href="http://www.doxygen.org/index.html"> 
    155171<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>