.TH "sc::RegionTimer" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::RegionTimer \- The \fBRegionTimer\fP class is used to record the time spent in a section of code\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <regtime\&.h>\fP
.PP
Inherits \fBsc::DescribedClass\fP\&.
.PP
Inherited by \fBsc::ParallelRegionTimer\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBRegionTimer\fP (const char *topname='total', int cpu_time=0, int wall_time=1)"
.br
.ti -1c
.RI "\fBRegionTimer\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.ti -1c
.RI "void \fBenter\fP (const char *=0)"
.br
.ti -1c
.RI "void \fBchange\fP (const char *newname, const char *oldname=0)"
.br
.ti -1c
.RI "void \fBexit\fP (const char *=0, bool do_not_throw=false)"
.br
.ti -1c
.RI "void \fBset_default\fP (const char *)"
.br
.ti -1c
.RI "void \fBunset_default\fP ()"
.br
.ti -1c
.RI "void \fBenter_default\fP ()"
.br
.ti -1c
.RI "void \fBexit_default\fP ()"
.br
.ti -1c
.RI "virtual void \fBprint\fP (std::ostream &=\fBExEnv::out0\fP()) const"
.br
.RI "Print the object\&. "
.ti -1c
.RI "void \fBupdate_top\fP () const"
.br
.ti -1c
.RI "int \fBnregion\fP () const"
.br
.ti -1c
.RI "void \fBget_region_names\fP (const char *names[]) const"
.br
.ti -1c
.RI "void \fBget_wall_times\fP (double *) const"
.br
.ti -1c
.RI "void \fBget_cpu_times\fP (double *) const"
.br
.ti -1c
.RI "void \fBget_flops\fP (double *) const"
.br
.ti -1c
.RI "void \fBget_depth\fP (int *) const"
.br
.ti -1c
.RI "double \fBget_wall_time\fP () const"
.br
.ti -1c
.RI "double \fBget_cpu_time\fP () const"
.br
.ti -1c
.RI "double \fBget_flops\fP () const"
.br
.ti -1c
.RI "void \fBadd_wall_time\fP (const char *, double)"
.br
.ti -1c
.RI "void \fBadd_cpu_time\fP (const char *, double)"
.br
.ti -1c
.RI "void \fBadd_flops\fP (const char *, double)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBRegionTimer\fP * \fBdefault_regiontimer\fP ()"
.br
.ti -1c
.RI "static void \fBset_default_regiontimer\fP (const \fBRef\fP< \fBRegionTimer\fP > &)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "int \fBwall_time_\fP"
.br
.ti -1c
.RI "int \fBcpu_time_\fP"
.br
.ti -1c
.RI "int \fBflops_\fP"
.br
.ti -1c
.RI "\fBTimedRegion\fP * \fBtop_\fP"
.br
.ti -1c
.RI "\fBTimedRegion\fP * \fBcurrent_\fP"
.br
.ti -1c
.RI "\fBTimedRegion\fP * \fBdefault_\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBRegionTimer\fP class is used to record the time spent in a section of code\&. 

During the run of a code, enter and exit members are called to begin and end timed sections\&. The print member is used to display the obtained times\&. Multiple enter calls for a region with the same name aggregate the timings\&. Nested regions are supported\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.