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

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1memlog.html

    r323 r353  
    7979<tr><td></td></tr> 
    8080<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e761799874d28bbfc4edc121be8c0a86"></a><!-- doxytag: member="bdm::memlog::memlog" ref="e761799874d28bbfc4edc121be8c0a86" args="(int maxlen0)" --> 
    82 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#e761799874d28bbfc4edc121be8c0a86">memlog</a> (int maxlen0)</td></tr> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="611dda03b3050de2eaa448a59cee9c27"></a><!-- doxytag: member="bdm::memlog::memlog" ref="611dda03b3050de2eaa448a59cee9c27" args="(int maxlen0, string itf=&quot;&quot;)" --> 
     82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#611dda03b3050de2eaa448a59cee9c27">memlog</a> (int maxlen0, string itf=&quot;&quot;)</td></tr> 
    8383 
    8484<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr> 
     
    9595 
    9696<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b57dbd3dff49a98c6ce8fccccb170af"></a><!-- doxytag: member="bdm::memlog::logit" ref="2b57dbd3dff49a98c6ce8fccccb170af" args="(int id, const double &amp;d)" --> 
     98void&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> 
     99 
     100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr> 
    97101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a74b7a3d889607391594279112aef1f"></a><!-- doxytag: member="bdm::memlog::itsave" ref="6a74b7a3d889607391594279112aef1f" args="(const char *fname)" --> 
    98102void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr> 
    99103 
    100104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr> 
    101 <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> 
    102  
    103 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::memlog::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" --> 
    104 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr> 
     105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39e32f671414c71304e316976ccc37f3"></a><!-- doxytag: member="bdm::memlog::finalize" ref="39e32f671414c71304e316976ccc37f3" args="()" --> 
     106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#39e32f671414c71304e316976ccc37f3">finalize</a> ()</td></tr> 
    105107 
    106108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr> 
     109<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> 
     110 
     111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::memlog::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" --> 
     112virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr> 
     113 
     114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
     115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::memlog::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" --> 
     116virtual 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> 
     117 
     118<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> 
     119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="bdm::memlog::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" --> 
     120virtual 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> 
     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> 
    107123<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    108124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::memlog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" --> 
     
    115131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr> 
    116132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::memlog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" --> 
    117 Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
     133<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> 
    118134 
    119135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr> 
     136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::memlog::itfilename" ref="11fdf8ffca0f509ff637b0c3ac161c1f" args="" --> 
     137string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr> 
     138 
     139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br></td></tr> 
    120140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::memlog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> 
    121 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> 
     141<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> 
    122142 
    123143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr> 
    124144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::memlog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> 
    125 Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 
     145<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> 
    126146 
    127147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> 
     
    131151<p> 
    132152More?... <hr><h2>Member Function Documentation</h2> 
    133 <a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::memlog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" --> 
     153<a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::memlog::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" --> 
    134154<div class="memitem"> 
    135155<div class="memproto"> 
     
    145165          <td></td> 
    146166          <td class="paramtype">string&nbsp;</td> 
    147           <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
     167          <td class="paramname"> <em>prefix</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
    148168        </tr> 
    149169        <tr> 
     
    158178<p> 
    159179returns 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>.  
    160 <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> 
     180<p>References <a class="el" href="libBM_8h-source.html#l00145">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00515">bdm::logger::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">bdm::logger::names</a>, and <a class="el" href="array_8h-source.html#l00161">itpp::Array&lt; T &gt;::set_length()</a>.</p> 
    161181 
    162 <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> 
     182<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> 
    163183 
    164184</div> 
     
    167187<li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul> 
    168188</div> 
    169 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:46 2009 for mixpp by&nbsp; 
     189<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp; 
    170190<a href="http://www.doxygen.org/index.html"> 
    171191<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>