timings.h

Go to the documentation of this file.

//
// Copyright (c) 2021-2025 INRIA
//
 
#ifndef COAL_TIMINGS_FWD_H
#define COAL_TIMINGS_FWD_H
 
#include "coal/fwd.hh"
 
#include <chrono>
 
namespace coal {
 
struct CPUTimes {
  double wall;
  double user;
  double system;
 
  CPUTimes() : wall(0), user(0), system(0) {}
 
  void clear() { wall = user = system = 0; }
};
 
struct COAL_DLLAPI Timer {
  typedef std::chrono::steady_clock clock_type;
  typedef clock_type::duration duration_type;
 
  Timer(const bool start_on_construction = true) : m_is_stopped(true) {
    if (start_on_construction) Timer::start();
  }
 
  CPUTimes elapsed() const {
    if (m_is_stopped) return m_times;
 
    CPUTimes current(m_times);
    std::chrono::time_point<std::chrono::steady_clock> current_clock =
        std::chrono::steady_clock::now();
    current.user += static_cast<double>(
                        std::chrono::duration_cast<std::chrono::nanoseconds>(
                            current_clock - m_start)
                            .count()) *
                    1e-3;
    return current;
  }
 
  duration_type duration() const { return (m_end - m_start); }
 
  void start() {
    if (m_is_stopped) {
      m_is_stopped = false;
      m_times.clear();
 
      m_start = std::chrono::steady_clock::now();
    }
  }
 
  void stop() {
    if (m_is_stopped) return;
    m_is_stopped = true;
 
    m_end = std::chrono::steady_clock::now();
    m_times.user += static_cast<double>(
                        std::chrono::duration_cast<std::chrono::nanoseconds>(
                            m_end - m_start)
                            .count()) *
                    1e-3;
  }
 
  void resume() {
    if (m_is_stopped) {
      m_start = std::chrono::steady_clock::now();
      m_is_stopped = false;
    }
  }
 
  bool is_stopped() const { return m_is_stopped; }
 
 protected:
  CPUTimes m_times;
  bool m_is_stopped;
 
  std::chrono::time_point<std::chrono::steady_clock> m_start, m_end;
};
 
}  // namespace coal
 
#endif  // ifndef COAL_TIMINGS_FWD_H