gum::Timer Class Reference

Class used to compute response times for benchmark purposes. More...

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

Collaboration diagram for gum::Timer:

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

Protected Member Functions
std::chrono::duration< double, std::milli >	step_ () const

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

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 69 of file timer.h.

Constructor & Destructor Documentation

Timer() [1/2]

gum::Timer::Timer

(

)

Default constructor (launching the timer).

Definition at line 61 of file timer.cpp.

               {
    GUM_CONSTRUCTOR(Timer);
    reset();
  }

References Timer(), and reset().

Referenced by Timer(), Timer(), ~Timer(), and operator=().

Here is the call graph for this function:

Here is the caller 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 66 of file timer.cpp.

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

References Timer(), pause_, sleeping_, and start_.

Here is the call graph for this function:

~Timer()

gum::Timer::~Timer

(

)

Destructor.

Definition at line 71 of file timer.cpp.

                {
    GUM_DESTRUCTOR(Timer);
    ;
  }

References 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 76 of file timer.cpp.

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

References Timer(), pause_, sleeping_, and start_.

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 (

See also

gum::Timer::step() ).

Definition at line 74 of file timer_inl.h.

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

References pause_, sleeping_, and step().

Here is the call graph for this function:

reset()

INLINE void gum::Timer::reset

(

)

Reset the timer.

Definition at line 52 of file timer_inl.h.

                    {
    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
  }

References pause_, sleeping_, and start_.

Referenced by Timer(), gum::learning::BNDatabaseGenerator< GUM_SCALAR >::drawSamples(), and gum::prm::o3prmr::O3prmrInterpreter::query().

Here is the caller 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 (

See also

gum::Timer::step() ).

Definition at line 84 of file timer_inl.h.

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

References pause_, sleeping_, start_, and 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 71 of file timer_inl.h.

{ return step_().count() / 1000.0; }

References step_().

Referenced by gum::learning::BNDatabaseGenerator< GUM_SCALAR >::drawSamples(), pause(), gum::prm::o3prmr::O3prmrInterpreter::query(), resume(), and toString().

Here is the call graph for this function:

Here is the caller graph for this function:

step_()

INLINE std::chrono::duration< double, std::milli > gum::Timer::step_ ( ) const

protected

Definition at line 62 of file timer_inl.h.

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

References pause_, sleeping_, and start_.

Referenced by step().

Here is the caller graph for this function:

toString()

std::string gum::Timer::toString

(

)

const

Returns the delta time between now and the last reset() in a human format.

Returns

a string representing the delta time

Definition at line 84 of file timer.cpp.

                                  {
    auto d     = step();
    auto sec   = fmod(d, 60);
    d          = (d - sec) / 60;
    auto minut = fmod(d, 60);
    d          = (d - minut) / 60;
 
    std::stringstream s;
    s << std::setfill('0') << std::setw(2) << int(d) << ":";
    s << std::setfill('0') << std::setw(2) << int(minut) << ":";
    s << ((sec < 10) ? "0" : "") << sec;
 
    return s.str();
  }

References step().

Referenced by gum::operator<<().

Here is the call graph for this function:

Here is the caller 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 149 of file timer.h.

Referenced by Timer(), operator=(), pause(), reset(), resume(), and step_().

sleeping_

bool gum::Timer::sleeping_

protected

False if running.

Definition at line 152 of file timer.h.

Referenced by Timer(), operator=(), pause(), reset(), resume(), and step_().

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 146 of file timer.h.

Referenced by Timer(), operator=(), reset(), resume(), and step_().

---

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

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