.TH "mlpack::Timers" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::Timers \- 
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBTimers\fP ()"
.br
.RI "\fINothing to do for the constructor\&. \fP"
.ti -1c
.RI "std::map< std::string, timeval > & \fBGetAllTimers\fP ()"
.br
.RI "\fIReturns a copy of all the timers used via this interface\&. \fP"
.ti -1c
.RI "timeval \fBGetTimer\fP (const std::string &timerName)"
.br
.RI "\fIReturns a copy of the timer specified\&. \fP"
.ti -1c
.RI "void \fBPrintTimer\fP (const std::string &timerName)"
.br
.RI "\fIPrints the specified timer\&. \fP"
.ti -1c
.RI "void \fBStartTimer\fP (const std::string &timerName)"
.br
.RI "\fI * Initializes a timer, available like a normal value specified on  * the command line\&. \fP"
.ti -1c
.RI "void \fBStopTimer\fP (const std::string &timerName)"
.br
.RI "\fI * Halts the timer, and replaces it's value with  * the delta time from it's start   *   *\&. \fP"
.in -1c
.SS "Private Member Functions"

.in +1c
.ti -1c
.RI "void \fBFileTimeToTimeVal\fP (timeval *tv)"
.br
.ti -1c
.RI "void \fBGetTime\fP (timeval *tv)"
.br
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "std::map< std::string, timeval > \fBtimers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Definition at line 105 of file timers\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "mlpack::Timers::Timers ()\fC [inline]\fP"

.PP
Nothing to do for the constructor\&. 
.PP
Definition at line 109 of file timers\&.hpp\&.
.SH "Member Function Documentation"
.PP 
.SS "void mlpack::Timers::FileTimeToTimeVal (timeval *tv)\fC [private]\fP"

.SS "std::map<std::string, timeval>& mlpack::Timers::GetAllTimers ()"

.PP
Returns a copy of all the timers used via this interface\&. 
.SS "void mlpack::Timers::GetTime (timeval *tv)\fC [private]\fP"

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

.PP
Returns a copy of the timer specified\&. 
.PP
\fBParameters:\fP
.RS 4
\fItimerName\fP The name of the timer in question\&. 
.RE
.PP

.SS "void mlpack::Timers::PrintTimer (const std::string &timerName)"

.PP
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\&.
.PP
\fBParameters:\fP
.RS 4
\fItimerName\fP The name of the timer in question\&. 
.RE
.PP

.SS "void mlpack::Timers::StartTimer (const std::string &timerName)"

.PP
 * Initializes a timer, available like a normal value specified on  * the command line\&.   \fBTimers\fP 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\&.  *  * 
.PP
\fBParameters:\fP
.RS 4
\fItimerName\fP The name of the timer in question\&.   
.RE
.PP

.SS "void mlpack::Timers::StopTimer (const std::string &timerName)"

.PP
 * Halts the timer, and replaces it's value with  * the delta time from it's start   *   *\&. 
.PP
\fBParameters:\fP
.RS 4
\fItimerName\fP The name of the timer in question\&.   
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "std::map<std::string, timeval> mlpack::Timers::timers\fC [private]\fP"

.PP
Definition at line 150 of file timers\&.hpp\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.