A counter dealing with binomial data. More...

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

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

[legend]

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

[legend]

Public Member Functions
template<typename OWNER >
	BinomialCounter (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

template<typename stream >
stream &	printImpl (stream &o, std::string_view tag) const

std::ostream &	print (std::ostream &o, std::string_view tag) const override
	prints the counter to a stream in table format, with the given tag More...

MsgStream &	print (MsgStream &o, std::string_view tag) 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, BinomialAccumulator, 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

std::string	toString () const
	get a string representation More...

Public Member Functions inherited from Gaudi::Accumulators::BinomialAccumulator< Atomicity, Args... >
unsigned long	nEntries () const

auto	efficiency () const

auto	eff () const

auto	efficiencyErr () const

auto	effErr () const

BinomialAccumulator &	operator+= (binomial_t b)

Public Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< bool, Atomicity, bool, TrueAccumulator, FalseAccumulator >
constexpr	AccumulatorSet ()=default

	AccumulatorSet (construct_empty_t, const AccumulatorSet< bool, ato, InputType, TrueAccumulator ... > &)
	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< bool, Ato, InputType, TrueAccumulator ... > &other)

void	operator+ (AccumulatorSet< bool, Ato, InputType, TrueAccumulator ... > &&other)

Public Member Functions inherited from Gaudi::Accumulators::TrueAccumulator< Atomicity, bool >
unsigned long	nTrueEntries () const

Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, TrueTo1 >
	GenericAccumulator ()=default

	GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, unsigned long, ato, TrueTo1, 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)

GenericAccumulator &	operator= (const GenericAccumulator &other)

OutputType	value () const

void	reset ()

void	mergeAndReset (GenericAccumulator< InputType, unsigned long, ato, TrueTo1, Identity, VH > &other)

void	operator+ (GenericAccumulator< InputType, unsigned long, ato, TrueTo1, Identity, VH > &&other)

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

Static Public Attributes
static const std::string	typeString

Static Public Attributes inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, BinomialAccumulator, double >
static const std::string	typeString

Friends
void	reset (BinomialCounter &c)

void	mergeAndReset (BinomialCounter &c, BinomialCounter &o)

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

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

Public Types inherited from Gaudi::Accumulators::AccumulatorSet< bool, Atomicity, bool, TrueAccumulator, FalseAccumulator >
using	InputType = bool

using	OutputType = std::tuple< typename TrueAccumulator< Atomicity, bool >::OutputType... >

using	InternalType = std::tuple< typename TrueAccumulator< Atomicity, bool >::InternalType... >

using	JSONStringEntriesType = std::tuple< typename TrueAccumulator< Atomicity, bool >::JSONStringEntriesType... >

Public Types inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, TrueTo1 >
using	InputType = bool

using	OutputType = std::decay_t< std::invoke_result_t< Identity, unsigned long > >

using	InternalType = unsigned long

using	JSONStringEntriesType = std::string

Protected Member Functions inherited from Gaudi::Accumulators::BufferableCounter< atomicity::full, BinomialAccumulator, double >
	BufferableCounter (OWNER *o, std::string const &name, SELF &self, CARGS... args)

Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< bool, Atomicity, bool, TrueAccumulator, FalseAccumulator >
	AccumulatorSet (const InternalType &t)

void	reset (const InternalType &t)

Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, TrueTo1 >
	GenericAccumulator (unsigned long in)

void	reset (unsigned long in)

auto	rawValue () const

Static Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< bool, Atomicity, bool, TrueAccumulator, FalseAccumulator >
static InternalType	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, TrueTo1 >
static unsigned long	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Detailed Description

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

A counter dealing with binomial data.

See also: Gaudi::Accumulators for detailed documentation

Definition at line 1098 of file Accumulators.h.

Constructor & Destructor Documentation

◆ BinomialCounter()

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

template<typename OWNER >

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

inline

Definition at line 1103 of file Accumulators.h.

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

Member Function Documentation

◆ fromJSON()

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

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

inlinestatic

Definition at line 1140 of file Accumulators.h.

                                                              {
       return BinomialAccumulator<Atomicity, Arithmetic>::extractJSONData( j, { "nTrueEntries", "nFalseEntries" } );
     }

◆ print() [1/4]

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

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

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1117 of file Accumulators.h.

1117 { return printImpl( o, tableFormat ); }

◆ print() [2/4]

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

MsgStream& Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >::print	(	MsgStream &	o,
		std::string_view	tag
	)		const

inlineoverridevirtual

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 1127 of file Accumulators.h.

1127 { return printImpl( o, tag ); }

◆ print() [3/4]

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

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

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1114 of file Accumulators.h.

                                                                                 {
       return printImpl( o, tableFormat );
     }

◆ print() [4/4]

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

std::ostream& Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >::print	(	std::ostream &	o,
		std::string_view	tag
	)		const

inlineoverridevirtual

prints the counter to a stream in table format, with the given tag

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 1126 of file Accumulators.h.

1126 { return printImpl( o, tag ); }

◆ printImpl() [1/2]

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

template<typename stream >

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

inline

Definition at line 1107 of file Accumulators.h.

                                                            {
       auto fmt = ( tableFormat ? "|%|10d| |%|11.5g| |(%|#9.7g| +- %|-#8.7g|)%% |"
                                : "#=%|-7lu| Sum=%|-11.5g| Eff=|(%|#9.7g| +- %|-#8.6g|)%%|" );
       return o << boost::format{ fmt } % this->nEntries() % this->nTrueEntries() % ( this->efficiency() * 100 ) %
                       ( this->efficiencyErr() * 100 );
     }

◆ printImpl() [2/2]

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

template<typename stream >

stream& Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >::printImpl	(	stream &	o,
		std::string_view	tag
	)		const

inline

Definition at line 1120 of file Accumulators.h.

                                                              {
       // override default print to add a '*' in from of the name
       o << boost::format{ " |*%|-48.48s|%|50t|" } % ( std::string{ "\"" }.append( tag ).append( "\"" ) );
       return print( o, true );
     }

◆ toBePrinted()

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

bool Gaudi::Accumulators::BinomialCounter< 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 1128 of file Accumulators.h.

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

Friends And Related Function Documentation

◆ mergeAndReset

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

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

friend

Definition at line 1130 of file Accumulators.h.

1130 { c.mergeAndReset( o ); }

◆ reset

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

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

friend

Definition at line 1129 of file Accumulators.h.

1129 { c.reset(); }

◆ to_json

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

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

friend

Definition at line 1131 of file Accumulators.h.

                                                                        {
       j = { { "type", c.typeString },
               { "empty", c.nEntries() == 0 },
               { "nEntries", c.nTrueEntries() + c.nFalseEntries() },
               { "nTrueEntries", c.nTrueEntries() },
               { "nFalseEntries", c.nFalseEntries() },
               { "efficiency", c.efficiency() },
               { "efficiencyErr", c.efficiencyErr() } };
     }

Member Data Documentation

◆ typeString

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

const std::string Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >::typeString

inlinestatic

Initial value:

{ std::string{ "counter:BinomialCounter:" } +

typeid( Arithmetic ).name() }

Definition at line 1099 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::BinomialCounter< Arithmetic, Atomicity >

Constructor & Destructor Documentation

◆ BinomialCounter()

Member Function Documentation

◆ fromJSON()

◆ print() [1/4]

◆ print() [2/4]

◆ print() [3/4]

◆ print() [4/4]

◆ printImpl() [1/2]

◆ printImpl() [2/2]

◆ 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::BinomialCounter< Arithmetic, Atomicity >