gum::Timer Class Reference

Class used to compute response times for benchmark purposesThis class represents a classic timer, it starts in the constructor, you can reset it with method reset() and you can get the delta time with the method step(). More...

#include <agrum/tools/core/timer.h>

Collaboration diagram for gum::Timer:

Public Member Functions
Constructors / Destructors
	Timer ()
	Default constructor (launching the timer). More...
	Timer (const Timer &timer)
	Copy constructor. More...
	~Timer ()
	Destructor. More...
Operators
Timer &	operator= (const Timer &timer)
	Copy operator. More...
Timer manipulation
void	reset ()
	Reset the timer. More...
double	pause ()
	Pause the timer and return the delta (. More...
double	resume ()
	Resume the timer and return the delta (. More...
double	step () const
	Returns the delta time between now and the last reset() call (or the constructor). More...

Protected Attributes
std::chrono::high_resolution_clock::time_point	start_
	Time of the last call to reset() or the constructor. More...
std::chrono::high_resolution_clock::time_point	pause_
	Time of the last call to pause(). More...
bool	sleeping_
	False if running. More...

Detailed Description

Class used to compute response times for benchmark purposes

This class represents a classic timer, it starts in the constructor, you can reset it with method reset() and you can get the delta time with the method step().

This class uses double for representing time data, all the values are in seconds, and the precision is about 0.001 s

Definition at line 50 of file timer.h.

Constructor & Destructor Documentation

Timer() [1/2]

gum::Timer::Timer

(

)

Default constructor (launching the timer).

Definition at line 37 of file timer.cpp.

References gum::Set< Key, Alloc >::emplace().

               {
    GUM_CONSTRUCTOR(Timer);
    reset();
  }

Here is the call graph for this function:

Timer() [2/2]

gum::Timer::Timer

(

const Timer &

timer

)

Copy constructor.

Parameters

timer

The gum::Timer to copy.

Definition at line 42 of file timer.cpp.

References gum::Set< Key, Alloc >::emplace().

                                :
      start_(from.start_), pause_(from.pause_), sleeping_(from.sleeping_) {
    GUM_CONS_CPY(Timer);
  }

Here is the call graph for this function:

~Timer()

gum::Timer::~Timer

(

)

Destructor.

Definition at line 47 of file timer.cpp.

References gum::Set< Key, Alloc >::emplace().

                {
    GUM_DESTRUCTOR(Timer);
    ;
  }

Here is the call graph for this function:

Member Function Documentation

operator=()

Timer & gum::Timer::operator=

(

const Timer &

timer

)

Copy operator.

Parameters

timer

The gum::Timer to copy.

Definition at line 52 of file timer.cpp.

References gum::Set< Key, Alloc >::emplace().

                                           {
    GUM_OP_CPY(Timer);
    start_    = from.start_;
    pause_    = from.pause_;
    sleeping_ = from.sleeping_;
    return *this;
  }

Here is the call graph for this function:

pause()

INLINE double gum::Timer::pause

(

)

Pause the timer and return the delta (.

See also

gum::Timer::step() ). Returns the delta (

gum::Timer::step() ).

Definition at line 52 of file timer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                      {
    if (!sleeping_) {
      pause_    = std::chrono::high_resolution_clock::now();
      sleeping_ = true;
    }

    return step();
  }

Here is the call graph for this function:

reset()

INLINE void gum::Timer::reset

(

)

Reset the timer.

Definition at line 31 of file timer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                    {
    sleeping_ = false;
    start_    = std::chrono::high_resolution_clock::now();
    pause_    = std::chrono::high_resolution_clock::now();

    // do start_ = clock(); while ( start_ == k );// to be sure to start at the
    // beginning of a tick
  }

Here is the call graph for this function:

resume()

INLINE double gum::Timer::resume

(

)

Resume the timer and return the delta (.

See also

gum::Timer::step() ). Returns the delta (

gum::Timer::step() ).

Definition at line 62 of file timer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                       {
    if (sleeping_) {
      start_ += std::chrono::high_resolution_clock::now() - pause_;
      sleeping_ = false;
    }

    return step();
  }

Here is the call graph for this function:

step()

INLINE double gum::Timer::step

(

)

const

Returns the delta time between now and the last reset() call (or the constructor).

Returns

Returns the delta time in seconds (accuracy : 0.001 ms).

Definition at line 41 of file timer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                           {
    std::chrono::duration< double, std::milli > ms;
    ;
    if (sleeping_)
      ms = pause_ - start_;
    else
      ms = std::chrono::high_resolution_clock::now() - start_;
    return ms.count() / 1000.0;
  }

Here is the call graph for this function:

Member Data Documentation

pause_

std::chrono::high_resolution_clock::time_point gum::Timer::pause_

protected

Time of the last call to pause().

Definition at line 121 of file timer.h.

sleeping_

bool gum::Timer::sleeping_

protected

False if running.

Definition at line 124 of file timer.h.

start_

std::chrono::high_resolution_clock::time_point gum::Timer::start_

protected

Time of the last call to reset() or the constructor.

Definition at line 118 of file timer.h.

---

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

• agrum/tools/core/timer.h
• agrum/tools/core/timer.cpp
• agrum/tools/core/timer_inl.h