timers.hpp

Go to the documentation of this file.

 
#ifndef MLPACK_CORE_UTILITIES_TIMERS_HPP
#define MLPACK_CORE_UTILITIES_TIMERS_HPP
 
#include <map>
#include <string>
#include <chrono> // chrono library for cross platform timer calculation.
#include <thread> // std::thread is used for thread safety.
#include <mutex>
#include <list>
#include <atomic>
 
#if defined(_WIN32)
  // uint64_t isn't defined on every windows.
  #if !defined(HAVE_UINT64_T)
    #if SIZEOF_UNSIGNED_LONG == 8
      typedef unsigned long uint64_t;
    #else
      typedef unsigned long long  uint64_t;
    #endif  // SIZEOF_UNSIGNED_LONG
  #endif  // HAVE_UINT64_T
#endif
 
namespace mlpack {
 
class Timer
{
 public:
  static void Start(const std::string& name);
 
  static void Stop(const std::string& name);
 
  static std::chrono::microseconds Get(const std::string& name);
 
  static void EnableTiming();
 
  static void DisableTiming();
 
  static void ResetAll();
};
 
class Timers
{
 public:
  Timers() : enabled(false) { }
 
  std::map<std::string, std::chrono::microseconds> GetAllTimers();
 
  void Reset();
 
  std::chrono::microseconds GetTimer(const std::string& timerName);
 
  void PrintTimer(const std::string& timerName);
 
  void StartTimer(const std::string& timerName,
                  const std::thread::id& threadId = std::thread::id());
 
  void StopTimer(const std::string& timerName,
                 const std::thread::id& threadId = std::thread::id());
 
  bool GetState(const std::string& timerName,
                const std::thread::id& threadId = std::thread::id());
 
  void StopAllTimers();
 
  std::atomic<bool>& Enabled() { return enabled; }
  bool Enabled() const { return enabled; }
 
 private:
  std::map<std::string, std::chrono::microseconds> timers;
  std::mutex timersMutex;
  std::map<std::thread::id, std::map<std::string,
      std::chrono::high_resolution_clock::time_point>> timerStartTime;
 
  std::atomic<bool> enabled;
};
 
} // namespace mlpack
 
#endif // MLPACK_CORE_UTILITIES_TIMERS_HPP