mlpack::Timer Class Reference

The timer class provides a way for mlpack methods to be timed. More...

#include <timers.hpp>

Static Public Member Functions
static void	Start (const std::string &name)
	Start the given timer. More...
static void	Stop (const std::string &name)
	Stop the given timer. More...
static std::chrono::microseconds	Get (const std::string &name)
	Get the value of the given timer. More...
static void	EnableTiming ()
	Enable timing of mlpack programs. More...
static void	DisableTiming ()
	Disable timing of mlpack programs. More...
static void	ResetAll ()
	Stop and reset all running timers. More...

Detailed Description

The timer class provides a way for mlpack methods to be timed.

The three methods contained in this class allow a named timer to be started and stopped, and its value to be obtained. A named timer is specific to the thread it is running on, so if you start a timer in one thread, it cannot be stopped from a different thread.

Member Function Documentation

DisableTiming()

void Timer::DisableTiming ( )

static

Disable timing of mlpack programs.

Do not run this while timers are running!

EnableTiming()

void Timer::EnableTiming ( )

static

Enable timing of mlpack programs.

Do not run this while timers are running!

Get()

microseconds Timer::Get ( const std::string &  name )

static

Get the value of the given timer.

Get the given timer, summing over all threads.

Parameters

name	Name of timer to return value of.

ResetAll()

void Timer::ResetAll ( )

static

Stop and reset all running timers.

This removes all knowledge of any existing timers.

Start()

void Timer::Start ( const std::string &  name )

static

Start the given timer.

If a timer is started, then stopped, then re-started, then re-stopped, the final value of the timer is the length of both runs – that is, mlpack timers are additive for each time they are run, and do not reset.

Note

A std::runtime_error exception will be thrown if a timer is started twice.

Parameters

name	Name of timer to be started.

Stop()

void Timer::Stop ( const std::string &  name )

static

Stop the given timer.

Note

A std::runtime_error exception will be thrown if a timer is started twice.

Parameters

name	Name of timer to be stopped.

---

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

• src/mlpack/core/util/timers.hpp
• src/mlpack/core/util/timers.cpp