sc::RegionTimer(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

hiii bestie, welcome to sc::RegionTimer(3) — the MPQC manual page 💅

NAME 💖

sc::RegionTimer is the class you use to record the time spent in a section of code. literally its whole job, no cap.

SYNOPSIS ✨

#include <regtime.h>

Inherits sc::DescribedClass.

Inherited by sc::ParallelRegionTimer.

Public Member Functions 🫶

okay here's the full roster, every signature exactly as it appears — no skips, bestie:

  • RegionTimer (const char *topname='total', int cpu_time=0, int wall_time=1)
  • RegionTimer (const Ref< KeyVal > &)
  • void enter (const char *=0)
  • void change (const char *newname, const char *oldname=0)
  • void exit (const char *=0, bool do_not_throw=false)
  • void set_default (const char *)
  • void unset_default ()
  • void enter_default ()
  • void exit_default ()
  • virtual void print (std::ostream &=ExEnv::out0()) const — Print the object. yes, it literally prints the object, periodt.
  • void update_top () const
  • int nregion () const
  • void get_region_names (const char *names[]) const
  • void get_wall_times (double *) const
  • void get_cpu_times (double *) const
  • void get_flops (double *) const
  • void get_depth (int *) const
  • double get_wall_time () const
  • double get_cpu_time () const
  • double get_flops () const
  • void add_wall_time (const char *, double)
  • void add_cpu_time (const char *, double)
  • void add_flops (const char *, double)

Static Public Member Functions 🌈

static besties, right this way:

  • static RegionTimer * default_regiontimer ()
  • static void set_default_regiontimer (const Ref< RegionTimer > &)

Protected Attributes 🍓

the protected little guys:

  • int wall_time_
  • int cpu_time_
  • int flops_
  • TimedRegion * top_
  • TimedRegion * current_
  • TimedRegion * default_

Additional Inherited Members 🙈

no extra entries are listed under this heading on this page, bestie. that's the whole section. 💀

Detailed Description 🦋

The RegionTimer class is used to record the time spent in a section of code. iconic timing behavior.

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. slay.

Author 🎀

This page was generated automatically by Doxygen for MPQC from the source code.

okay bye bestie — this was the sc::RegionTimer(3) page from MPQC, Version 2.3.1, dated Sun Oct 4 2020. mwah 💋✨

📦 where this page comes from