MLPACK  1.0.4
Public Member Functions | Private Member Functions | Private Attributes
mlpack::Timers Class Reference

List of all members.

Public Member Functions

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

Private Member Functions

void FileTimeToTimeVal (timeval *tv)

Private Attributes

std::map< std::string, timeval > timers

Detailed Description

Definition at line 80 of file timers.hpp.


Constructor & Destructor Documentation

mlpack::Timers::Timers ( ) [inline]

Nothing to do for the constructor.

Definition at line 84 of file timers.hpp.


Member Function Documentation

void mlpack::Timers::FileTimeToTimeVal ( timeval *  tv) [private]
std::map<std::string, timeval>& mlpack::Timers::GetAllTimers ( )

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

timeval mlpack::Timers::GetTimer ( const std::string &  timerName)

Returns a copy of the timer specified.

Parameters:
timerNameThe name of the timer in question.
void mlpack::Timers::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 mlpack::Timers::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 mlpack::Timers::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.  

Member Data Documentation

std::map<std::string, timeval> mlpack::Timers::timers [private]

Definition at line 125 of file timers.hpp.


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