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

A counter aiming at computing average and sum2 / variance / standard deviation. More...

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

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

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

Public Member Functions
template<typename OWNER >
	SigmaCounter (OWNER *o, std::string const &name)
template<typename stream >
stream &	printImpl (stream &o, bool tableFormat) const
std::ostream &	print (std::ostream &o, bool tableFormat=false) const override
	prints the counter to a stream More...
MsgStream &	print (MsgStream &o, bool tableFormat=false) const override
bool	toBePrinted () const override
	hint whether we should print that counter or not. More...
virtual nlohmann::json	toJSON () const override
	Basic JSON export for Gaudi::Monitoring::Hub support. More...
Public Member Functions inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, SigmaAccumulator, double >
	BufferableCounter ()=default
	BufferableCounter (OWNER *o, std::string const &name)
	BufferableCounter (BufferableCounter const &)=delete
Buffer< SigmaAccumulator, Atomicity, Args... >	buffer ()
BufferableCounter &	operator= (BufferableCounter const &)=delete
	~BufferableCounter ()
Public Member Functions inherited from Gaudi::Accumulators::PrintableCounter
	PrintableCounter ()=default
virtual	~PrintableCounter ()=default
	destructor More...
template<typename stream >
stream &	printImpl (stream &s, std::string_view tag) const
virtual std::ostream &	print (std::ostream &o, std::string_view tag) const
	prints the counter to a stream in table format, with the given tag More...
virtual MsgStream &	print (MsgStream &o, std::string_view tag) const
std::string	toString () const
	get a string representation More...
Public Member Functions inherited from Gaudi::Accumulators::SigmaAccumulatorBase< Atomicity, Arithmetic, AvgAcc, SquareAcc >
template<typename Result = fp_result_type<Arithmetic>>
auto	biased_sample_variance () const
template<typename Result = fp_result_type<Arithmetic>>
auto	unbiased_sample_variance () const
template<typename Result = fp_result_type<Arithmetic>>
auto	standard_deviation () const
Arithmetic	rms () const
template<typename Result = fp_result_type<Arithmetic>>
auto	meanErr () const
Public Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, AvgAcc< Atomicity, Arithmetic >::InputType, AvgAcc, SquareAcc >
constexpr	AccumulatorSet ()=default
	AccumulatorSet (construct_empty_t, const AccumulatorSet< Arithmetic, ato, InputType, AvgAcc ... > &)
	constructor of an empty AccumulatorSet, copying the (non existent) config from another GenericAccumulator More...
AccumulatorSet &	operator+= (const InputType by)
OutputType	value () const
void	reset ()
void	mergeAndReset (AccumulatorSet< Arithmetic, Ato, InputType, AvgAcc ... > &&other)
void	operator+ (AccumulatorSet< Arithmetic, Ato, InputType, AvgAcc ... > &&other)

Static Public Member Functions
static SigmaCounter	fromJSON (const nlohmann::json &j)

Static Public Attributes
static const std::string	typeString { std::string{ "counter:SigmaCounter:" } + typeid( Arithmetic ).name() }
Static Public Attributes inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, SigmaAccumulator, double >
static const std::string	typeString

Additional Inherited Members
Public Types inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, AvgAcc< Atomicity, Arithmetic >::InputType, AvgAcc, SquareAcc >
using	InputType = AvgAcc< Atomicity, Arithmetic >::InputType
using	OutputType = std::tuple< typename AvgAcc< Atomicity, Arithmetic >::OutputType... >
using	InternalType = std::tuple< typename AvgAcc< Atomicity, Arithmetic >::InternalType... >
using	JSONStringEntriesType = std::tuple< typename AvgAcc< Atomicity, Arithmetic >::JSONStringEntriesType... >
Protected Member Functions inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, SigmaAccumulator, double >
	BufferableCounter (OWNER *o, std::string const &name, SELF &self, CARGS... args)
Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, AvgAcc< Atomicity, Arithmetic >::InputType, AvgAcc, SquareAcc >
	AccumulatorSet (const InternalType &t)
void	reset (const InternalType &t)
Static Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, AvgAcc< Atomicity, Arithmetic >::InputType, AvgAcc, SquareAcc >
static InternalType	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Detailed Description

template<typename Arithmetic = double, atomicity Atomicity = atomicity::full>
struct Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >

A counter aiming at computing average and sum2 / variance / standard deviation.

See also

Gaudi::Accumulators for detailed documentation

Definition at line 983 of file Accumulators.h.

Constructor & Destructor Documentation

SigmaCounter()

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

template<typename OWNER >

Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::SigmaCounter ( OWNER *  o, std::string const &  name  )

inline

Definition at line 987 of file Accumulators.h.

        : BufferableCounter<Atomicity, SigmaAccumulator, Arithmetic>( o, name, *this ) {}

Member Function Documentation

fromJSON()

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

static SigmaCounter Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::fromJSON ( const nlohmann::json &  j )

inlinestatic

Definition at line 1012 of file Accumulators.h.

                                                          {
      return SigmaAccumulator<Atomicity, Arithmetic>::extractJSONData( j, { { "nEntries", "sum" }, "sum2" } );
    }

print() [1/2]

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

MsgStream& Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::print ( MsgStream &  o, bool  tableFormat = false  ) const

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1001 of file Accumulators.h.

{ return printImpl( o, tableFormat ); }

print() [2/2]

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

std::ostream& Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::print ( std::ostream &  , bool  tableFormat = false  ) const

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 998 of file Accumulators.h.

                                                                                {
      return printImpl( o, tableFormat );
    }

printImpl()

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

template<typename stream >

stream& Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::printImpl ( stream &  o, bool  tableFormat  ) const

inline

Definition at line 992 of file Accumulators.h.

                                                           {
      auto fmt = ( tableFormat ? "|%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |"
                               : "#=%|-7lu| Sum=%|-11.5g| Mean=%|#10.4g| +- %|-#10.5g|" );
      return o << boost::format{ fmt } % this->nEntries() % this->sum() % this->mean() % this->standard_deviation();
    }

toBePrinted()

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

bool Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::toBePrinted ( ) const

inlineoverridevirtual

hint whether we should print that counter or not.

Typically empty counters may not be printed

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 1002 of file Accumulators.h.

{ return this->nEntries() > 0; }

toJSON()

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

virtual nlohmann::json Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::toJSON ( ) const

inlineoverridevirtual

Basic JSON export for Gaudi::Monitoring::Hub support.

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1003 of file Accumulators.h.

                                                 {
      return { { "type", typeString },
               { "empty", this->nEntries() == 0 },
               { "nEntries", this->nEntries() },
               { "sum", this->sum() },
               { "mean", this->mean() },
               { "sum2", this->sum2() },
               { "standard_deviation", this->standard_deviation() } };
    }

Member Data Documentation

typeString

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

const std::string Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >::typeString { std::string{ "counter:SigmaCounter:" } + typeid( Arithmetic ).name() }

inlinestatic

Definition at line 984 of file Accumulators.h.

---

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

• GaudiKernel/include/Gaudi/Accumulators.h