Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
#ifndef CondFormats_PhysicsToolsObjects_Histogram_icc
#define CondFormats_PhysicsToolsObjects_Histogram_icc

#include <cmath>
#include <cstddef>
#include <algorithm>
#include <numeric>
#include <vector>

#include "FWCore/Utilities/interface/Exception.h"

#include "CondFormats/PhysicsToolsObjects/interface/Histogram.h"

namespace PhysicsTools {
  namespace Calibration {

    namespace {  // hide when instantiated in -O0 debug mode
      template <typename T>
      inline const T &clamp(const T &min, const T &val, const T &max) {
        if (val < min)
          return min;
        if (val > max)
          return max;
        return val;
      }
    }  // namespace

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t>::Histogram() : limits(Axis_t(), Axis_t()), total(Value_t()) {
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t>::Histogram(const Histogram &orig)
        : binULimits(orig.binULimits), binValues(orig.binValues), limits(orig.limits), total(orig.total) {
      totalValid.store(orig.totalValid.load(std::memory_order_acquire), std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    template <typename OValue_t, typename OAxis_t>
    Histogram<Value_t, Axis_t>::Histogram(const Histogram<OValue_t, OAxis_t> &orig)
        : binULimits(orig.binULimits.begin(), orig.binULimits.end()),
          binValues(orig.binValues.begin(), orig.binValues.end()),
          limits(orig.limits),
          total(Value_t()) {
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t>::Histogram(const std::vector<Axis_t> &binULimits)
        : binULimits(binULimits), binValues(binULimits.size() + 1), limits(Axis_t(), Axis_t()), total(Value_t()) {
      totalValid.store(true, std::memory_order_release);
      if (binULimits.size() < 2)
        throw cms::Exception("TooFewBinsError") << "Trying to generate degenerate histogram: "
                                                   "Fewer than one bin requested."
                                                << std::endl;

      limits.min = binULimits.front();
      limits.max = binULimits.back();
    }

    template <typename Value_t, typename Axis_t>
    template <typename OAxis_t>
    Histogram<Value_t, Axis_t>::Histogram(const std::vector<OAxis_t> &binULimits)
        : binULimits(binULimits.begin(), binULimits.end()),
          binValues(binULimits.size() + 1),
          limits(Axis_t(), Axis_t()),
          total(Value_t()) {
      totalValid.store(true, std::memory_order_release);
      if (binULimits.size() < 2)
        throw cms::Exception("TooFewBinsError") << "Trying to generate degenerate histogram: "
                                                   "Fewer than one bin requested."
                                                << std::endl;

      limits.min = binULimits.front();
      limits.max = binULimits.back();
    }

    template <typename Value_t, typename Axis_t>
    template <typename OAxis_t>
    Histogram<Value_t, Axis_t>::Histogram(unsigned int nBins, const PhysicsTools::Calibration::Range<OAxis_t> &range)
        : binValues(nBins + 2), limits(range), total(Value_t()) {
      totalValid.store(true, std::memory_order_release);
      if (!nBins)
        throw cms::Exception("TooFewBinsError") << "Trying to generate degenerate histogram: "
                                                   "Fewer than one bin requested."
                                                << std::endl;
    }

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t>::Histogram(unsigned int nBins, Axis_t min, Axis_t max)
        : binValues(nBins + 2), limits(min, max), total(Value_t()) {
      totalValid.store(true, std::memory_order_release);
      if (!nBins)
        throw cms::Exception("TooFewBinsError") << "Trying to generate degenerate histogram: "
                                                   "Fewer than one bin requested."
                                                << std::endl;
    }

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t>::~Histogram() {}

    template <typename Value_t, typename Axis_t>
    Histogram<Value_t, Axis_t> &Histogram<Value_t, Axis_t>::operator=(const Histogram &orig) {
      binULimits = orig.binULimits;
      binValues = orig.binValues;
      limits = orig.limits;
      total = orig.total;
      totalValid.store(orig.totalValid.load(std::memory_order_acquire), std::memory_order_release);
      return *this;
    }

    template <typename Value_t, typename Axis_t>
    template <typename OValue_t, typename OAxis_t>
    Histogram<Value_t, Axis_t> &Histogram<Value_t, Axis_t>::operator=(const Histogram<OValue_t, OAxis_t> &orig) {
      binULimits = std::vector<Axis_t>(orig.binULimits.begin(), orig.binULimits.end());
      binValues = std::vector<Value_t>(orig.binValues.begin(), orig.binValues.end());
      limits = orig.limits;
      total = orig.total;
      totalValid.store(orig.totalValid.load(std::memory_order_acquire), std::memory_order_release);
      return *this;
    }

    template <typename Value_t, typename Axis_t>
    void Histogram<Value_t, Axis_t>::reset() {
      std::fill(binValues.begin(), binValues.end(), Value_t());
      total = Value_t();
      totalValid.store(true, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    void Histogram<Value_t, Axis_t>::setBinContent(int bin, Value_t value) {
      if (bin < 0 || (unsigned int)bin >= binValues.size())
        throw cms::Exception("RangeError") << "Histogram bin " << bin
                                           << " out of range "
                                              "[0, "
                                           << (binValues.size() - 1) << "]." << std::endl;

      binValues[bin] = value;
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    void Histogram<Value_t, Axis_t>::fill(Axis_t x, Value_t weight) {
      int bin = findBin(x);
      binValues[bin] += weight;
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    void Histogram<Value_t, Axis_t>::setValues(const std::vector<Value_t> &values) {
      if (values.size() != binValues.size())
        throw cms::Exception("InvalidVectorSizeError") << "Invalid vector size while setting "
                                                          "histogram values"
                                                       << std::endl;

      binValues = values;
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    template <typename OValue_t>
    void Histogram<Value_t, Axis_t>::setValues(const std::vector<OValue_t> &values) {
      if (values.size() != binValues.size())
        throw cms::Exception("InvalidVectorSizeError") << "Invalid vector size while setting "
                                                          "histogram values"
                                                       << std::endl;

      std::copy(values.begin(), values.end(), binValues.begin());
      totalValid.store(false, std::memory_order_release);
    }

    template <typename Value_t, typename Axis_t>
    typename Histogram<Value_t, Axis_t>::Range Histogram<Value_t, Axis_t>::binRange(int bin) const {
      std::size_t size = binValues.size();
      if (bin < 1 || (unsigned int)bin > size - 2)
        throw cms::Exception("RangeError") << "Histogram bin " << bin << " out of range "
                                           << "[1, " << (size - 2) << "]." << std::endl;

      if (hasEquidistantBins()) {
        Axis_t min = (Axis_t)(bin - 1) / (size - 2);
        Axis_t max = (Axis_t)bin / (size - 2);
        min *= limits.width();
        min += limits.min;
        max *= limits.width();
        max += limits.min;
        return Range(min, max);
      } else
        return Range(binULimits[bin - 1], binULimits[bin]);
    }

    template <typename Value_t, typename Axis_t>
    int Histogram<Value_t, Axis_t>::findBin(Axis_t x) const {
      if (hasEquidistantBins()) {
        std::size_t size = binValues.size();
        x -= limits.min;
        x *= size - 2;
        x /= limits.width();
        return clamp(0, (int)(std::floor(x)) + 1, (int)size - 1);
      } else
        return std::upper_bound(binULimits.begin(), binULimits.end(), x) - binULimits.begin();
    }

    template <typename Value_t, typename Axis_t>
    Value_t Histogram<Value_t, Axis_t>::normalization() const {
      if (!totalValid.load(std::memory_order_acquire)) {
        total = std::accumulate(binValues.begin() + 1, binValues.end() - 1, Value_t());
        totalValid.store(true, std::memory_order_release);
      }

      return total;
    }

    template <typename Value_t, typename Axis_t>
    Value_t Histogram<Value_t, Axis_t>::integral(Axis_t hBound, Axis_t lBound, int mode) const {
      if (hBound < lBound)
        throw cms::Exception("InvalidIntervalError") << "Upper boundary below lower boundary in "
                                                     << "histogram integral." << std::endl;

      std::size_t size = binValues.size();
      int lBin = clamp(1, findBin(lBound), (int)size - 2);
      int hBin = clamp(1, findBin(hBound), (int)size - 2);

      double sum = Value_t();
      Range lBinRange, hBinRange;

      if (hBin > lBin)
        sum = std::accumulate(binValues.begin() + (lBin + 1), binValues.begin() + hBin, Value_t());

      if (hasEquidistantBins()) {
        Axis_t binWidth = limits.width() / (size - 2);
        lBinRange = Range((lBin - 1) * binWidth, lBin * binWidth);
        hBinRange = Range((hBin - 1) * binWidth, hBin * binWidth);
      } else {
        lBinRange = Range(binULimits[lBin - 1], binULimits[lBin]);
        hBinRange = Range(binULimits[hBin - 1], binULimits[hBin]);
      }

      switch (mode) {
        case 0:
          break;
        case 1:
          lBound = clamp(lBinRange.min, lBound, lBinRange.max);
          hBound = clamp(hBinRange.min, hBound, hBinRange.max);
          sum += binValues[lBin] * (lBinRange.max - lBound) / lBinRange.width();
          sum += binValues[hBin] * (hBound - hBinRange.min) / hBinRange.width();
          break;
        default:
          throw cms::Exception("InvalidMode") << "Invalid mode " << mode
                                              << " in "
                                                 "Histogram::integral()"
                                              << std::endl;
      }

      return sum;
    }

  }  // namespace Calibration
}  // namespace PhysicsTools

#endif  // CondFormats_PhysicsToolsObjects_Histogram_icc