| [259] | 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"> | 
|---|
 | 3 | <title>mixpp: bdm::memlog Class Reference</title> | 
|---|
 | 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> | 
|---|
 | 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> | 
|---|
 | 6 | </head><body> | 
|---|
 | 7 | <!-- Generated by Doxygen 1.5.6 --> | 
|---|
| [271] | 8 | <script type="text/javascript"> | 
|---|
 | 9 | <!-- | 
|---|
 | 10 | function changeDisplayState (e){ | 
|---|
 | 11 |   var num=this.id.replace(/[^[0-9]/g,''); | 
|---|
 | 12 |   var button=this.firstChild; | 
|---|
 | 13 |   var sectionDiv=document.getElementById('dynsection'+num); | 
|---|
 | 14 |   if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ | 
|---|
 | 15 |     sectionDiv.style.display='block'; | 
|---|
 | 16 |     button.src='open.gif'; | 
|---|
 | 17 |   }else{ | 
|---|
 | 18 |     sectionDiv.style.display='none'; | 
|---|
 | 19 |     button.src='closed.gif'; | 
|---|
 | 20 |   } | 
|---|
 | 21 | } | 
|---|
 | 22 | function initDynSections(){ | 
|---|
 | 23 |   var divs=document.getElementsByTagName('div'); | 
|---|
 | 24 |   var sectionCounter=1; | 
|---|
 | 25 |   for(var i=0;i<divs.length-1;i++){ | 
|---|
 | 26 |     if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ | 
|---|
 | 27 |       var header=divs[i]; | 
|---|
 | 28 |       var section=divs[i+1]; | 
|---|
 | 29 |       var button=header.firstChild; | 
|---|
 | 30 |       if (button!='IMG'){ | 
|---|
 | 31 |         divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); | 
|---|
 | 32 |         button=document.createElement('img'); | 
|---|
 | 33 |         divs[i].insertBefore(button,divs[i].firstChild); | 
|---|
 | 34 |       } | 
|---|
 | 35 |       header.style.cursor='pointer'; | 
|---|
 | 36 |       header.onclick=changeDisplayState; | 
|---|
 | 37 |       header.id='dynheader'+sectionCounter; | 
|---|
 | 38 |       button.src='closed.gif'; | 
|---|
 | 39 |       section.id='dynsection'+sectionCounter; | 
|---|
 | 40 |       section.style.display='none'; | 
|---|
 | 41 |       section.style.marginLeft='14px'; | 
|---|
 | 42 |       sectionCounter++; | 
|---|
 | 43 |     } | 
|---|
 | 44 |   } | 
|---|
 | 45 | } | 
|---|
 | 46 | window.onload = initDynSections; | 
|---|
 | 47 | --> | 
|---|
 | 48 | </script> | 
|---|
| [259] | 49 | <div class="navigation" id="top"> | 
|---|
 | 50 |   <div class="tabs"> | 
|---|
 | 51 |     <ul> | 
|---|
| [271] | 52 |       <li><a href="main.html"><span>Main Page</span></a></li> | 
|---|
| [259] | 53 |       <li><a href="pages.html"><span>Related Pages</span></a></li> | 
|---|
 | 54 |       <li><a href="modules.html"><span>Modules</span></a></li> | 
|---|
| [261] | 55 |       <li class="current"><a href="classes.html"><span>Classes</span></a></li> | 
|---|
| [259] | 56 |       <li><a href="files.html"><span>Files</span></a></li> | 
|---|
 | 57 |     </ul> | 
|---|
 | 58 |   </div> | 
|---|
 | 59 |   <div class="tabs"> | 
|---|
 | 60 |     <ul> | 
|---|
| [261] | 61 |       <li><a href="classes.html"><span>Alphabetical List</span></a></li> | 
|---|
| [259] | 62 |       <li><a href="annotated.html"><span>Class List</span></a></li> | 
|---|
 | 63 |       <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> | 
|---|
 | 64 |       <li><a href="functions.html"><span>Class Members</span></a></li> | 
|---|
 | 65 |     </ul> | 
|---|
 | 66 |   </div> | 
|---|
| [271] | 67 |   <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1memlog.html">memlog</a> | 
|---|
| [259] | 68 |   </div> | 
|---|
 | 69 | </div> | 
|---|
 | 70 | <div class="contents"> | 
|---|
| [270] | 71 | <h1>bdm::memlog Class Reference</h1><!-- doxytag: class="bdm::memlog" --><!-- doxytag: inherits="bdm::logger" --><code>#include <<a class="el" href="loggers_8h-source.html">loggers.h</a>></code> | 
|---|
| [259] | 72 | <p> | 
|---|
 | 73 | <div class="dynheader"> | 
|---|
 | 74 | Inheritance diagram for bdm::memlog:</div> | 
|---|
 | 75 | <div class="dynsection"> | 
|---|
 | 76 |  | 
|---|
| [271] | 77 | <p><center><img src="classbdm_1_1memlog.png" usemap="#bdm::memlog_map" border="0" alt=""></center> | 
|---|
 | 78 | <map name="bdm::memlog_map"> | 
|---|
 | 79 | <area href="classbdm_1_1logger.html" alt="bdm::logger" shape="rect" coords="0,56,90,80"> | 
|---|
 | 80 | <area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,90,24"> | 
|---|
 | 81 | <area href="classbdm_1_1dirfilelog.html" alt="bdm::dirfilelog" shape="rect" coords="0,168,90,192"> | 
|---|
 | 82 | </map> | 
|---|
 | 83 | </div> | 
|---|
 | 84 |  | 
|---|
| [259] | 85 | <p> | 
|---|
| [270] | 86 | <a href="classbdm_1_1memlog-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> | 
|---|
 | 87 | Logging into matrices in data format in memory.  | 
|---|
 | 88 | <p> | 
|---|
 | 89 | More?... <table border="0" cellpadding="0" cellspacing="0"> | 
|---|
| [259] | 90 | <tr><td></td></tr> | 
|---|
 | 91 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | 
|---|
 | 92 | <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)" --> | 
|---|
 | 93 |  </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#e761799874d28bbfc4edc121be8c0a86">memlog</a> (int maxlen0)</td></tr> | 
|---|
 | 94 |  | 
|---|
 | 95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr> | 
|---|
 | 96 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3a8b007f3540523ff3f9910d9089391"></a><!-- doxytag: member="bdm::memlog::init" ref="d3a8b007f3540523ff3f9910d9089391" args="()" --> | 
|---|
 | 97 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#d3a8b007f3540523ff3f9910d9089391">init</a> ()</td></tr> | 
|---|
 | 98 |  | 
|---|
 | 99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize storage. <br></td></tr> | 
|---|
 | 100 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69964f0472e53098528ee41507bdfc77"></a><!-- doxytag: member="bdm::memlog::step" ref="69964f0472e53098528ee41507bdfc77" args="()" --> | 
|---|
 | 101 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#69964f0472e53098528ee41507bdfc77">step</a> ()</td></tr> | 
|---|
 | 102 |  | 
|---|
 | 103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr> | 
|---|
 | 104 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="364e58c5d7058776c2a9cfa7d58dad6d"></a><!-- doxytag: member="bdm::memlog::logit" ref="364e58c5d7058776c2a9cfa7d58dad6d" args="(int id, const vec &v)" --> | 
|---|
 | 105 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#364e58c5d7058776c2a9cfa7d58dad6d">logit</a> (int id, const vec &v)</td></tr> | 
|---|
 | 106 |  | 
|---|
 | 107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">log this vector <br></td></tr> | 
|---|
 | 108 | <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)" --> | 
|---|
 | 109 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr> | 
|---|
 | 110 |  | 
|---|
 | 111 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr> | 
|---|
| [271] | 112 | <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> | 
|---|
| [259] | 113 |  | 
|---|
 | 114 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::memlog::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" --> | 
|---|
 | 115 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr> | 
|---|
 | 116 |  | 
|---|
 | 117 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize storing information. <br></td></tr> | 
|---|
 | 118 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> | 
|---|
 | 119 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::memlog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" --> | 
|---|
 | 120 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr> | 
|---|
 | 121 |  | 
|---|
 | 122 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr> | 
|---|
 | 123 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::memlog::ind" ref="70cec1d3549a82796ad7b6f0d07a4570" args="" --> | 
|---|
 | 124 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr> | 
|---|
 | 125 |  | 
|---|
 | 126 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Currect record to be written. <br></td></tr> | 
|---|
 | 127 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::memlog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" --> | 
|---|
 | 128 | Array< mat > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr> | 
|---|
 | 129 |  | 
|---|
 | 130 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Storage. <br></td></tr> | 
|---|
 | 131 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::memlog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> | 
|---|
 | 132 | 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> | 
|---|
 | 133 |  | 
|---|
 | 134 | <tr><td class="mdescLeft"> </td><td class="mdescRight">RVs of all logged variables. <br></td></tr> | 
|---|
 | 135 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::memlog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> | 
|---|
 | 136 | Array< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> | 
|---|
 | 137 |  | 
|---|
 | 138 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> | 
|---|
 | 139 | </table> | 
|---|
| [271] | 140 | <hr><h2>Member Function Documentation</h2> | 
|---|
 | 141 | <a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::memlog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &rv, string name="")" --> | 
|---|
 | 142 | <div class="memitem"> | 
|---|
 | 143 | <div class="memproto"> | 
|---|
 | 144 |       <table class="memname"> | 
|---|
 | 145 |         <tr> | 
|---|
 | 146 |           <td class="memname">virtual int bdm::logger::add           </td> | 
|---|
 | 147 |           <td>(</td> | 
|---|
 | 148 |           <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> & </td> | 
|---|
 | 149 |           <td class="paramname"> <em>rv</em>, </td> | 
|---|
 | 150 |         </tr> | 
|---|
 | 151 |         <tr> | 
|---|
 | 152 |           <td class="paramkey"></td> | 
|---|
 | 153 |           <td></td> | 
|---|
 | 154 |           <td class="paramtype">string </td> | 
|---|
 | 155 |           <td class="paramname"> <em>name</em> = <code>""</code></td><td> </td> | 
|---|
 | 156 |         </tr> | 
|---|
 | 157 |         <tr> | 
|---|
 | 158 |           <td></td> | 
|---|
 | 159 |           <td>)</td> | 
|---|
 | 160 |           <td></td><td></td><td><code> [inline, virtual, inherited]</code></td> | 
|---|
 | 161 |         </tr> | 
|---|
 | 162 |       </table> | 
|---|
 | 163 | </div> | 
|---|
 | 164 | <div class="memdoc"> | 
|---|
 | 165 |  | 
|---|
 | 166 | <p> | 
|---|
 | 167 | 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>.  | 
|---|
 | 168 | <p>References <a class="el" href="libBM_8h-source.html#l00476">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00478">bdm::logger::names</a>.</p> | 
|---|
 | 169 |  | 
|---|
 | 170 | <p>Referenced by <a class="el" href="libDS_8h-source.html#l00121">bdm::ArxDS::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00570">bdm::DS::log_add()</a>.</p> | 
|---|
 | 171 |  | 
|---|
 | 172 | </div> | 
|---|
 | 173 | </div><p> | 
|---|
| [270] | 174 | <hr>The documentation for this class was generated from the following files:<ul> | 
|---|
| [261] | 175 | <li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul> | 
|---|
| [259] | 176 | </div> | 
|---|
| [271] | 177 | <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 15 23:09:57 2009 for mixpp by  | 
|---|
| [259] | 178 | <a href="http://www.doxygen.org/index.html"> | 
|---|
 | 179 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> | 
|---|
 | 180 | </body> | 
|---|
 | 181 | </html> | 
|---|