timer.h

#pragma once

#include <chrono>
#include <iostream>
#include <type_traits>

namespace dreal {

/// Simple timer class to profile performance.
class Timer {
 public:
  // Use high_resolution clock if it's steady. Otherwise use steady_clock.
  using clock = std::conditional<std::chrono::high_resolution_clock::is_steady,
                                 std::chrono::high_resolution_clock,
                                 std::chrono::steady_clock>::type;
  Timer();

  /// Starts the timer.
  void start();

  /// Pauses the timer.
  void pause();

  /// Resumes the timer.
  void resume();

  /// Checks if the timer is running.
  bool is_running() const;

  /// Returns the elapsed time as duration.
  clock::duration elapsed() const;

  /// Returns the elapsed time in secionds.
  std::chrono::duration<double>::rep seconds() const;

 private:
  // Whether the timer is running or not.
  bool running_{false};

  // Last time_point when the timer is started or resumed.
  clock::time_point last_start_{};

  // Elapsed time so far. This doesn't include the current fragment if
  // it is running.
  clock::duration elapsed_{};
};

std::ostream& operator<<(std::ostream& os, const Timer& timer);

/// Pauses the passed timer object when the guard object is destructed
/// (e.g. going out of scope).
class TimerGuard {
 public:
  /// Constructs the timer guard object with @p timer.
  ///
  /// If @p enabled is false, this class does not do anything.
  /// If @p start_timer is true, starts the @p timer in the
  /// constructor. Otherwise, it does not start it and a user has to
  /// call `resume()` to start it.
  TimerGuard(Timer* timer, bool enabled, bool start_timer = true);

  TimerGuard(const TimerGuard&) = delete;
  TimerGuard(TimerGuard&&) = delete;
  TimerGuard& operator=(const TimerGuard&) = delete;
  TimerGuard& operator=(TimerGuard&&) = delete;


  /// Destructs the timer guard object. It pauses the embedded timer object.
  ~TimerGuard();

  /// Pauses the embedded timer object.
  void pause();

  /// Resumes the embedded timer object.
  void resume();

 private:
  Timer* const timer_;
  const bool enabled_{false};
};

}  // namespace dreal