sc::TimedRegion(3)

✨ NAME ✨

sc::TimedRegion — that's it, that's the name, bestie. No long fancy subtitle, just a C++ class hanging out in the sc:: namespace waiting to clock your regions for you. 💅

---

🌸 SYNOPSIS 🌸

💖 Public Member Functions 💖

okay so here's the whole roster, no cap, every single one of them, exactly as written:

TimedRegion (const char *name)
const char * name () const
TimedRegion * findinsubregion (const char *)
void cpu_enter (double)
void wall_enter (double)
void flops_enter (double)
void flops_exit (double)
void cpu_exit (double)
void wall_exit (double)
void cpu_add (double t)
void wall_add (double t)
void flops_add (double t)
TimedRegion * up () const
TimedRegion * subregions () const
TimedRegion * next () const
TimedRegion * prev () const
int nregion ()
void get_region_names (const char *names[])
void get_wall_times (double *)
void get_cpu_times (double *)
void get_flops (double *)
void get_depth (int *, int depth=0)

wait, let me give you that list again in the actual order it appears, because I am not about to mess up your reference, periodt:

TimedRegion (const char *name)
const char * name () const
TimedRegion * findinsubregion (const char *)
void cpu_enter (double)
void wall_enter (double)
void flops_enter (double)
void cpu_exit (double)
void wall_exit (double)
void flops_exit (double)
void cpu_add (double t)
void wall_add (double t)
void flops_add (double t)
TimedRegion * up () const
TimedRegion * subregions () const
TimedRegion * next () const
TimedRegion * prev () const
int nregion ()
void get_region_names (const char *names[])
void get_wall_times (double *)
void get_cpu_times (double *)
void get_flops (double *)
void get_depth (int *, int depth=0)

fr fr, that's the vibe check: you got a constructor that wants a const char *name, a name() getter handing back a const char *, a findinsubregion that takes a const char * and gives you a TimedRegion *, a whole trio of cpu_ / wall_ / flops_ enters and exits each taking a double, a matching trio of cpu_add, wall_add, flops_add where the parameter is literally named t, then the navigation girlies up(), subregions(), next(), prev() all returning TimedRegion * and all const, then nregion() giving you an int, get_region_names filling in a const char *names[], get_wall_times, get_cpu_times and get_flops each writing into a double *, and finally get_depth (int *, int depth=0) — note that depth defaults to 0, we love a default argument. 🫶

---

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code. so basically the robot did the homework and we're all just living in its world. 🦋

---

and that's the whole page, bestie — every function accounted for, nothing skipped, nothing invented, just the facts with a lil sparkle on top. 🌈

signing off from MPQC, Version 2.3.1 — sc::TimedRegion(3), Library Functions Manual, mwah 💖🎀