Benchmark.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
 
#ifndef COLUMNAR_TEST_FIXTURES_BENCHMARK_H
#define COLUMNAR_TEST_FIXTURES_BENCHMARK_H
 
#include <optional>
#include <chrono>
#include <cstdint>
#include <iostream>
#include <string>
 
namespace columnar
{
  namespace TestUtils
  {
 
    class Benchmark final
    {
    public:
 
      Benchmark (const std::string& val_name = "", unsigned val_batchSize = 1)
        : m_name (val_name), m_batchSize (val_batchSize)
      {
        if (m_name.empty())
          m_silence = true;
      }
 
      ~Benchmark ()
      {
        if (m_count > 0 && !m_silence)
          std::cout << m_name << ": " << std::chrono::duration<std::uint64_t,std::nano> (m_ticks) / (m_count * m_batchSize) << std::endl;
      }
 
      void setSilence ()
      {
        m_silence = true;
      }
 
      std::optional<float> getEntryTime (float emptyTime) const
      {
        if (m_count == 0)
          return std::nullopt;
        return static_cast<float>((std::chrono::duration<float,std::nano> (m_ticks) / (m_count * m_batchSize)) / std::chrono::duration<float,std::nano> (1))-emptyTime/m_batchSize;
      }
 
      auto getTotalTime () const
      {
        return m_ticks;
      }
 
      static float getTickDuration()
      {
        using period = std::chrono::high_resolution_clock::period;
        return static_cast<float>(period::num) / period::den * 1e9f;
      }
 
      void startTimer ()
      {
        m_start = std::chrono::high_resolution_clock::now();
      }
 
      void stopTimer ()
      {
        m_ticks += std::chrono::high_resolution_clock::now() - m_start;
        m_count += 1;
      }
 
 

    private:
 
      std::string m_name;
 
      std::chrono::time_point<std::chrono::high_resolution_clock> m_start;

      std::chrono::high_resolution_clock::duration m_ticks {};

      std::uint64_t m_count = 0;

      unsigned m_batchSize = 1;

      bool m_silence = false;
    };
  }
}
 
#endif