Statistics.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include <string>
#include <map>
#include <vector>
#include <tuple>
 
#include "Log.h"
#include "tarch/timing/Watch.h"
#include "tarch/multicore/BooleanSemaphore.h"
 
namespace tarch {
  namespace logging {
    class Statistics;
  }
}
 
class tarch::logging::Statistics {
  public:
    static Statistics& getInstance();
 
    #ifdef TrackStatistics
      void log( const std::string& identifier, double value, bool disableSampling = false );
 
      void log( const std::string& identifier, const std::string& value );
 
      void inc( const std::string& identifier, double value = 1.0, bool disableSampling = false, bool clearAfterDatabaseDump = false );
    #else
      inline void log( [[maybe_unused]] const std::string& identifier, [[maybe_unused]] double value, [[maybe_unused]] bool disableSampling = false ) {}
      inline void log( [[maybe_unused]] const std::string& identifier, [[maybe_unused]] const std::string& value ) {}
      inline void inc( [[maybe_unused]] const std::string& identifier, [[maybe_unused]] double value = 1.0, [[maybe_unused]] bool disableSampling = false, [[maybe_unused]] bool clearAfterDatabaseDump = false ) {}
    #endif
 
    void writeToCSV( std::string  filename = "statistics" );
 
    void clear();
 
  private:
    static Statistics   _singleton;
 
    static Log          _log;
 
    static tarch::multicore::BooleanSemaphore  _semaphore;
 
    int                   _maxCountInBetweenTwoMeasurements;
    double                _maxTimeInBetweenTwoMeasurements;
 
    tarch::timing::Watch  _globalWatch;
 
    struct DataSet {
      tarch::timing::Watch  _watch;
      int                   _counter;
      std::vector< std::tuple<double,double,double,double,int> >   _data;
      DataSet();
      DataSet(double time);
      void createNewSnapshot(double t, bool clearAfterDatabaseDump);
 
      std::string toString() const;
    };
 
    struct LogMessage {
      std::vector< std::tuple<double,std::string> >   _data;
      LogMessage() = default;
    };
 
    std::map< std::string, DataSet >     _dataSetMap;
    std::map< std::string, LogMessage >  _logMessageMap;
 
    Statistics();
 
    bool acceptNewData(const std::string& identifier, bool disableSampling);
 
    void initData(const std::string& identifier);
 
    void updateDataSnapshot(const std::string& identifier, double value);
};