Gaudi::Accumulators Namespace Reference

Efficient counter implementations for Gaudi. More...

Namespaces
namespace	details
namespace	naming

Classes
class	AccumulatorSet
	AccumulatorSet is an Accumulator that holds a set of Accumulators templated by same Arithmetic and Atomicity and increase them altogether. More...
struct	Adder
	An Adder ValueHandler operator(a, b) means a += b. More...
struct	Adder< Arithmetic, atomicity::full >
	Adder specialization in the case of atomicity full. More...
struct	Adder< Arithmetic, atomicity::none >
	Adder specialization in the case of atomicity none. More...
struct	AveragingAccumulatorBase
	AveragingAccumulatorBase. More...
struct	AveragingCounter
	A counter aiming at computing sum and average. More...
class	Axis
	Definition of a default type of Histogram Axis It contains number of bins, min and max value plus a title and defines the basic type of Axis (non log) It may also contain labels for the bins. More...
struct	BaseValueHandler
	Base type for all functors used as ValuesHandler. More...
struct	BaseValueHandler< Arithmetic, atomicity::full >
	BaseValueHandler specialization in the case of atomicity full. More...
struct	BaseValueHandler< Arithmetic, atomicity::none >
	BaseValueHandler specialization in the case of atomicity none. More...
struct	BinomialAccumulator
	BinomialAccumulator. More...
struct	BinomialCounter
	A counter dealing with binomial data. More...
class	Buffer
	Buffer is a non atomic Accumulator which, when it goes out-of-scope, updates the underlying thread-safe Accumulator for all previous updates in one go. More...
class	BufferableCounter
	An empty ancester of all counters that provides a buffer method that returns a buffer on itself Also registers the counter to its owner, with default type "counter" Due to this registration, move semantic is disabled. More...
struct	Constant
	A functor always returning the value N. More...
struct	construct_empty_t
	constant used to disambiguate construction of an empty Accumulator versus the copy constructor. More...
struct	CountAccumulator
	CountAccumulator. More...
struct	Counter
	A basic integral counter;. More...
struct	CounterArray
	generic class implementing an array of counters The only addition to a raw array is the constructor that allows to build names of the counters automatically from the index of the counter in the array There are 2 possibilities : More...
struct	CustomAxis
struct	ExtractWeight
	A functor to extract weight, take a pair (valueTuple, weight) as input. More...
struct	Extremum
	An Extremum ValueHandler, to be reused for Minimum and Maximum operator(a, b) means if (Compare(b,a)) a = b In case of full atomicity, compare_exchange_weak is used. More...
struct	Extremum< Arithmetic, atomicity::full, Compare, Initial >
	Extremum specialization in the case of atomicity full. More...
struct	Extremum< Arithmetic, atomicity::none, Compare, Initial >
	Extremum specialization in the case of atomicity none. More...
struct	FalseAccumulator
	FalseAccumulator. More...
struct	FalseTo1
	helper functor for the FalseAccumulator More...
class	GenericAccumulator
	Generic Accumulator, templated by. More...
struct	HistogramArray
	generic class implementing an array of histograms The only addition to a raw array is the constructor that allows to build names and titles for the histograms automatically from the index of the histogram in the array There are 2 possibilities : More...
struct	HistogramArray< Histo, N, std::integer_sequence< unsigned int, ND... > >
class	HistogramingAccumulatorInternal
	Internal Accumulator class dealing with Histograming. More...
class	HistogramingCounterBase
	A base counter dealing with Histograms. More...
class	HistogramingCounterBase< ND, Atomicity, Arithmetic, Type, Accumulator, std::tuple< AxisTypes... > >
struct	HistogramMap
	generic class implementing a thread safe map of histograms More...
struct	HistogramMap< Key, Histo, std::integer_sequence< unsigned int, ND... > >
class	HistogramWrapperInternal
	A Wrapper of a static Histogram base class using Properties to define title and axis. More...
class	HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >
struct	HistoInputType
	small class used as InputType for regular Histograms basically a tuple of the given values, specialized in case of a single entry so that the syntax is more natural. More...
struct	HistoInputType< std::tuple< Elements... >, NIndex >
struct	Identity
	An Identity functor. More...
struct	IntegralAccumulator
	IntegralAccumulator. More...
struct	MaxAccumulator
	MaxAccumulator. More...
struct	MinAccumulator
	MinAccumulator. More...
class	MsgCounter
struct	PrintableCounter
	An empty ancester of all counters that knows how to print themselves. More...
struct	RootHistogramingAccumulator
	Class implementing a root histogram accumulator. More...
struct	RootHistogramingAccumulator< Atomicity, Arithmetic, std::integral_constant< unsigned int, 1 >, AxisTupleType >
struct	RootHistogramingAccumulator< Atomicity, Arithmetic, std::integral_constant< unsigned int, 2 >, AxisTupleType >
struct	RootHistogramingAccumulator< Atomicity, Arithmetic, std::integral_constant< unsigned int, 3 >, AxisTupleType >
class	RootHistogramingAccumulatorInternal
	Internal Accumulator class dealing with RootHistograming. More...
class	RootHistogramingCounterBase
	Extension of the standard Gaudi histogram to provide similar functionnality as ROOT. More...
class	RootHistogramingCounterBase< 1, Atomicity, Arithmetic, Type, AxisTupleType >
class	RootHistogramingCounterBase< 2, Atomicity, Arithmetic, Type, AxisTupleType >
class	RootHistogramingCounterBase< 3, Atomicity, Arithmetic, Type, AxisTupleType >
struct	SigmaAccumulatorBase
	SigmaAccumulatorBase. More...
struct	SigmaCounter
	A counter aiming at computing average and sum2 / variance / standard deviation. More...
struct	SigmaNAccumulator
struct	SigmaNAccumulator< Arithmetic, Atomicity, 1 >
	specialization for ND=1 to allow for better syntax More...
struct	SigmasValueHandler
struct	Square
	A Square functor. More...
struct	SquareAccumulator
	SquareAccumulator. More...
struct	StatCounter
	A counter aiming at computing average and sum2 / variance / standard deviation. More...
struct	SumAccumulator
	SumAccumulator. More...
struct	TrueAccumulator
	TrueAccumulator. More...
struct	TrueTo1
	helper functor for the TrueAccumulator More...
struct	WeightedAdder
	An Adder ValueHandler, taking weight into account and computing a count plus the sum of the weights In case of full atomicity, fetch_add or compare_exchange_weak are used for each element, that is we do not have full atomicity accross the two elements. More...
struct	WeightedCountAccumulator
	WeightedCountAccumulator. More...
struct	WeightedHistoInputType
	small class used as InputType for weighted Histograms only a pair of the InnerType and the weight. More...
struct	WeightedProduct
	A Product functor, take a pair (value, weight) as input. More...
struct	WeightedProfileTransform
	An inputTransform for WeightedProfile histograms, keeping weight and replacing value by 1. More...
struct	WeightedSquare
	A WeightedSquare functor, take a pair (value, weight) as input. More...
struct	WeightedSquareAccumulator
	WeightedSquareAccumulator. More...
struct	WeightedSumAccumulator
	WeightedSumAccumulator. More...

Typedefs
template<typename Arithmetic, typename Result = double>
using	fp_result_type = std::conditional_t<std::is_integral_v<Arithmetic>, Result, Arithmetic>
	type_trait for the result type of a floating point operation on the type Arithmetic
template<typename Arithmetic, atomicity Atomicity = atomicity::full>
using	Minimum = Extremum<Arithmetic, Atomicity, std::less<Arithmetic>, std::numeric_limits<Arithmetic>::max>
	A Minimun ValueHandler operator(a, b) means a = min(a, b) In case of full atomicity, compare_exchange_weak is used.
template<typename Arithmetic, atomicity Atomicity = atomicity::full>
using	Maximum = Extremum<Arithmetic, Atomicity, std::greater<Arithmetic>, std::numeric_limits<Arithmetic>::lowest>
	An Maximum ValueHandler operator(a, b) means a = max(a, b) In case of full atomicity, compare_exchange_weak is used.
template<atomicity Atomicity, typename Arithmetic>
using	AveragingAccumulator = AveragingAccumulatorBase<Atomicity, Arithmetic, CountAccumulator, SumAccumulator>
	AveragingAccumulator.
template<atomicity Atomicity, typename Arithmetic>
using	SigmaAccumulator = SigmaAccumulatorBase<Atomicity, Arithmetic, AveragingAccumulator, SquareAccumulator>
	SigmaAccumulator.
template<atomicity Atomicity, typename Arithmetic>
using	StatAccumulator
	StatAccumulator.
template<typename Arithmetic = double, atomicity Atomicity = atomicity::full>
using	SummingCounter = AveragingCounter<Arithmetic, Atomicity>
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	Histogram = HistogramWrapper<StaticHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>
	standard custom histogram. See HistogramWrapper and StaticHistogram for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	WeightedHistogram = HistogramWrapper<StaticWeightedHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>
	custom histogram with weight. See HistogramWrapper and StaticWeightedHistogram for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	ProfileHistogram = HistogramWrapper<StaticProfileHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>
	custom profile histograming. See HistogramWrapper and StaticProfileHistogram for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	WeightedProfileHistogram
	custom weighted profile histogram. See HistogramWrapper and StaticWeightedProfileHistogram for details
template<typename HistogramType>
using	HistogramWrapper = HistogramWrapperInternal<HistogramType>
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	RootHistogram = HistogramWrapper<StaticRootHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>
	standard custom histogram
template<atomicity Atomicity, typename Arithmetic>
using	WeightedAveragingAccumulator
	WeightedAveragingAccumulator.
template<atomicity Atomicity, typename Arithmetic>
using	WeightedSigmaAccumulator
	WeightedSigmaAccumulator.
template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>
using	HistogramingAccumulator
	Class implementing a regular histogram accumulator.
template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>
using	WeightedHistogramingAccumulator
	Class implementing a weighted histogram accumulator.
template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>
using	ProfileHistogramingAccumulator
	Class implementing a profile histogram accumulator.
template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>
using	WeightedProfileHistogramingAccumulator
	Class implementing a weighted profile histogram accumulator.
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	StaticHistogram
	standard static histograming counter. See HistogramingCounterBase for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	StaticWeightedHistogram
	standard static histograming counter with weight. See HistogramingCounterBase for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	StaticProfileHistogram
	profile static histograming counter. See HistogramingCounterBase for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	StaticWeightedProfileHistogram
	weighted static profile histograming counter. See HistogramingCounterBase for details
template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>
using	StaticRootHistogram
	Root histograming counter. See RootHistogramingCounterBase for details.

Enumerations
enum class	atomicity { none , full }
	Defines atomicity of the accumulators. More...

Functions
template<class Rep, class Period>
auto	sqrt (std::chrono::duration< Rep, Period > d)
	sqrt for std::chrono::duration
template<class Rep1, class Rep2, class Period>
auto	operator* (const std::chrono::duration< Rep1, Period > &lhs, const std::chrono::duration< Rep2, Period > &rhs)
	Multiplication of two std::chrono::duration objects with same Period.
template<class T>
auto	sqrt (T d)
	forward declaration of sqrt for custom types
template<typename AtomicType, typename Arithmetic>
void	fetch_add (AtomicType &atVar, Arithmetic value)
	generic fetch_add, also dealing with atomic types with no fetch_add member method
std::ostream &	operator<< (std::ostream &s, const PrintableCounter &counter)
	external printout operator to a stream type
MsgStream &	operator<< (MsgStream &s, const PrintableCounter &counter)
template<typename Counter, typename Container, typename Fun>
void	accumulate (Counter &counter, const Container &container, Fun f=Identity{})
	A helper function for accumulating data from a container into a counter This is internally using buffers so that the original counter is only updated once.
template<typename Arithmetic>
void	to_json (nlohmann::json &j, const Axis< Arithmetic > &axis)
	automatic conversion of the Axis type to json
constexpr unsigned int	NSUMS (unsigned int ND)
	number of items in sums for a given dimension = 1 (nb items) + ND (sums of each dimension) + ND*(ND+1)/2 (square sums)
void	to_json (nlohmann::json &j, const CustomAxis &axis)

Variables
constexpr construct_empty_t	construct_empty {}

Detailed Description

Efficient counter implementations for Gaudi.

A number of concepts and templated classes are defined:

Concepts

• Accumulator : object accumulating some data in some way. examples : counters, sum of squares accumulator, minimum accumulator (keeps minimum of all values)
• Atomicity : the atomicity of an accumulator. Can be none or full. "none" means that the accumulator is not thread safe and should only be used locally within a thread. "full" means that the accumulator is thread safe, but that you pay the price of atomics inside. Note that this price may be reduced by the usage of the Buffer class, see below.
• InputTransform : a transformation to be applied to the input of an Accumulator. for example "elevation to power 2" for a sum of squares Accumulator, "identity" for a sum Accumulator or a minimum Accumulator, "constant 1" for a pure counter
• OutputTransform : a transformation to be applied to the value of an Accumulator when reading it. Usually identity. You can think of square root for an RMS Accumulator (accumulating squares internally)
• ValueHandler : the class handling the internal value of an Accumulator, and responsible for updating it with a new input. It defines the initial default value, the storage type used (depending on atomicity) and the actual update operation (sum, keep min or max typically).
• AccumulatorSet : an Accumulator defined as a set of Accumulators with same InputType and Atomicity. Updating it means updating all Accumulators of the set with the same value. E.g. a set with Counter and Sum will be able to compute some average
• Buffer : a wrapper around a thread safe Accumulator that allows to accumulate locally (in a non thread safe Accumulator) data before merging into the original one when Buffer is destructed. To be use when accumulators are updated in tight loops
• Counter : a higher level object that is an Accumulator and provides extra methods, most notably a way to print itself via operator<<, a print method and a buffer method to retrieve a Buffer on top of it.

Classes and helper functions

• many classes are directly linked to concepts :
  • Constant, Identity, Square are InputTransforms / OutputTransforms
  • BaseValueHandler : a base class for ValueHandlers Adder, Minimum and Maximum
  • Adder, Extremum, Minimum, Maximum, Binomial are ValueHandlers
  • GenericAccumulator : implements a generic Accumulator. See class definition for details
  • AccumulatorSet binds together a set of Accumulators into a new accumulator
  • Buffer implements the local buffering of an Accumulator
• some classes implements the most common Accumulators :
  • MaxAccumulator : keeps the max, has a max() method
  • MinAccumulator : keeps the min, has a min() method
  • CountAccumulator : keeps count of number of values, has a nEntries() method
  • SumAccumulator : keeps the sum of all values, has a sum() method
  • IntegralAccumulator : similar to CountAccumulator and SumAccumulator for integers, has a nEntries() and a sum() method
  • SquareAccumulator : keeps the sum of all values squared, has a sum2() method
  • TrueAccumulator : keeps a count of the number of true values, has a nTrueEntries() method
  • FalseAccumulator : keeps a count of the number of false values, has a nFalseEntries() method
  • BinomialAccumulator : set of TrueAccumulator and FalseAccumulator. Has extra nEntries(), efficiency() and efficiencyErr() methods
  • AveragingAccumulator : set of CountAccumulator and SumAccumulator. Has an extra mean() method
  • SigmaAccumulator : set of AveragingAccumulator and SquareAccumulator. Has extra methods variance(), standard_deviation() and meanErr()
  • MsgCounter: keeps a count of number of values, and prints the first N times it is incremented at a specified logging level
  • StatAccumulator : set of SigmaAccumulator, MinAccumulator and MaxAccumulator
• some classes implement the most common Counters :
  • PrintableCounter is the interface to be used for abstract counters that can be printed
  • BufferableCounter is the base class for counters that can be buffered. It provides a buffer method returning a Buffer on the current counter
  • Counter, AveragingCounter, SigmaCounter, StatCounter, BinomialCounter : standard counters based on the corresponding accumulators
  • StatEntity : a counter meant to be backward compatible with the old one and actually being a set of StatAccumulator and BinomialAccumulator. StatEntity should not be used and should be dropped when ancient code has been ported to the other counters
  • MsgCounter : a counter logging a given message up to the given number of occurrences, then loggin that it stops logging but still counting occurences

(De)Serialization

All counters are serialized into JSON strings using nlohmann's json library (pure header) See https://github.com/nlohmann/json for details, but here are few notes :

• all Arithmetic types used in Counters need to be serializable with this library
• standard types (STL included) already are
• for custom types, one needs to implement a to_json method along these lines :

  void to_json(json& j, const Person& p) {
      j = nlohmann::json{{"name", p.name}, {"type", "person:basic"}, {"address", p.address}, {"age", p.age}};
  }

  This method must be declared in your type namespace
• for third-party type, it's slightly more complicated and one has to specialize a class called adl_serializer for the given type. Just follow the example given in this file for std::chrono::duration

Symetrically to serialization, all counters objects can be constructed from json objects using the same nlohmann's json library via a the fromJSON static method;

The serialized json needs to contain a 'type' entry defining the rest of the json structure. If the type value contains a ':' character, then the part preceding it will be considered as a namespace. The rest is free text.

Here is a list of types defined in this header and their corresponding fields. Note that there are 2 kinds of fields : raw ones and derived ones, built on top of raw ones. Note also that <prec> when present is a string defining the precision of the data when numerical. It is described at the end of the list for each dependent field, the computation formula is given

• counter:Counter:<prec> : empty(bool), nEntries(integer)
• counter:AveragingCounter:<prec> : same as counter:Counter, sum(number), mean(number) = sum/nEntries
• counter:SigmaCounter:<prec> : same as counter:AveragingCounter, sum2(number), standard_deviation(number) = sqrt((sum2-sum*sum/nEntries)/(nEntries-1))
• counter:StatCounter:<prec> : same as counter:SigmaCounter, min(number), max(number)
• counter:BinomialCounter:<prec> : nTrueEntries(integer), nFalseEntries(integer), nEntries(integer) = nTrueEntries+nFalseEntries efficiency(number) = nTrueEntries/nEntries, efficiencyErr(number) = (nTrueEntries*nFalseEntries)/(nEntries*nEntries)
• counter:MsgCounter : same as counter:Counter, level(number), max(number), msg(string)
• statentity : union of fields of counter:StatCounter and counter:BinomialCounter. DEPRECATED
• timer:<prec> : same fields as counter:StatCounter
• <prec> is a string defining the type of data in the counter. It is the typeid representation of the type that should be used by a customer to use the data and not lose precision. In other terms, it's usually one char of chstijlmxyfde for respectively char, unsigned char, short, unsigned short, int, unsigned int, long, unsigned long, long long, unsigned long long, float, double, long double Note that it does not have to match the original type, just to be the same precision. E.g. an std::chrono::nanoseconds type can and should be mapped to its internal representation that happens to be long so <prec> will be l.

Notes

All Accumulators and Counters defined above are provided in their atomic and non atomic versions

Here is an example of the typical usage of these classes :

AveragingCounter<> avg;
avg += 3;
avg += 5;
avg += 6;
std::cout << avg << std::endl;
 
SigmaCounter<> sig;
sig += 3;
sig += 5;
sig += 6;
std::cout << sig << std::endl;
 
AveragingCounter<float, atomicity::full> avg2;
{
  auto buf = avg2.buffer();
  for ( int i = 0; i < 1000; i++ ) buf += i;
  // single update of original counter when buf is destroyed
}
std::cout << avg2 << std::endl;
 
BinomialCounter<> bin;
bin += false;
bin += true;
bin += true;
bin += false;
bin += false;
std::cout << bin << std::endl;
 
StatEntity se;
se += 3;
se += 5;
se += 6;
std::cout << se << std::endl;

Typedef Documentation

AveragingAccumulator

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::AveragingAccumulator = AveragingAccumulatorBase<Atomicity, Arithmetic, CountAccumulator, SumAccumulator>

AveragingAccumulator.

An AveragingAccumulator is an Accumulator able to compute an average

See also

Gaudi::Accumulators for detailed documentation

Definition at line 758 of file Accumulators.h.

fp_result_type

template<typename Arithmetic, typename Result = double>

using Gaudi::Accumulators::fp_result_type = std::conditional_t<std::is_integral_v<Arithmetic>, Result, Arithmetic>

type_trait for the result type of a floating point operation on the type Arithmetic

Definition at line 303 of file Accumulators.h.

Histogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::Histogram = HistogramWrapper<StaticHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>

standard custom histogram. See HistogramWrapper and StaticHistogram for details

Definition at line 22 of file Histogram.h.

HistogramingAccumulator

template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>

using Gaudi::Accumulators::HistogramingAccumulator

Initial value:

 
      HistogramingAccumulatorInternal<Atomicity, HistoInputType<AxisToArithmetic_t<AxisTupleType>, ND::value>,
                                      unsigned long, IntegralAccumulator, AxisTupleType>

Class implementing a regular histogram accumulator.

Actually only an alias to HistogramingAccumulatorInternal with proper template parameters

Definition at line 564 of file StaticHistogram.h.

HistogramWrapper

template<typename HistogramType>

using Gaudi::Accumulators::HistogramWrapper = HistogramWrapperInternal<HistogramType>

Definition at line 171 of file HistogramWrapper.h.

Maximum

template<typename Arithmetic, atomicity Atomicity = atomicity::full>

using Gaudi::Accumulators::Maximum = Extremum<Arithmetic, Atomicity, std::greater<Arithmetic>, std::numeric_limits<Arithmetic>::lowest>

An Maximum ValueHandler operator(a, b) means a = max(a, b) In case of full atomicity, compare_exchange_weak is used.

Definition at line 430 of file Accumulators.h.

Minimum

template<typename Arithmetic, atomicity Atomicity = atomicity::full>

using Gaudi::Accumulators::Minimum = Extremum<Arithmetic, Atomicity, std::less<Arithmetic>, std::numeric_limits<Arithmetic>::max>

A Minimun ValueHandler operator(a, b) means a = min(a, b) In case of full atomicity, compare_exchange_weak is used.

Definition at line 423 of file Accumulators.h.

ProfileHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::ProfileHistogram = HistogramWrapper<StaticProfileHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>

custom profile histograming. See HistogramWrapper and StaticProfileHistogram for details

Definition at line 32 of file Histogram.h.

ProfileHistogramingAccumulator

template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>

using Gaudi::Accumulators::ProfileHistogramingAccumulator

Initial value:

 
      HistogramingAccumulatorInternal<Atomicity,
                                      HistoInputType<ProfileAxisToArithmetic_t<Arithmetic, AxisTupleType>, ND::value>,
                                      Arithmetic, SigmaAccumulator, AxisTupleType>

Class implementing a profile histogram accumulator.

Actually only an alias to HistogramingAccumulatorInternal with proper template parameters

Definition at line 585 of file StaticHistogram.h.

RootHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::RootHistogram = HistogramWrapper<StaticRootHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>

standard custom histogram

Definition at line 22 of file RootHistogram.h.

SigmaAccumulator

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::SigmaAccumulator = SigmaAccumulatorBase<Atomicity, Arithmetic, AveragingAccumulator, SquareAccumulator>

SigmaAccumulator.

A SigmaAccumulator is an Accumulator able to compute an average and variance/rms

See also

Gaudi::Accumulators for detailed documentation

Definition at line 819 of file Accumulators.h.

StatAccumulator

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::StatAccumulator

Initial value:

 
      AccumulatorSet<Arithmetic, Atomicity, Arithmetic, SigmaAccumulator, MinAccumulator, MaxAccumulator>

StatAccumulator.

A StatAccumulator is an Accumulator able to compute an average, variance/rms and min/max

See also

Gaudi::Accumulators for detailed documentation

Definition at line 826 of file Accumulators.h.

StaticHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::StaticHistogram

Initial value:

 HistogramingCounterBase<ND, Atomicity, Arithmetic, naming::histogramString,
                                                  HistogramingAccumulator, AxisTupleType>

standard static histograming counter. See HistogramingCounterBase for details

Definition at line 733 of file StaticHistogram.h.

StaticProfileHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::StaticProfileHistogram

Initial value:

 HistogramingCounterBase<ND, Atomicity, Arithmetic, naming::profilehistogramString,
                                                         ProfileHistogramingAccumulator, AxisTupleType>

profile static histograming counter. See HistogramingCounterBase for details

Definition at line 745 of file StaticHistogram.h.

StaticRootHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::StaticRootHistogram

Initial value:

 
      RootHistogramingCounterBase<ND, Atomicity, Arithmetic, naming::histogramString, AxisTupleType>

Root histograming counter. See RootHistogramingCounterBase for details.

Definition at line 358 of file StaticRootHistogram.h.

StaticWeightedHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::StaticWeightedHistogram

Initial value:

 HistogramingCounterBase<ND, Atomicity, Arithmetic, naming::weightedHistogramString,
                                                          WeightedHistogramingAccumulator, AxisTupleType>

standard static histograming counter with weight. See HistogramingCounterBase for details

Definition at line 739 of file StaticHistogram.h.

StaticWeightedProfileHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::StaticWeightedProfileHistogram

Initial value:

 
      HistogramingCounterBase<ND, Atomicity, Arithmetic, naming::weightedProfilehistogramString,
                              WeightedProfileHistogramingAccumulator, AxisTupleType>

weighted static profile histograming counter. See HistogramingCounterBase for details

Definition at line 751 of file StaticHistogram.h.

SummingCounter

template<typename Arithmetic = double, atomicity Atomicity = atomicity::full>

using Gaudi::Accumulators::SummingCounter = AveragingCounter<Arithmetic, Atomicity>

Definition at line 1005 of file Accumulators.h.

WeightedAveragingAccumulator

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::WeightedAveragingAccumulator

Initial value:

 
      AveragingAccumulatorBase<Atomicity, Arithmetic, WeightedCountAccumulator, WeightedSumAccumulator>

WeightedAveragingAccumulator.

An WeightedAveragingAccumulator is an Accumulator able to compute an average This implementation takes a pair (value, weight) as input

See also

Gaudi::Accumulators for detailed documentation

Definition at line 210 of file StaticHistogram.h.

WeightedHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::WeightedHistogram = HistogramWrapper<StaticWeightedHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>

custom histogram with weight. See HistogramWrapper and StaticWeightedHistogram for details

Definition at line 27 of file Histogram.h.

WeightedHistogramingAccumulator

template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>

using Gaudi::Accumulators::WeightedHistogramingAccumulator

Initial value:

 
      HistogramingAccumulatorInternal<Atomicity,
                                      WeightedHistoInputType<AxisToArithmetic_t<AxisTupleType>, ND::value, Arithmetic>,
                                      Arithmetic, WeightedCountAccumulator, AxisTupleType>

Class implementing a weighted histogram accumulator.

Actually only an alias to HistogramingAccumulatorInternal with proper template parameters

Definition at line 574 of file StaticHistogram.h.

WeightedProfileHistogram

template<unsigned int ND, atomicity Atomicity = atomicity::full, typename Arithmetic = double, typename AxisTupleType = make_tuple_t<Axis<Arithmetic>, ND>>

using Gaudi::Accumulators::WeightedProfileHistogram

Initial value:

 
      HistogramWrapper<StaticWeightedProfileHistogram<ND, Atomicity, Arithmetic, AxisTupleType>>

custom weighted profile histogram. See HistogramWrapper and StaticWeightedProfileHistogram for details

Definition at line 37 of file Histogram.h.

WeightedProfileHistogramingAccumulator

template<atomicity Atomicity, typename Arithmetic, typename ND, typename AxisTupleType>

using Gaudi::Accumulators::WeightedProfileHistogramingAccumulator

Initial value:

 HistogramingAccumulatorInternal<
      Atomicity, WeightedHistoInputType<ProfileAxisToArithmetic_t<Arithmetic, AxisTupleType>, ND::value, Arithmetic>,
      Arithmetic, WeightedSigmaAccumulator, AxisTupleType>

Class implementing a weighted profile histogram accumulator.

Actually only an alias to HistogramingAccumulatorInternal with proper template parameters

Definition at line 596 of file StaticHistogram.h.

WeightedSigmaAccumulator

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::WeightedSigmaAccumulator

Initial value:

 
      SigmaAccumulatorBase<Atomicity, Arithmetic, WeightedAveragingAccumulator, WeightedSquareAccumulator>

WeightedSigmaAccumulator.

A WeightedSigmaAccumulator is an Accumulator able to compute an average and variance/rms This implementation takes a pair (value, weight) as input

See also

Gaudi::Accumulators for detailed documentation

Definition at line 219 of file StaticHistogram.h.

Enumeration Type Documentation

atomicity

enum class Gaudi::Accumulators::atomicity

strong

Defines atomicity of the accumulators.

Enumerator
none
full

Definition at line 262 of file Accumulators.h.

{ none, full };

Function Documentation

accumulate()

template<typename Counter, typename Container, typename Fun>

void Gaudi::Accumulators::accumulate	(	Counter &	counter,
		const Container &	container,
		Fun	f = Identity{} )

A helper function for accumulating data from a container into a counter This is internally using buffers so that the original counter is only updated once.

Definition at line 1227 of file Accumulators.h.

                                                                                 {} ) {
    auto b = counter.buffer();
    for ( const auto& elem : container ) b += f( elem );
  }

fetch_add()

template<typename AtomicType, typename Arithmetic>

void Gaudi::Accumulators::fetch_add	(	AtomicType &	atVar,
		Arithmetic	value )

generic fetch_add, also dealing with atomic types with no fetch_add member method

Definition at line 357 of file Accumulators.h.

                                                        {
    if constexpr ( requires { atVar.fetch_add( value, std::memory_order_relaxed ); } ) {
      atVar.fetch_add( value, std::memory_order_relaxed );
    } else {
      auto current = BaseValueHandler<Arithmetic, atomicity::full>::getValue( atVar );
      while ( !atVar.compare_exchange_weak( current, current + value ) )
        ;
    }
  }

NSUMS()

unsigned int Gaudi::Accumulators::NSUMS ( unsigned int ND )

constexpr

number of items in sums for a given dimension = 1 (nb items) + ND (sums of each dimension) + ND*(ND+1)/2 (square sums)

Definition at line 29 of file StaticRootHistogram.h.

{ return 1 + ND + ND * ( ND + 1 ) / 2; }

operator*()

template<class Rep1, class Rep2, class Period>

auto Gaudi::Accumulators::operator*	(	const std::chrono::duration< Rep1, Period > &	lhs,
		const std::chrono::duration< Rep2, Period > &	rhs )

Multiplication of two std::chrono::duration objects with same Period.

Definition at line 40 of file Counters.h.

                                                                                                             {
      return std::chrono::duration<std::common_type_t<Rep1, Rep2>, Period>( lhs.count() * rhs.count() );
    }

operator<<() [1/2]

MsgStream & Gaudi::Accumulators::operator<< ( MsgStream & s, const PrintableCounter & counter )

inline

Definition at line 890 of file Accumulators.h.

{ return counter.print( s ); }

operator<<() [2/2]

std::ostream & Gaudi::Accumulators::operator<< ( std::ostream & s, const PrintableCounter & counter )

inline

external printout operator to a stream type

Definition at line 889 of file Accumulators.h.

{ return counter.print( s ); }

sqrt() [1/2]

template<class Rep, class Period>

auto Gaudi::Accumulators::sqrt

(

std::chrono::duration< Rep, Period >

d

)

sqrt for std::chrono::duration

Definition at line 34 of file Counters.h.

                                                  {
      return std::chrono::duration<Rep, Period>( static_cast<Rep>( std::round( std::sqrt( d.count() ) ) ) );
    }

sqrt() [2/2]

template<class T>

auto Gaudi::Accumulators::sqrt

(

T

d

)

forward declaration of sqrt for custom types

to_json() [1/2]

template<typename Arithmetic>

void Gaudi::Accumulators::to_json	(	nlohmann::json &	j,
		const Axis< Arithmetic > &	axis )

automatic conversion of the Axis type to json

Definition at line 318 of file StaticHistogram.h.

                                                                {
    j = nlohmann::json{ { "nBins", axis.numBins() },
                        { "minValue", axis.minValue() },
                        { "maxValue", axis.maxValue() },
                        { "title", axis.title() } };
    if ( !axis.labels().empty() ) { j["labels"] = axis.labels(); }
  }

to_json() [2/2]

void Gaudi::Accumulators::to_json	(	nlohmann::json &	j,
		const CustomAxis &	axis )

Definition at line 57 of file HistogramsTests.cpp.

                                                          {
    j           = nlohmann::json{ { "nBins", axis.numBins() },
                                  { "minValue", axis.minValue },
                                  { "maxValue", axis.maxValue },
                                  { "title", axis.title } };
    j["labels"] = axis.labels;
  }

Variable Documentation

construct_empty

construct_empty_t Gaudi::Accumulators::construct_empty {}

constexpr

Definition at line 440 of file Accumulators.h.

{};