Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity > Struct Template Reference

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...

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Accumulators/StaticHistogram.h>

Public Types
using	RegularType = std::pair<unsigned long, Arithmetic>
using	AtomicType = std::pair<std::atomic<unsigned long>, std::atomic<Arithmetic>>
using	OutputType = RegularType
using	InternalType = std::conditional_t<isAtomic, AtomicType, OutputType>

Static Public Member Functions
static constexpr OutputType	getValue (const InternalType &v) noexcept
static RegularType	exchange (InternalType &v, RegularType newv) noexcept
static constexpr OutputType	DefaultValue ()
static void	merge (InternalType &a, RegularType b) noexcept

Static Public Attributes
static constexpr bool	isAtomic = Atomicity == atomicity::full

Detailed Description

template<typename Arithmetic, atomicity Atomicity>
struct Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >

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.

Definition at line 123 of file StaticHistogram.h.

Member Typedef Documentation

AtomicType

template<typename Arithmetic, atomicity Atomicity>

using Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::AtomicType = std::pair<std::atomic<unsigned long>, std::atomic<Arithmetic>>

Definition at line 125 of file StaticHistogram.h.

InternalType

template<typename Arithmetic, atomicity Atomicity>

using Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::InternalType = std::conditional_t<isAtomic, AtomicType, OutputType>

Definition at line 128 of file StaticHistogram.h.

OutputType

template<typename Arithmetic, atomicity Atomicity>

using Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::OutputType = RegularType

Definition at line 126 of file StaticHistogram.h.

RegularType

template<typename Arithmetic, atomicity Atomicity>

using Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::RegularType = std::pair<unsigned long, Arithmetic>

Definition at line 124 of file StaticHistogram.h.

Member Function Documentation

DefaultValue()

template<typename Arithmetic, atomicity Atomicity>

static constexpr OutputType Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::DefaultValue ( )

inlinestaticconstexpr

Definition at line 143 of file StaticHistogram.h.

{ return { 0, Arithmetic{} }; }

exchange()

template<typename Arithmetic, atomicity Atomicity>

static RegularType Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::exchange ( InternalType & v, RegularType newv )

inlinestaticnoexcept

Definition at line 136 of file StaticHistogram.h.

                                                                              {
      if constexpr ( isAtomic ) {
        return { v.first.exchange( newv.first ), v.second.exchange( newv.second ) };
      } else {
        return { std::exchange( v.first, newv.first ), std::exchange( v.second, newv.second ) };
      }
    }

getValue()

template<typename Arithmetic, atomicity Atomicity>

static constexpr OutputType Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::getValue ( const InternalType & v )

inlinestaticconstexprnoexcept

Definition at line 129 of file StaticHistogram.h.

                                                                           {
      if constexpr ( isAtomic ) {
        return { v.first.load( std::memory_order_relaxed ), v.second.load( std::memory_order_relaxed ) };
      } else {
        return v;
      }
    }

merge()

template<typename Arithmetic, atomicity Atomicity>

static void Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::merge ( InternalType & a, RegularType b )

inlinestaticnoexcept

Definition at line 144 of file StaticHistogram.h.

                                                                                 {
      if constexpr ( isAtomic ) {
        fetch_add( a.first, b.first );
        fetch_add( a.second, b.second );
      } else {
        a.first += b.first;
        a.second += b.second;
      }
    }

Member Data Documentation

isAtomic

template<typename Arithmetic, atomicity Atomicity>

bool Gaudi::Accumulators::WeightedAdder< Arithmetic, Atomicity >::isAtomic = Atomicity == atomicity::full

staticconstexpr

Definition at line 127 of file StaticHistogram.h.

---

The documentation for this struct was generated from the following file:

• GaudiKernel/include/Gaudi/Accumulators/StaticHistogram.h