dds-bridge-sys 3.0.0

/*
   DDS, a bridge double dummy solver.

   Copyright (C) 2006-2014 by Bo Haglund /
   2014-2018 by Bo Haglund & Soren Hein.

   See LICENSE and README.
*/

#ifndef DDS_TIMING_H
#define DDS_TIMING_H

#include <string>
#include <chrono>

using Clock = std::chrono::steady_clock;
using std::chrono::time_point;

using namespace std;


/**
 * @brief Timer for profiling bridge double dummy solver operations.
 *
 * The Timer class measures, accumulates, and reports user and system time
 * for profiling and performance analysis of solver operations. It supports
 * starting, stopping, and aggregating timing measurements. Used internally
 * for detailed timing statistics.
 */
class Timer
{
  private:

    string name;
    unsigned int count;
    long userCum;
    long systCum;

    time_point<Clock> user0;
    clock_t syst0;

  public:

    /**
     * @brief Construct a new Timer object.
     *
     * Initializes the timer and prepares for timing measurements.
     */
    Timer();

    /**
     * @brief Destroy the Timer object and clean up resources.
     *
     * Releases any resources and resets timing state.
     */
    ~Timer();

    void Reset();

    void SetName(const string& nameIn);

    void Start();

    void End();

    bool Used() const;

    int UserTime() const;

    void operator += (const Timer& add);

    void operator -= (const Timer& deduct);

    string SumLine(
      const Timer& divisor,
      const string& bname = "") const;

    string DetailLine() const;
};

#endif