<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>MPQC: regtime.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <h1>regtime.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span> <a name="l00002"></a>00002 <span class="comment">// regtime.h</span> <a name="l00003"></a>00003 <span class="comment">//</span> <a name="l00004"></a>00004 <span class="comment">// Copyright (C) 1996 Limit Point Systems, Inc.</span> <a name="l00005"></a>00005 <span class="comment">//</span> <a name="l00006"></a>00006 <span class="comment">// Author: Curtis Janssen <cljanss@limitpt.com></span> <a name="l00007"></a>00007 <span class="comment">// Maintainer: LPS</span> <a name="l00008"></a>00008 <span class="comment">//</span> <a name="l00009"></a>00009 <span class="comment">// This file is part of the SC Toolkit.</span> <a name="l00010"></a>00010 <span class="comment">//</span> <a name="l00011"></a>00011 <span class="comment">// The SC Toolkit is free software; you can redistribute it and/or modify</span> <a name="l00012"></a>00012 <span class="comment">// it under the terms of the GNU Library General Public License as published by</span> <a name="l00013"></a>00013 <span class="comment">// the Free Software Foundation; either version 2, or (at your option)</span> <a name="l00014"></a>00014 <span class="comment">// any later version.</span> <a name="l00015"></a>00015 <span class="comment">//</span> <a name="l00016"></a>00016 <span class="comment">// The SC Toolkit is distributed in the hope that it will be useful,</span> <a name="l00017"></a>00017 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00018"></a>00018 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00019"></a>00019 <span class="comment">// GNU Library General Public License for more details.</span> <a name="l00020"></a>00020 <span class="comment">//</span> <a name="l00021"></a>00021 <span class="comment">// You should have received a copy of the GNU Library General Public License</span> <a name="l00022"></a>00022 <span class="comment">// along with the SC Toolkit; see the file COPYING.LIB. If not, write to</span> <a name="l00023"></a>00023 <span class="comment">// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00024"></a>00024 <span class="comment">//</span> <a name="l00025"></a>00025 <span class="comment">// The U.S. Government is granted a limited license as per AL 91-7.</span> <a name="l00026"></a>00026 <span class="comment">//</span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="preprocessor">#ifdef __GNUC__</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#pragma interface</span> <a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00031"></a>00031 <span class="preprocessor"></span> <a name="l00032"></a>00032 <span class="preprocessor">#ifndef _util_misc_regtime_h</span> <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define _util_misc_regtime_h</span> <a name="l00034"></a>00034 <span class="preprocessor"></span> <a name="l00035"></a>00035 <span class="preprocessor">#include <iostream></span> <a name="l00036"></a>00036 <span class="preprocessor">#include <string></span> <a name="l00037"></a>00037 <span class="preprocessor">#include <util/class/class.h></span> <a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="keyword">namespace </span>sc { <a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="keyword">class </span>TimedRegion { <a name="l00042"></a>00042 <span class="keyword">private</span>: <a name="l00043"></a>00043 <span class="keywordtype">char</span> *name_; <a name="l00044"></a>00044 TimedRegion *up_; <a name="l00045"></a>00045 TimedRegion *subregions_; <a name="l00046"></a>00046 TimedRegion *next_; <a name="l00047"></a>00047 TimedRegion *prev_; <a name="l00048"></a>00048 <span class="keywordtype">double</span> cpu_time_; <a name="l00049"></a>00049 <span class="keywordtype">double</span> wall_time_; <a name="l00050"></a>00050 <span class="keywordtype">double</span> cpu_enter_; <a name="l00051"></a>00051 <span class="keywordtype">double</span> wall_enter_; <a name="l00052"></a>00052 <span class="keywordtype">double</span> flops_; <a name="l00053"></a>00053 <span class="keywordtype">double</span> flops_enter_; <a name="l00054"></a>00054 <a name="l00055"></a>00055 TimedRegion *insert_after(<span class="keyword">const</span> <span class="keywordtype">char</span> *name); <a name="l00056"></a>00056 TimedRegion *insert_before(<span class="keyword">const</span> <span class="keywordtype">char</span> *name); <a name="l00057"></a>00057 <span class="keyword">public</span>: <a name="l00058"></a>00058 TimedRegion(<span class="keyword">const</span> <span class="keywordtype">char</span> *name); <a name="l00059"></a>00059 ~TimedRegion(); <a name="l00060"></a>00060 <span class="keyword">const</span> <span class="keywordtype">char</span> *name()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name_; } <a name="l00061"></a>00061 TimedRegion *findinsubregion(<span class="keyword">const</span> <span class="keywordtype">char</span> *); <a name="l00062"></a>00062 <span class="keywordtype">void</span> cpu_enter(<span class="keywordtype">double</span>); <a name="l00063"></a>00063 <span class="keywordtype">void</span> wall_enter(<span class="keywordtype">double</span>); <a name="l00064"></a>00064 <span class="keywordtype">void</span> flops_enter(<span class="keywordtype">double</span>); <a name="l00065"></a>00065 <span class="keywordtype">void</span> cpu_exit(<span class="keywordtype">double</span>); <a name="l00066"></a>00066 <span class="keywordtype">void</span> wall_exit(<span class="keywordtype">double</span>); <a name="l00067"></a>00067 <span class="keywordtype">void</span> flops_exit(<span class="keywordtype">double</span>); <a name="l00068"></a>00068 <span class="keywordtype">void</span> cpu_add(<span class="keywordtype">double</span> t) { cpu_time_ += t; } <a name="l00069"></a>00069 <span class="keywordtype">void</span> wall_add(<span class="keywordtype">double</span> t) { wall_time_ += t; } <a name="l00070"></a>00070 <span class="keywordtype">void</span> flops_add(<span class="keywordtype">double</span> t) { flops_ += t; } <a name="l00071"></a>00071 TimedRegion *up()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> up_; } <a name="l00072"></a>00072 TimedRegion *subregions()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> subregions_; } <a name="l00073"></a>00073 TimedRegion *next()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> next_; } <a name="l00074"></a>00074 TimedRegion *prev()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> prev_; } <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="keywordtype">int</span> nregion(); <a name="l00077"></a>00077 <span class="keywordtype">void</span> get_region_names(<span class="keyword">const</span> <span class="keywordtype">char</span> *names[]); <a name="l00078"></a>00078 <span class="keywordtype">void</span> get_wall_times(<span class="keywordtype">double</span> *); <a name="l00079"></a>00079 <span class="keywordtype">void</span> get_cpu_times(<span class="keywordtype">double</span> *); <a name="l00080"></a>00080 <span class="keywordtype">void</span> get_flops(<span class="keywordtype">double</span> *); <a name="l00081"></a>00081 <span class="keywordtype">void</span> get_depth(<span class="keywordtype">int</span> *, <span class="keywordtype">int</span> depth = 0); <a name="l00082"></a>00082 }; <a name="l00083"></a>00083 <a name="l00089"></a><a class="code" href="classsc_1_1RegionTimer.html">00089</a> <span class="keyword">class </span><a class="code" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>: <span class="keyword">public</span> <a class="code" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> { <a name="l00090"></a>00090 <span class="keyword">protected</span>: <a name="l00091"></a>00091 <span class="keywordtype">int</span> wall_time_; <a name="l00092"></a>00092 <span class="keywordtype">int</span> cpu_time_; <a name="l00093"></a>00093 <span class="keywordtype">int</span> flops_; <a name="l00094"></a>00094 <a name="l00095"></a>00095 TimedRegion *top_; <a name="l00096"></a>00096 TimedRegion *current_; <a name="l00097"></a>00097 TimedRegion *default_; <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="keyword">public</span>: <a name="l00100"></a>00100 <a class="code" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *topname = <span class="stringliteral">"total"</span>, <a name="l00101"></a>00101 <span class="keywordtype">int</span> cpu_time = 0, <span class="keywordtype">int</span> wall_time = 1); <a name="l00102"></a>00102 <a class="code" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>(<span class="keyword">const</span> <a class="code" href="classsc_1_1Ref.html">Ref<KeyVal></a> &); <a name="l00103"></a>00103 ~<a class="code" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>(); <a name="l00104"></a>00104 <span class="keywordtype">void</span> enter(<span class="keyword">const</span> <span class="keywordtype">char</span> * = 0); <a name="l00105"></a>00105 <span class="keywordtype">void</span> change(<span class="keyword">const</span> <span class="keywordtype">char</span> *newname, <span class="keyword">const</span> <span class="keywordtype">char</span> * oldname = 0); <a name="l00106"></a>00106 <span class="keywordtype">void</span> exit(<span class="keyword">const</span> <span class="keywordtype">char</span> * = 0, <span class="keywordtype">bool</span> do_not_throw = <span class="keyword">false</span>); <a name="l00107"></a>00107 <span class="keywordtype">void</span> set_default(<span class="keyword">const</span> <span class="keywordtype">char</span> *); <a name="l00108"></a>00108 <span class="keywordtype">void</span> unset_default(); <a name="l00109"></a>00109 <span class="keywordtype">void</span> enter_default(); <a name="l00110"></a>00110 <span class="keywordtype">void</span> exit_default(); <a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsc_1_1RegionTimer.html#fe85ee9165be853d94e4265df0be812a" title="Print the object.">print</a>(std::ostream& = <a class="code" href="classsc_1_1ExEnv.html#360216acd1f990e999c0ed46cb350b1f" title="Return an ostream that writes from node 0.">ExEnv::out0</a>()) <span class="keyword">const</span>; <a name="l00112"></a>00112 <a name="l00113"></a>00113 <span class="keywordtype">void</span> update_top() <span class="keyword">const</span>; <a name="l00114"></a>00114 <a name="l00115"></a>00115 <span class="keywordtype">int</span> nregion() <span class="keyword">const</span>; <a name="l00116"></a>00116 <span class="keywordtype">void</span> get_region_names(<span class="keyword">const</span> <span class="keywordtype">char</span> *names[]) <span class="keyword">const</span>; <a name="l00117"></a>00117 <span class="keywordtype">void</span> get_wall_times(<span class="keywordtype">double</span> *) <span class="keyword">const</span>; <a name="l00118"></a>00118 <span class="keywordtype">void</span> get_cpu_times(<span class="keywordtype">double</span> *) <span class="keyword">const</span>; <a name="l00119"></a>00119 <span class="keywordtype">void</span> get_flops(<span class="keywordtype">double</span> *) <span class="keyword">const</span>; <a name="l00120"></a>00120 <span class="keywordtype">void</span> get_depth(<span class="keywordtype">int</span> *) <span class="keyword">const</span>; <a name="l00121"></a>00121 <a name="l00122"></a>00122 <span class="keywordtype">double</span> get_wall_time() <span class="keyword">const</span>; <a name="l00123"></a>00123 <span class="keywordtype">double</span> get_cpu_time() <span class="keyword">const</span>; <a name="l00124"></a>00124 <span class="keywordtype">double</span> get_flops() <span class="keyword">const</span>; <a name="l00125"></a>00125 <a name="l00126"></a>00126 <span class="keywordtype">void</span> add_wall_time(<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keywordtype">double</span>); <a name="l00127"></a>00127 <span class="keywordtype">void</span> add_cpu_time(<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keywordtype">double</span>); <a name="l00128"></a>00128 <span class="keywordtype">void</span> add_flops(<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keywordtype">double</span>); <a name="l00129"></a>00129 <a name="l00130"></a>00130 <span class="keyword">static</span> <a class="code" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a> *default_regiontimer(); <a name="l00131"></a>00131 <span class="keyword">static</span> <span class="keywordtype">void</span> set_default_regiontimer(<span class="keyword">const</span> <a class="code" href="classsc_1_1Ref.html">Ref<RegionTimer></a> &); <a name="l00132"></a>00132 }; <a name="l00133"></a>00133 <a name="l00140"></a><a class="code" href="classsc_1_1Timer.html">00140</a> <span class="keyword">class </span><a class="code" href="classsc_1_1Timer.html" title="The Timer class uses RegionTimer to time intervals in an exception safe manner.">Timer</a> { <a name="l00141"></a>00141 <a class="code" href="classsc_1_1Ref.html">Ref<RegionTimer></a> timer_; <a name="l00142"></a>00142 std::string name_; <a name="l00143"></a>00143 <span class="keywordtype">bool</span> active_; <a name="l00144"></a>00144 <span class="keyword">public</span>: <a name="l00148"></a>00148 <a class="code" href="classsc_1_1Timer.html#a30a2e3d0847775639225989d93ff86b" title="Start timing a region using the default RegionTimer and activate the timer.">Timer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name); <a name="l00151"></a>00151 <a class="code" href="classsc_1_1Timer.html#a30a2e3d0847775639225989d93ff86b" title="Start timing a region using the default RegionTimer and activate the timer.">Timer</a>(<span class="keyword">const</span> <a class="code" href="classsc_1_1Ref.html">Ref<RegionTimer></a> &, <span class="keyword">const</span> <span class="keywordtype">char</span> *name); <a name="l00153"></a>00153 <a class="code" href="classsc_1_1Timer.html#3aae3e301472417c0e235e4dad4c72e9" title="Stop timing a region, if active.">~Timer</a>(); <a name="l00157"></a>00157 <span class="keywordtype">void</span> <a class="code" href="classsc_1_1Timer.html#4cd310724169a05f099593e917212a7c" title="Stop timing the current region, if active.">reset</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * = 0); <a name="l00158"></a>00158 }; <a name="l00159"></a>00159 <a name="l00160"></a>00160 } <a name="l00161"></a>00161 <a name="l00162"></a>00162 <span class="preprocessor">#endif</span> <a name="l00163"></a>00163 <span class="preprocessor"></span> <a name="l00164"></a>00164 <span class="comment">// Local Variables:</span> <a name="l00165"></a>00165 <span class="comment">// mode: c++</span> <a name="l00166"></a>00166 <span class="comment">// c-file-style: "CLJ"</span> <a name="l00167"></a>00167 <span class="comment">// End:</span> </pre></div></div> <hr> <address> <small> Generated at Wed Oct 14 14:12:11 2009 for <a href="http://www.mpqc.org">MPQC</a> 2.3.1 using the documentation package <a href="http://www.doxygen.org">Doxygen</a> 1.5.9. </small> </address> </body> </html>