This is a simple thread-safe tool for counting time spent in various chunks of code. This is different from external profiling tools in that it allows the user to count time spent in various bits of code (sub-function granularity) or count how many times certain pieces of code are executed.
More...
Classes |
| struct | AvgInfo |
| | Information maintained about averaged values. More...
|
| struct | PerThread |
| | Information to be maintained for each thread. More...
|
| class | ScopedBlock |
| | This instance will call Profiler::begin() when constructed and Profiler::end() when it goes out of scope. More...
|
| class | ScopedStart |
| | This instance will call Profiler::start() when constructed and Profiler::stop() when it goes out of scope. If the profiler was already started, this block's constructor and destructor take no action. More...
|
| struct | TimeInfo |
| | Information about time spent in a section of the code. More...
|
Public Member Functions |
| void | average (const std::string &name, const double value) |
| | Maintain the average of a specific value.
|
| void | begin (const std::string &name) |
| | Begin counting time for a specific chunk of code.
|
| void | clear (void) |
| | Clear counted time and events.
|
| void | end (const std::string &name) |
| | Stop counting time for a specific chunk of code.
|
| void | event (const std::string &name, const unsigned int times=1) |
| | Count a specific event for a number of times.
|
| | Profiler (bool printOnDestroy=false, bool autoStart=false) |
| | Constructor. It is allowed to separately instantiate this class (not only as a singleton)
|
| bool | running (void) const |
| | Check if the profiler is counting time or not.
|
| void | start (void) |
| | Start counting time.
|
| void | status (std::ostream &out=std::cout, bool merge=true) |
| | Print the status of the profiled code chunks and events. Optionally, computation done by different threads can be printed separately.
|
| void | stop (void) |
| | Stop counting time.
|
| | ~Profiler (void) |
| | Destructor.
|
Static Public Member Functions |
| static void | Average (const std::string &name, const double value) |
| | Maintain the average of a specific value.
|
| static void | Begin (const std::string &name) |
| | Begin counting time for a specific chunk of code.
|
| static void | Clear (void) |
| | Clear counted time and events.
|
| static void | End (const std::string &name) |
| | Stop counting time for a specific chunk of code.
|
| static void | Event (const std::string &name, const unsigned int times=1) |
| | Count a specific event for a number of times.
|
| static Profiler & | Instance (void) |
| | Return an instance of the class.
|
| static bool | Running (void) |
| | Check if the profiler is counting time or not.
|
| static void | Start (void) |
| | Start counting time.
|
| static void | Status (std::ostream &out=std::cout, bool merge=true) |
| | Print the status of the profiled code chunks and events. Optionally, computation done by different threads can be printed separately.
|
| static void | Stop (void) |
| | Stop counting time.
|
Private Member Functions |
| void | printThreadInfo (std::ostream &out, const PerThread &data) |
Private Attributes |
std::map< boost::thread::id,
PerThread > | data_ |
| boost::mutex | lock_ |
| bool | printOnDestroy_ |
| bool | running_ |
| TimeInfo | tinfo_ |
This is a simple thread-safe tool for counting time spent in various chunks of code. This is different from external profiling tools in that it allows the user to count time spent in various bits of code (sub-function granularity) or count how many times certain pieces of code are executed.
Definition at line 107 of file profile.h.
