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

Constructor & Destructor Documentation

Timer() [1/2]

gum::Timer::Timer

(

)

Default constructor (launching the timer).

Definition at line 38 of file timer.cpp.

References reset().

               {
    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 43 of file timer.cpp.

                                :
      _start(from._start), _pause(from._pause), _sleeping(from._sleeping) {
    GUM_CONS_CPY(Timer);
  }

~Timer()

gum::Timer::~Timer

(

)

Destructor.

Definition at line 48 of file timer.cpp.

{ GUM_DESTRUCTOR(Timer); }

Member Function Documentation

operator=()

Timer & gum::Timer::operator=

(

const Timer &

timer

)

Copy operator.

Parameters

timer

The gum::Timer to copy.

Definition at line 50 of file timer.cpp.

References _pause, _sleeping, and _start.

                                           {
    GUM_OP_CPY(Timer);
    _start = from._start;
    _pause = from._pause;
    _sleeping = from._sleeping;
    return *this;
  }

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 53 of file timer_inl.h.

References _pause, _sleeping, and step().

Referenced by gum::ApproximationScheme::_stopScheme().

                      {
    if (!_sleeping) {
      _pause = std::chrono::high_resolution_clock::now();
      _sleeping = true;
    }

    return step();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

INLINE void gum::Timer::reset

(

)

Reset the timer.

Definition at line 32 of file timer_inl.h.

References _pause, _sleeping, and _start.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__buildReduceGraph(), gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::learning::BNDatabaseGenerator< GUM_SCALAR >::drawSamples(), gum::ApproximationScheme::initApproximationScheme(), gum::learning::Miic::learnMixedStructure(), gum::prm::o3prmr::O3prmrInterpreter::query(), and Timer().

                    {
    _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 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 (

gum::Timer::step() ).

Definition at line 63 of file timer_inl.h.

References _pause, _sleeping, _start, and step().

                       {
    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 42 of file timer_inl.h.

References _pause, _sleeping, and _start.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::__buildReduceGraph(), gum::prm::StructuredInference< GUM_SCALAR >::__reducePattern(), gum::learning::Miic::_initiation(), gum::learning::Miic::_iteration(), gum::prm::StructuredInference< GUM_SCALAR >::_marginal(), gum::learning::Miic::_orientation_3off2(), gum::learning::Miic::_orientation_latents(), gum::learning::Miic::_orientation_miic(), gum::ApproximationScheme::continueApproximationScheme(), gum::ApproximationScheme::currentTime(), gum::learning::BNDatabaseGenerator< GUM_SCALAR >::drawSamples(), pause(), gum::prm::o3prmr::O3prmrInterpreter::query(), and resume().

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

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

_sleeping

bool gum::Timer::_sleeping

protected

False if running.

Definition at line 125 of file timer.h.

Referenced by 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 119 of file timer.h.

Referenced by operator=(), reset(), resume(), and step().

---

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

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