Cutflow.hh

#ifndef RIVET_Cutflow_HH
#define RIVET_Cutflow_HH

#include "Rivet/Tools/Utils.hh"

namespace Rivet {


  struct Cutflow {

    Cutflow() {}

    Cutflow(const string& cfname, const vector<string>& cutnames)
      : name(cfname), ncuts(cutnames.size()), cuts(cutnames), counts(ncuts+1, 0)
    {  }

    void fillinit(double weight=1.) {
      counts.front() += weight;
    }

    bool fill(size_t icut, bool cutresult=true, double weight=1.) {
      if (cutresult) counts.at(icut) += weight;
      return cutresult;
    }

    bool fill(size_t icut, double weight) {
      return fill(icut, true, weight);
    }

    bool fill(const vector<bool>& cutresults, double weight=1.) {
      if (cutresults.size() != ncuts)
        throw RangeError("Number of filled cut results needs to match the Cutflow construction");
      counts.front() += 1;
      for (size_t i = 0; i < ncuts; ++i) {
        if (cutresults[i]) counts.at(i+1) += weight; else break;
      }
      return all(cutresults);
    }



    bool filltail(const vector<bool>& cutresults, double weight=1.) {
      if (cutresults.size() > ncuts)
        throw RangeError("Number of filled cut results needs to match the Cutflow construction");
      const size_t offset = counts.size() - cutresults.size();
      for (size_t i = 0; i < cutresults.size(); ++i) {
        if (cutresults[i]) counts.at(offset+i) += weight; else break;
      }
      return all(cutresults);
    }

    void scale(double factor) {
      for (double& x : counts) x *= factor;
    }

    void normalize(double norm, size_t icut=0) {
      scale(norm/counts.at(icut));
    }

    string str() const {
      stringstream ss;
      ss << fixed << setprecision(1) << counts.front();
      const size_t count0len = ss.str().length();
      ss.str("");
      ss << name << " cut-flow:\n";
      size_t maxnamelen = 0;
      for (const string& t : cuts)
        maxnamelen = max(t.length(), maxnamelen);
      ss << setw(maxnamelen+5) << "" << "   "
         << setw(count0len) << right << "Count" << "    "
         << setw(6) << right << "A_cumu" << "    "
         << setw(6) << right << "A_incr";
      for (size_t i = 0; i <= ncuts; ++i) {
        const int pcttot = (counts.front() == 0) ? -1 : round(100*counts.at(i)/double(counts.front()));
        const int pctinc = (i == 0 || counts.at(i-1) == 0) ? -1 : round(100*counts.at(i)/double(counts.at(i-1)));
        stringstream ss2;
        ss2 << fixed << setprecision(1) << counts.at(i);
        const string countstr = ss2.str(); ss2.str("");
        ss2 << fixed << setprecision(3) << pcttot << "%";
        const string pcttotstr = ss2.str(); ss2.str("");
        ss2 << fixed << setprecision(3) << pctinc << "%";
        const string pctincstr = ss2.str();
        ss << "\n"
           << setw(maxnamelen+5) << left << (i == 0 ? "" : "Pass "+cuts.at(i-1)) << "   "
           << setw(count0len) << right << countstr << "    "
           << setw(6) << right << (pcttot < 0 ? "- " : pcttotstr) << "    "
           << setw(6) << right << (pctinc < 0 ? "- " : pctincstr);
      }
      return ss.str();
    }

    void print(ostream& os) const {
      os << str() << flush;
    }

    string name;
    size_t ncuts;
    vector<string> cuts;
    vector<double> counts;

  };


  inline ostream& operator << (ostream& os, const Cutflow& cf) {
    return os << cf.str();
  }



  struct Cutflows {

    Cutflows() {  }

    Cutflows(const vector<Cutflow>& cutflows) : cfs(cutflows) {  }

    void addCutflow(const Cutflow& cf) {
      cfs.push_back(cf);
    }

    void addCutflow(const string& cfname, const vector<string>& cutnames) {
      cfs.push_back(Cutflow(cfname, cutnames));
    }

    Cutflow& operator [] (size_t i) { return cfs[i]; }
    const Cutflow& operator [] (size_t i) const { return cfs[i]; }

    Cutflow& operator [] (const string& name) {
      for (Cutflow& cf : cfs)
        if (cf.name == name) return cf;
      throw UserError("Requested cut-flow name '" + name + "' does not exist");
    }
    const Cutflow& operator [] (const string& name) const {
      for (const Cutflow& cf : cfs)
        if (cf.name == name) return cf;
      throw UserError("Requested cut-flow name '" + name + "' does not exist");
    }

    void fillinit(double weight=1.) {
      for (Cutflow& cf : cfs) cf.fillinit(weight);
    }

    bool fill(size_t icut, bool cutresult=true, double weight=1.) {
      for (Cutflow& cf : cfs) cf.fill(icut, cutresult, weight);
      return cutresult;
    }

    bool fill(size_t icut, double weight) {
      return fill(icut, true, weight);
    }



    void scale(double factor) {
      for (Cutflow& cf : cfs) cf.scale(factor);
    }

    void normalize(double norm, size_t icut=0) {
      for (Cutflow& cf : cfs) cf.normalize(norm, icut);
    }

    string str() const {
      stringstream ss;
      for (const Cutflow& cf : cfs)
        ss << cf << "\n\n";
      return ss.str();
    }

    void print(ostream& os) const {
      os << str() << flush;
    }

    vector<Cutflow> cfs;

  };

  inline ostream& operator << (ostream& os, const Cutflows& cfs) {
    return os << cfs.str();
  }


}

#endif