mlpack  2.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Timers Class Reference

Public Member Functions

 Timers ()
 Nothing to do for the constructor. More...
 
std::map< std::string,
std::chrono::microseconds > & 
GetAllTimers ()
 Returns a copy of all the timers used via this interface. More...
 
bool GetState (std::string timerName)
 Returns state of the given timer. More...
 
std::chrono::microseconds GetTimer (const std::string &timerName)
 Returns a copy of the timer specified. More...
 
void PrintTimer (const std::string &timerName)
 Prints the specified timer. More...
 
void StartTimer (const std::string &timerName)
  * Initializes a timer, available like a normal value specified on  * the command line. More...
 
void StopTimer (const std::string &timerName)
  * Halts the timer, and replaces it's value with  * the delta time from it's start   *   *. More...
 

Detailed Description

Definition at line 72 of file timers.hpp.

Constructor & Destructor Documentation

Timers ( )
inline

Nothing to do for the constructor.

Definition at line 76 of file timers.hpp.

Member Function Documentation

std::map<std::string, std::chrono::microseconds>& GetAllTimers ( )

Returns a copy of all the timers used via this interface.

bool GetState ( std::string  timerName)

Returns state of the given timer.

Parameters
timerNameThe name of the timer in question.
std::chrono::microseconds GetTimer ( const std::string &  timerName)

Returns a copy of the timer specified.

Parameters
timerNameThe name of the timer in question.
void PrintTimer ( const std::string &  timerName)

Prints the specified timer.

If it took longer than a minute to complete the timer will be displayed in days, hours, and minutes as well.

Parameters
timerNameThe name of the timer in question.
void StartTimer ( const std::string &  timerName)

 * Initializes a timer, available like a normal value specified on  * the command line.

  Timers are of type timeval. If a timer is started, then stopped, then re-started, then stopped, the final timer value will be the length of both runs of the timer.  *  *

Parameters
timerNameThe name of the timer in question.  
void StopTimer ( const std::string &  timerName)

 * Halts the timer, and replaces it's value with  * the delta time from it's start   *   *.

Parameters
timerNameThe name of the timer in question.  

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