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

WeightedCountAccumulator. More...

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

Inheritance diagram for Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >:

Collaboration diagram for Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >:

Public Types
using	Base
Public Types inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, std::pair< unsigned long, Arithmetic >, Atomicity, WeightedProfileTransform, ExtractWeight, WeightedAdder< Arithmetic, Atomicity > >
using	InputType
using	OutputType
using	InternalType
using	JSONStringEntriesType

Public Member Functions
WeightedCountAccumulator	operator+= (const Arithmetic weight)
	overload of operator+= to be able to only give weight and no value
unsigned long	nEntries () const
Arithmetic	sumOfWeights () const
GenericAccumulator	operator+= (const InputType by)
Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, std::pair< unsigned long, Arithmetic >, Atomicity, WeightedProfileTransform, ExtractWeight, WeightedAdder< Arithmetic, Atomicity > >
GenericAccumulator	operator+= (const InputType by)
	GenericAccumulator ()=default
	GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, std::pair< unsigned long, Arithmetic >, ato, WeightedProfileTransform, ExtractWeight, VH > &)
	constructor of an empty GenericAccumulator, copying the (non existent) config from another GenericAccumulator
	GenericAccumulator (std::in_place_t, Args &&... args)
	GenericAccumulator (const GenericAccumulator &other)
GenericAccumulator &	operator= (const GenericAccumulator &other)
OutputType	value () const
void	reset ()
void	mergeAndReset (GenericAccumulator< InputType, std::pair< unsigned long, Arithmetic >, ato, WeightedProfileTransform, ExtractWeight, VH > &other)
void	operator+ (GenericAccumulator< InputType, std::pair< unsigned long, Arithmetic >, ato, WeightedProfileTransform, ExtractWeight, VH > &&other)

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, std::pair< unsigned long, Arithmetic >, Atomicity, WeightedProfileTransform, ExtractWeight, WeightedAdder< Arithmetic, Atomicity > >
	GenericAccumulator (std::pair< unsigned long, Arithmetic > in)
auto	rawValue () const
void	reset (std::pair< unsigned long, Arithmetic > in)
Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, std::pair< unsigned long, Arithmetic >, Atomicity, WeightedProfileTransform, ExtractWeight, WeightedAdder< Arithmetic, Atomicity > >
static std::pair< unsigned long, Arithmetic >	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Detailed Description

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

WeightedCountAccumulator.

A WeightedCountAccumulator is an Accumulator storing the number of provided values, as well as the weighted version of it, aka. the sum of weights. It takes a pair (valueTuple, weight) as input

See also

Gaudi::Accumulators for detailed documentation

Definition at line 161 of file StaticHistogram.h.

Member Typedef Documentation

Base

template<atomicity Atomicity, typename Arithmetic>

using Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >::Base

Initial value:

GenericAccumulator<std::pair<Arithmetic, Arithmetic>, std::pair<unsigned long, Arithmetic>, Atomicity,
                                   WeightedProfileTransform, ExtractWeight, WeightedAdder<Arithmetic, Atomicity>>

Definition at line 164 of file StaticHistogram.h.

Member Function Documentation

nEntries()

template<atomicity Atomicity, typename Arithmetic>

unsigned long Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >::nEntries ( ) const

inline

Definition at line 173 of file StaticHistogram.h.

{ return this->rawValue().first; }

operator+=() [1/2]

template<atomicity Atomicity, typename Arithmetic>

WeightedCountAccumulator Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >::operator+= ( const Arithmetic weight )

inline

overload of operator+= to be able to only give weight and no value

Definition at line 169 of file StaticHistogram.h.

                                                                 {
      *this += { 1ul, weight };
      return *this;
    }

operator+=() [2/2]

template<atomicity Atomicity, typename Arithmetic>

GenericAccumulator Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, std::pair< unsigned long, Arithmetic >, Atomicity, WeightedProfileTransform, ExtractWeight, WeightedAdder< Arithmetic, Atomicity > >::operator+= ( const InputType by )

inline

Definition at line 489 of file Accumulators.h.

                                                      {
      ValueHandler::merge( m_value, InputTransform{}( by ) );
      return *this;
    }

sumOfWeights()

template<atomicity Atomicity, typename Arithmetic>

Arithmetic Gaudi::Accumulators::WeightedCountAccumulator< Atomicity, Arithmetic >::sumOfWeights ( ) const

inline

Definition at line 174 of file StaticHistogram.h.

{ return this->rawValue().second; }

---

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

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