ModuleStatistics.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/utilities/CalcMeanCov.h>
#include <string>
#include <ostream>
 
namespace Belle2 {

  class ModuleStatistics {
  public:
    enum EStatisticCounters {
      c_Init,
      c_BeginRun,
      c_Event,
      c_EndRun,
      c_Term,
      c_Total
    };

    typedef double value_type;

    explicit ModuleStatistics(const std::string& name = ""): m_index(0), m_name(name) {}

    void add(EStatisticCounters type, value_type time, value_type memory)
    {
      m_stats[type].add(time, memory);
      if (type != c_Total)
        m_stats[c_Total].add(time, memory);
    }

    void update(const ModuleStatistics& other)
    {
      for (int i = c_Init; i <= c_Total; i++) {
        m_stats[i].add(other.m_stats[i]);
      }
    }

    void setName(const std::string& name) { m_name = name; }
    void setIndex(int index) { m_index = index; }

    const std::string& getName() const { return m_name; }
    int getIndex() const { return m_index; }

    value_type getCalls(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getEntries();
    }

    value_type getTimeSum(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getSum<0>();
    }

    value_type getTimeMean(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getMean<0>();
    }

    value_type getTimeStddev(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getStddev<0>();
    }

    value_type getMemorySum(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getSum<1>();
    }

    value_type getMemoryMean(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getMean<1>();
    }

    value_type getMemoryStddev(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getStddev<1>();
    }

    value_type getTimeMemoryCorrelation(EStatisticCounters type = c_Total) const
    {
      return m_stats[type].getCorrelation<0, 1>();
    }

    void csv_header(std::ostream& output) const;
    void csv(std::ostream& output) const;

    bool operator==(const ModuleStatistics& other) const { return m_name == other.m_name; }
    bool operator!=(const ModuleStatistics& other) const { return !(*this == other); }

    void clear()
    {
      for (auto& stat : m_stats) stat.clear();
    }
  private:
    int m_index;
    std::string m_name;
    CalcMeanCov<2, value_type> m_stats[c_Total + 1];
  };

} //Belle2 namespace