Statistics/Histogram.h

// -*- C++ -*-
//
// Histogram.hpp is a part of myStatistics
// Copyright (C) 2012-2019 Simon Platzer, The Herwig Collaboration
//
// myStatistics is licenced under version 3 of the GPL, see COPYING for details.
//
#ifndef MYSTATISTICS_Histogram_hpp_included
#define MYSTATISTICS_Histogram_hpp_included
 
#include <map>
#include <vector>
#include <string>
#include <iostream>
 
#include "EventContribution.h"
#include "Bin.h"
 
namespace Statistics {
 
  class Histogram {
 
  public:
 
    Histogram();
 
    virtual ~Histogram();
 
    Histogram(const std::string& newName,
              const std::vector<double>& newBoundaries,
              bool newNoUnderflow = false,
              bool newNoOverflow = false);
 
    Histogram(const std::string& newName,
              const std::vector<double>& newBoundaries,
              const std::pair<double,double>& newPeriodicity);
 
    static std::vector<double> regularBinEdges(double lower, double upper, size_t nBins);
 
    static std::vector<double> logBinEdges(double lower, double upper, size_t nBins);
 
  public:
 
    void initialize();
 
    void reset();
 
    void finalize();
 
  public:
 
    bool count(EventContribution event, size_t id);
 
  public:
 
    bool isCompatible(const Histogram& other) const;
 
    Histogram& operator+=(const Histogram& other);
 
    Histogram& operator-=(const Histogram& other);
 
  public:
 
    const std::string& name() const { return theName; }
 
    const Bin& underflow() const { return theUnderflow; }
 
    const std::vector<Bin>& bins() const { return theBins; }
 
    const Bin& overflow() const { return theOverflow; }
 
    bool noUnderflow() const { return theNoUnderflow; }
 
    bool noOverflow() const { return theNoOverflow; }
 
 
    bool isPeriodic() const { return theIsPeriodic; }
 
    const std::pair<double,double>& periodicity() const { return thePeriodicity; }
 
  public:
 
    void fromXML(const XML::Element&);
 
    XML::Element toXML() const;
 
  private:
 
    std::string theName;
 
    Bin theUnderflow;
 
    std::vector<Bin> theBins;
 
    Bin theOverflow;
 
    bool theNoUnderflow;
 
    bool theNoOverflow;
 
    bool theIsPeriodic;
 
    std::pair<double,double> thePeriodicity;
 
    void fillBinMap();
 
    Bin& binByIndex(int);
 
    std::map<double,int> binMap;
 
  };
 
}
 
#endif // MYSTATISTICS_Histogram_hpp_included