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

[legend]

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

[legend]

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

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

BufferType	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

Friends
void	reset (SigmaCounter &c)

void	mergeAndReset (SigmaCounter &c, SigmaCounter &o)

void	to_json (nlohmann::json &j, SigmaCounter const &c)

Additional Inherited Members
Public Types inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, SigmaAccumulator, double >
using	BufferType = Buffer< SigmaAccumulator, Atomicity, Args... >

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 1025 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 1029 of file Accumulators.h.

1030 : 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 1056 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 1043 of file Accumulators.h.

1043 { 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 1040 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 1034 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 1044 of file Accumulators.h.

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

Friends And Related Function Documentation

◆ mergeAndReset

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

void mergeAndReset	(	SigmaCounter< Arithmetic, Atomicity > &	c,
		SigmaCounter< Arithmetic, Atomicity > &	o
	)

friend

Definition at line 1046 of file Accumulators.h.

1046 { c.mergeAndReset( o ); }

◆ reset

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

void reset ( SigmaCounter< Arithmetic, Atomicity > & c )

friend

Definition at line 1045 of file Accumulators.h.

1045 { c.reset(); }

◆ to_json

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

void to_json	(	nlohmann::json &	j,
		SigmaCounter< Arithmetic, Atomicity > const &	c
	)

friend

Definition at line 1047 of file Accumulators.h.

                                                                   {
       j = { { "type", c.typeString },
             { "empty", c.nEntries() == 0 },
             { "nEntries", c.nEntries() },
             { "sum", c.sum() },
             { "mean", c.mean() },
             { "sum2", c.sum2() },
             { "standard_deviation", c.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 1026 of file Accumulators.h.

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

GaudiKernel/include/Gaudi/Accumulators.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ SigmaCounter()

Member Function Documentation

◆ fromJSON()

◆ print() [1/2]

◆ print() [2/2]

◆ printImpl()

◆ toBePrinted()

Friends And Related Function Documentation

◆ mergeAndReset

◆ reset

◆ to_json

Member Data Documentation

◆ typeString

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