[hist] Implement weighted filling in RHistAutoAxisFiller

Author: hahnjo

hist/histv7/inc/ROOT/RHistAutoAxisFiller.hxx

@@ -6,6 +6,8 @@
 #define ROOT_RHistAutoAxisFiller
 
 #include "RHist.hxx"
+#include "RHistEngine.hxx"
+#include "RWeight.hxx"
 
 #include <cmath>
 #include <cstddef>
@@ -42,6 +44,10 @@ Feedback is welcome!
 */
 template <typename BinContentType>
 class RHistAutoAxisFiller final {
+public:
+   static constexpr bool SupportsWeightedFilling = RHistEngine<BinContentType>::SupportsWeightedFilling;
+
+private:
    /// The filled histogram, after it has been constructed
    std::optional<RHist<BinContentType>> fHist;
 
@@ -50,9 +56,10 @@ class RHistAutoAxisFiller final {
    /// The maximum buffer size until Flush() is automatically called
    std::size_t fMaxBufferSize;
 
+   using BufferElement = std::conditional_t<SupportsWeightedFilling, std::pair<double, RWeight>, double>;
+
    /// The buffer of filled entries
-   // FIXME: need to store weights!
-   std::vector<double> fBuffer;
+   std::vector<BufferElement> fBuffer;
    /// The minimum of the filled entries
    double fMinimum = std::numeric_limits<double>::infinity();
    /// The maximum of the filled entries
@@ -77,18 +84,17 @@ public:
    std::size_t GetNNormalBins() const { return fNNormalBins; }
    std::size_t GetMaxBufferSize() const { return fMaxBufferSize; }
 
-   /// Fill an entry into the histogram.
-   ///
-   /// \param[in] x the argument
-   void Fill(double x)
+private:
+   void BufferImpl(double x, RWeight weight)
    {
-      // If the histogram exists, forward the Fill call.
-      if (fHist) {
-         fHist->Fill(x);
-         return;
+      if constexpr (SupportsWeightedFilling) {
+         fBuffer.emplace_back(x, weight);
+      } else {
+         assert(weight.fValue == 1.0);
+         // Silence compiler warning about unused parameter
+         (void)weight;
+         fBuffer.push_back(x);
       }
-
-      fBuffer.push_back(x);
       if (x < fMinimum) {
          fMinimum = x;
       }
@@ -101,6 +107,41 @@ public:
       }
    }
 
+public:
+   /// Fill an entry into the histogram.
+   ///
+   /// \param[in] x the argument
+   /// \par See also
+   /// the \ref Fill(double x, RWeight weight) "overload for weighted filling"
+   void Fill(double x)
+   {
+      // If the histogram exists, forward the Fill call.
+      if (fHist) {
+         fHist->Fill(x);
+         return;
+      }
+      BufferImpl(x, RWeight(1.0));
+   }
+
+   /// Fill an entry into the histogram with a weight.
+   ///
+   /// This overload is only available for floating-point bin content types (see
+   /// \ref RHistEngine::SupportsWeightedFilling).
+   ///
+   /// \param[in] x the argument
+   /// \param[in] weight the weight for this entry
+   /// \par See also
+   /// the \ref Fill(double x) "overload for unweighted filling"
+   void Fill(double x, RWeight weight)
+   {
+      // If the histogram exists, forward the Fill call.
+      if (fHist) {
+         fHist->Fill(x, weight);
+         return;
+      }
+      BufferImpl(x, weight);
+   }
+
    /// Flush the buffer of entries and construct the histogram.
    ///
    /// Throws an exception if the buffer is empty, the axis interval cannot be determined, or if it would be empty
@@ -127,8 +168,12 @@ public:
       assert(high > fMaximum);
       fHist.emplace(fNNormalBins, std::make_pair(fMinimum, high));
 
-      for (double x : fBuffer) {
-         fHist->Fill(x);
+      for (auto &&x : fBuffer) {
+         if constexpr (SupportsWeightedFilling) {
+            fHist->Fill(x.first, x.second);
+         } else {
+            fHist->Fill(x);
+         }
       }
       fBuffer.clear();
    }

hist/histv7/test/hist_auto.cxx

@@ -85,6 +85,36 @@ TEST(RHistAutoAxisFiller, FillMax0)
    EXPECT_EQ(hist.GetBinContent(RBinIndex::Overflow()), 0);
 }
 
+TEST(RHistAutoAxisFiller, FillFloat)
+{
+   RHistAutoAxisFiller<float> filler(3);
+
+   filler.Fill(1);
+   filler.Fill(2);
+
+   auto &hist = filler.GetHist();
+   EXPECT_EQ(hist.GetBinContent(0), 1);
+   EXPECT_EQ(hist.GetBinContent(2), 1);
+
+   filler.Fill(1.5);
+   EXPECT_EQ(hist.GetBinContent(1), 1);
+}
+
+TEST(RHistAutoAxisFiller, FillWeight)
+{
+   RHistAutoAxisFiller<float> filler(3);
+
+   filler.Fill(1, RWeight(0.8));
+   filler.Fill(2, RWeight(0.9));
+
+   auto &hist = filler.GetHist();
+   EXPECT_FLOAT_EQ(hist.GetBinContent(0), 0.8);
+   EXPECT_FLOAT_EQ(hist.GetBinContent(2), 0.9);
+
+   filler.Fill(1.5, RWeight(0.85));
+   EXPECT_FLOAT_EQ(hist.GetBinContent(1), 0.85);
+}
+
 TEST(RHistAutoAxisFiller, FlushError)
 {
    static constexpr std::size_t Bins = 20;