iRoCS Toolbox  1.1.0
Public Member Functions
atb::Profiler Class Reference

The Profiler class provides a simple stop-watch in microsecond accuracy for simple profiling tasks (similar to tic - toc in MATLAB). More...

#include <ATBTiming.hh>

Collaboration diagram for atb::Profiler:

Public Member Functions

 Profiler ()
 Constructor - creating a new Profiler. More...
 
 ~Profiler ()
 Destructor - Cleaning up Profiler ressources. More...
 
void tic ()
 Start the profiler. More...
 
long long toc ()
 Stop the profiler. More...
 

Detailed Description

The Profiler class provides a simple stop-watch in microsecond accuracy for simple profiling tasks (similar to tic - toc in MATLAB).

It produces no output, so it can be used for averaging over many fast operations.

To use the stop-watch create a Profiler object. Call tic(), to start the watch and toc() to stop it. There will be no output.

Definition at line 176 of file ATBTiming.hh.

Constructor & Destructor Documentation

◆ Profiler()

atb::Profiler::Profiler ( )

Constructor - creating a new Profiler.

◆ ~Profiler()

atb::Profiler::~Profiler ( )

Destructor - Cleaning up Profiler ressources.

Member Function Documentation

◆ tic()

void atb::Profiler::tic ( )

Start the profiler.

◆ toc()

long long atb::Profiler::toc ( )

Stop the profiler.

return The time in microseconds since the last tic() call


The documentation for this class was generated from the following file: