From 973b94b4283cec9a6426636a51f789742fe239fa Mon Sep 17 00:00:00 2001
From: Sebastien Ponce <sebastien.ponce@cern.ch>
Date: Wed, 23 Nov 2022 14:55:33 +0100
Subject: [PATCH] Fixed detail in the histogram documentation
---
GaudiKernel/include/Gaudi/Accumulators/Histogram.h | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/GaudiKernel/include/Gaudi/Accumulators/Histogram.h b/GaudiKernel/include/Gaudi/Accumulators/Histogram.h
index 9e663edc11..bacfb24396 100644
--- a/GaudiKernel/include/Gaudi/Accumulators/Histogram.h
+++ b/GaudiKernel/include/Gaudi/Accumulators/Histogram.h
@@ -427,11 +427,13 @@ namespace Gaudi::Accumulators {
* where :
* + axis is an array of tuples, one per dimension, with content (nBins(integer), minValue(number),
* maxValue(number), title(string))
- * + bins is an array of values. The length of the array is the product of (nBins+2) for all axis
- * the +2 is because the bin 0 is the one for values below minValue and bin nBins+1 is the one for values above
- * maxValue bins are stored row first, so we iterate first on highest dimension For each bin the value is either a
- * number (for non profile histograms) or a triplet (for profile histograms) containing (nEntries(integer),
- * sum(number), sum2(number))
+ * + bins is an array of values
+ * - The length of the array is the product of (nBins+2) for all axis
+ * - the +2 is because the bin 0 is the one for values below minValue and bin nBins+1 is the one for values
+ * above maxValue bins are stored row first so we iterate first on highest dimension
+ * - the value is a number for non profile histograms
+ * - the value is of the form ( (nEntries(integer), sum(number) ), sum2(number) ) for profile histograms
+ * Note the pair with a pair as first entry
*/
template <unsigned int ND, atomicity Atomicity, typename Arithmetic, const char* Type,
template <atomicity, typename, typename> typename Accumulator, typename Seq>
--
GitLab