Changeset 353 for doc/html/classbdm_1_1logger.html
- Timestamp:
- 06/02/09 10:08:06 (16 years ago)
- Files:
-
- 1 modified
Legend:
- Unmodified
- Added
- Removed
-
doc/html/classbdm_1_1logger.html
r323 r353 83 83 84 84 <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr> 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </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> &rv, string name="")</td></tr>85 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </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> &rv, string prefix="")</td></tr> 86 86 87 87 <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 &v)=0" --> … … 89 89 90 90 <tr><td class="mdescLeft"> </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 &d)=0" --> 92 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a3f1697214a9281b80f0914f08d4246c">logit</a> (int id, const double &d)=0</td></tr> 93 94 <tr><td class="mdescLeft"> </td><td class="mdescRight">log this double <br></td></tr> 91 95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" --> 92 96 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr> … … 101 105 102 106 <tr><td class="mdescLeft"> </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="()" --> 108 virtual string </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"> </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 &root)" --> 112 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &root)</td></tr> 113 114 <tr><td class="mdescLeft"> </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 &root)" --> 116 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#a80210bbe266bf26f100f342460a313f">to_setting</a> (Setting &root)</td></tr> 117 118 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 103 119 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 104 120 <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< <a class="el" href="classbdm_1_1RV.html">RV</a> > </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>< <a class="el" href="classbdm_1_1RV.html">RV</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#c54566a4554089443a20b2a49ed1a61f">entries</a></td></tr> 106 122 107 123 <tr><td class="mdescLeft"> </td><td class="mdescRight">RVs of all logged variables. <br></td></tr> 108 124 <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< string > </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>< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> 110 126 111 127 <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> … … 115 131 <p> 116 132 This 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 &rv, string name="")" -->133 <a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::logger::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &rv, string prefix="")" --> 118 134 <div class="memitem"> 119 135 <div class="memproto"> … … 129 145 <td></td> 130 146 <td class="paramtype">string </td> 131 <td class="paramname"> <em> name</em> = <code>""</code></td><td> </td>147 <td class="paramname"> <em>prefix</em> = <code>""</code></td><td> </td> 132 148 </tr> 133 149 <tr> … … 142 158 <p> 143 159 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>. 144 <p>References <a class="el" href="libBM_8h-source.html#l001 22">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< T >::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< T >::set_length()</a>.</p> 145 161 146 <p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00 153">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> 147 163 148 164 </div> … … 151 167 <li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul> 152 168 </div> 153 <hr size="1"><address style="text-align: right;"><small>Generated on T hu Apr 23 21:06:452009 for mixpp by 169 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by 154 170 <a href="http://www.doxygen.org/index.html"> 155 171 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>