root/doc/html/group__timers.html @ 353

Revision 353, 7.0 kB (checked in by smidl, 16 years ago)

doc

Line 
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: Timers</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function 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}
22function 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}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59</div>
60<div class="contents">
61<h1>Timers<br>
62<small>
63[<a class="el" href="group__base.html">Base Module</a>]</small>
64</h1><table border="0" cellpadding="0" cellspacing="0">
65<tr><td></td></tr>
66<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Timer.html">itpp::Timer</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A virtual base class for timers.  <a href="classitpp_1_1Timer.html#_details">More...</a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1CPU__Timer.html">itpp::CPU_Timer</a></td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A CPU time timer class<p>
73Measures the time spent by the CPU on the current process. If two processes are running concurrently, one real seconds equal 5 CPU seconds per process. The resolution is not very good (in the order of 0.01 seconds).  <a href="classitpp_1_1CPU__Timer.html#_details">More...</a><br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Real__Timer.html">itpp::Real_Timer</a></td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A real time timer class<p>
77Measures real time.  <a href="classitpp_1_1Real__Timer.html#_details">More...</a><br></td></tr>
78<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c1fa2a92a7d4e69002c91dfe0c41483"></a><!-- doxytag: member="timers::tic" ref="g4c1fa2a92a7d4e69002c91dfe0c41483" args="()" -->
80void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timers.html#g4c1fa2a92a7d4e69002c91dfe0c41483">itpp::tic</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and start timer. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbff8c6df34e4a24154d05bd64e1afc4f"></a><!-- doxytag: member="timers::toc" ref="gbff8c6df34e4a24154d05bd64e1afc4f" args="()" -->
84double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timers.html#gbff8c6df34e4a24154d05bd64e1afc4f">itpp::toc</a> ()</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the elapsed time since last <a class="el" href="group__timers.html#g4c1fa2a92a7d4e69002c91dfe0c41483" title="Reset and start timer.">tic()</a>. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb764b6e7f306577aeec8909ee818748c"></a><!-- doxytag: member="timers::toc_print" ref="gb764b6e7f306577aeec8909ee818748c" args="()" -->
88void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timers.html#gb764b6e7f306577aeec8909ee818748c">itpp::toc_print</a> ()</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints the elapsed time since last <a class="el" href="group__timers.html#g4c1fa2a92a7d4e69002c91dfe0c41483" title="Reset and start timer.">tic()</a>. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__timers.html#g5a01025d79b50aed2c516aa5206ef436">itpp::pause</a> (double t=-1)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pause  <a href="#g5a01025d79b50aed2c516aa5206ef436"></a><br></td></tr>
94</table>
95<hr><h2>Function Documentation</h2>
96<a class="anchor" name="g5a01025d79b50aed2c516aa5206ef436"></a><!-- doxytag: member="itpp::pause" ref="g5a01025d79b50aed2c516aa5206ef436" args="(double t=&#45;1)" -->
97<div class="memitem">
98<div class="memproto">
99      <table class="memname">
100        <tr>
101          <td class="memname">void itpp::pause           </td>
102          <td>(</td>
103          <td class="paramtype">double&nbsp;</td>
104          <td class="paramname"> <em>t</em> = <code>-1</code>          </td>
105          <td>&nbsp;)&nbsp;</td>
106          <td></td>
107        </tr>
108      </table>
109</div>
110<div class="memdoc">
111
112<p>
113pause
114<p>
115<div class="fragment"><pre class="fragment"> <a class="code" href="group__timers.html#g5a01025d79b50aed2c516aa5206ef436" title="pause">pause</a>(n);
116</pre></div> Pauses for n seconds before continuing <div class="fragment"><pre class="fragment"> <a class="code" href="group__timers.html#g5a01025d79b50aed2c516aa5206ef436" title="pause">pause</a>();
117</pre></div> Pauses until a key is pressed
118<p>References <a class="el" href="timing_8cpp-source.html#l00112">itpp::Timer::get_time()</a>, and <a class="el" href="timing_8cpp-source.html#l00085">itpp::Timer::start()</a>.</p>
119
120</div>
121</div><p>
122</div>
123<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
124<a href="http://www.doxygen.org/index.html">
125<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
126</body>
127</html>
Note: See TracBrowser for help on using the browser.