TimeKeeper.h

Go to the documentation of this file.

/*
 *  CepGen: a central exclusive processes event generator
 *  Copyright (C) 2020-2024  Laurent Forthomme
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef CepGen_Utils_TimeKeeper_h
#define CepGen_Utils_TimeKeeper_h
 
#include <string>
#include <unordered_map>
#include <vector>
 
#include "CepGen/Utils/Timer.h"
 
#define CG_CONCAT(a, b) a##b
#define CG_TICKER_NAME(a, b) CG_CONCAT(a, b)
#define CG_TICKER(tmr) utils::TimeKeeper::Ticker CG_TICKER_NAME(ticker, __COUNTER__)(tmr, __PRETTY_FUNCTION__)
 
namespace cepgen {
  namespace utils {
    class TimeKeeper {
    public:
      explicit TimeKeeper() = default;
 
      void clear();                                     
      bool empty() const { return monitors_.empty(); }  
      std::string summary() const;                      
 
      TimeKeeper& tick(const std::string& func, double time = -1.);
 
      const Timer& timer() const;  
 
      class Ticker {
      public:
        explicit Ticker(TimeKeeper*, const std::string&);  
        ~Ticker();  
 
      private:
        TimeKeeper* tk_{nullptr};
        std::string name_;
        Timer tmr_;
      };
 
    private:
      std::unordered_map<std::string, std::vector<float> > monitors_;
      Timer tmr_;
    };
  }  // namespace utils
}  // namespace cepgen
 
#endif