The Gaudi Framework  master (594c33fa)
Gaudi::Accumulators::WeightedSumAccumulator< Atomicity, Arithmetic > Struct Template Reference

WeightedSumAccumulator. More...

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

Inheritance diagram for Gaudi::Accumulators::WeightedSumAccumulator< Atomicity, Arithmetic >:
Collaboration diagram for Gaudi::Accumulators::WeightedSumAccumulator< Atomicity, Arithmetic >:

Public Member Functions

Arithmetic sum () const
 
- Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, Arithmetic, Atomicity, WeightedProduct >
 GenericAccumulator ()=default
 
 GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, Arithmetic, ato, WeightedProduct, Identity, VH > &)
 constructor of an empty GenericAccumulator, copying the (non existent) config from another GenericAccumulator More...
 
 GenericAccumulator (std::in_place_t, Args &&... args)
 
 GenericAccumulator (const GenericAccumulator &other)
 
GenericAccumulator operator+= (const InputType by)
 
GenericAccumulatoroperator= (const GenericAccumulator &other)
 
OutputType value () const
 
void reset ()
 
void mergeAndReset (GenericAccumulator< InputType, Arithmetic, ato, WeightedProduct, Identity, VH > &other)
 
void operator+ (GenericAccumulator< InputType, Arithmetic, ato, WeightedProduct, Identity, VH > &&other)
 

Additional Inherited Members

- Public Types inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, Arithmetic, Atomicity, WeightedProduct >
using InputType = std::pair< Arithmetic, Arithmetic >
 
using OutputType = std::decay_t< std::result_of_t< Identity(Arithmetic)> >
 
using InternalType = Arithmetic
 
using JSONStringEntriesType = std::string
 
- Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, Arithmetic, Atomicity, WeightedProduct >
 GenericAccumulator (Arithmetic in)
 
void reset (Arithmetic in)
 
auto rawValue () const
 
- Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, Arithmetic, Atomicity, WeightedProduct >
static Arithmetic extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)
 

Detailed Description

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

WeightedSumAccumulator.

A WeightedSumAccumulator is an Accumulator storing a weighted sum of values. It takes a pair (valueTuple, weight) and basically sums the product of the last item othe 2 part of its in put pair : weight and value

See also
Gaudi::Accumulators for detailed documentation

Definition at line 112 of file Histogram.h.

Member Function Documentation

◆ sum()

template<atomicity Atomicity, typename Arithmetic >
Arithmetic Gaudi::Accumulators::WeightedSumAccumulator< Atomicity, Arithmetic >::sum ( ) const
inline

Definition at line 116 of file Histogram.h.

116 { return this->value(); }

The documentation for this struct was generated from the following file:
Gaudi::Accumulators::GenericAccumulator< std::pair< Arithmetic, Arithmetic >, Arithmetic, Atomicity, WeightedProduct >::value
OutputType value() const
Definition: Accumulators.h:501