[mlpack-svn] r15853 - mlpack/trunk/doc/guide

fastlab-svn at coffeetalk-1.cc.gatech.edu fastlab-svn at coffeetalk-1.cc.gatech.edu
Thu Sep 26 16:17:31 EDT 2013


Author: rcurtin
Date: Thu Sep 26 16:17:31 2013
New Revision: 15853

Log:
Add a note about running a timer multiple times.


Modified:
   mlpack/trunk/doc/guide/timer.hpp

Modified: mlpack/trunk/doc/guide/timer.hpp
==============================================================================
--- mlpack/trunk/doc/guide/timer.hpp	(original)
+++ mlpack/trunk/doc/guide/timer.hpp	Thu Sep 26 16:17:31 2013
@@ -27,7 +27,10 @@
 timeval Timer::Get(const char* name);
 @endcode
 
-Each timer is given a name, and is referenced by that name.
+Each timer is given a name, and is referenced by that name.  You can call \c
+Timer::Start() and \c Timer::Stop() multiple times for a particular timer name,
+and the result will be the sum of the runs of the timer.  Note that \c
+Timer::Stop() must be called before \c Timer::Start() is called again.
 
 A "total_time" timer is run by default for each MLPACK program.
 



More information about the mlpack-svn mailing list