CVD 0.8
Public Member Functions
CVD::SimpleTimer Class Reference

Provides a simple timer class which uses cvd_timer internally. More...

#include <timer.h>

List of all members.

Public Member Functions

 SimpleTimer (const std::string &description, const int &cycles_to_time=1, bool output=true, std::ostream &out=std::cout)
 ~SimpleTimer ()
void click ()
void print ()
double get_max ()
double get_min ()
double get_average ()

Detailed Description

Provides a simple timer class which uses cvd_timer internally.

Statistics (average, max and min cycle time) are kept and output for a number of timing cycles. Cycle times are stored in a std::deque<double> and statistics only calculated when the get or print functions are called.

Definition at line 103 of file timer.h.

Constructor & Destructor Documentation

CVD::SimpleTimer::SimpleTimer ( const std::string &  description,
const int &  cycles_to_time = 1,
bool  output = true,
std::ostream &  out = std::cout 
) [inline]

Create a simple timer object.

descriptionA string description of what is being timed (used in output)
cycles_to_timeHow many cycles to time before the times are averaged and output (default 1).
outputWhether or not to output timing information. Default is true.
outstd::ostream to send output information to. Default std::cout.

Definition at line 111 of file timer.h.

Member Function Documentation

void CVD::SimpleTimer::print ( ) [inline]

Output timing information (average, maximum and minimum times for a set of cycles).

Automatically called after cycles_to_time cycles but can be called manually.

Definition at line 146 of file timer.h.

References get_average(), get_max(), and get_min().

Referenced by click().

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