A class representing a stopwatch. More...
#include <crocoddyl/core/utils/stop-watch.hpp>
Classes | |
struct | PerformanceData |
Struct to hold the performance data. More... | |
Public Member Functions | |
Stopwatch (StopwatchMode _mode=NONE) | |
Constructor. | |
~Stopwatch () | |
Destructor. | |
void | disable_profiler () |
Disable the profiler. | |
void | enable_profiler () |
Enable the profiler. | |
long double | get_average_time (const std::string &perf_name) |
Returns average execution time of a certain performance. | |
long double | get_last_time (const std::string &perf_name) |
Return last measurement of a certain performance. | |
long double | get_max_time (const std::string &perf_name) |
Returns maximum execution time of a certain performance. | |
long double | get_min_time (const std::string &perf_name) |
Returns minimum execution time of a certain performance. | |
long double | get_time_so_far (const std::string &perf_name) |
Return the time since the start of the last measurement of a given performance. | |
long double | get_total_time (const std::string &perf_name) |
Returns total execution time of a certain performance. | |
void | pause (const std::string &perf_name) |
Stops the stopwatch related to a certain piece of code. | |
bool | performance_exists (std::string perf_name) |
Tells if a performance with a certain ID exists. | |
bool | profiler_status () |
Return if the profiler is enable or disable. | |
void | report (const std::string &perf_name, int precision=2, std::ostream &output=std::cout) |
Dump the data of a certain performance record. | |
void | report_all (int precision=2, std::ostream &output=std::cout) |
Dump the data of all the performance records. | |
void | reset (const std::string &perf_name) |
Reset a certain performance record. | |
void | reset_all () |
Resets all the performance records. | |
void | set_mode (StopwatchMode mode) |
Initialize stopwatch to use a certain time taking mode. | |
void | start (const std::string &perf_name) |
Start the stopwatch related to a certain piece of code. | |
void | stop (const std::string &perf_name) |
Stops the stopwatch related to a certain piece of code. | |
long double | take_time () |
Take time, depends on mode. | |
void | turn_off () |
Turn off clock, all the Stopwatch::* methods return without doing anything after this method is called. | |
void | turn_on () |
Turn on clock, restore clock operativity after a turn_off(). | |
Protected Attributes | |
bool | active |
Flag to hold the clock's status. | |
StopwatchMode | mode |
Time taking mode. | |
bool | profiler_active |
Indicates if the profiler is enabled. | |
std::map< std::string, PerformanceData > * | records_of |
Dynamic collection of performance data. | |
A class representing a stopwatch.
The Stopwatch class can be used to measure execution time of code, algorithms, etc., // TODO: he Stopwatch can be initialized in two time-taking modes, CPU time and real time:
CPU time is the time spent by the processor on a certain piece of code, while real time is the real amount of time taken by a certain piece of code to execute (i.e. in general if you are doing hard work such as image or video editing on a different process the measured time will probably increase).
How does it work? Basically, one wraps the code to be measured with the following method calls:
A string representing the code ID is provided so that nested portions of code can be profiled separately:
Note: ID strings can be whatever you like, in the previous example I have used "My astounding algorithm - *" only to enforce the fact that the measured code portions are part of My astounding algorithm, but there's no connection between the three measurements.
If the code for a certain task is scattered through different files or portions of the same file one can use the start-pause-stop method:
Finally, to report the results of the measurements just run:
Thou can also provide an additional std::ostream& parameter to report() to redirect the logging on a different output. Also, you can use the get_total/min/max/average_time() methods to get the individual numeric data, without all the details of the logging. You can also extend Stopwatch to implement your own logging syntax.
To report all the measurements:
Same as above, you can redirect the output by providing a std::ostream& parameter.
Definition at line 150 of file stop-watch.hpp.