backward compatible StatEntity class. More...

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

Inheritance diagram for StatEntity:

[legend]

Collaboration diagram for StatEntity:

[legend]

Public Types
using	AccParent = Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >

using	BinomialAccParent = Gaudi::Accumulators::BinomialAccumulator< Gaudi::Accumulators::atomicity::full, double >

Public Types inherited from Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >
using	InputType = double

using	OutputType = std::tuple< typename Gaudi::Accumulators::StatAccumulator< Atomicity, double >::OutputType... >

using	InternalType = std::tuple< typename Gaudi::Accumulators::StatAccumulator< Atomicity, double >::InternalType... >

using	JSONStringEntriesType = std::tuple< typename Gaudi::Accumulators::StatAccumulator< Atomicity, double >::JSONStringEntriesType... >

Public Types inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, InputTypeT, Bases >
using	InputType = InputTypeT

using	OutputType = std::tuple< typename Bases< Atomicity, Arithmetic >::OutputType... >

using	InternalType = std::tuple< typename Bases< Atomicity, Arithmetic >::InternalType... >

using	JSONStringEntriesType = std::tuple< typename Bases< Atomicity, Arithmetic >::JSONStringEntriesType... >

Public Member Functions
	StatEntity ()=default
	the constructor with automatic registration in the owner's counter map More...

	StatEntity (const unsigned long entries, const double flag, const double flag2, const double minFlag, const double maxFlag)

void	operator= (double by)

StatEntity &	operator-= (double by)

StatEntity &	operator++ ()

StatEntity	operator++ (int)

StatEntity &	operator-- ()

StatEntity	operator-- (int)

bool	operator< (const StatEntity &se) const

StatEntity &	operator+= (double by)

StatEntity &	operator+= (StatEntity by)

unsigned long	add (const double v)

unsigned long	addFlag (const double v)

double	Sum () const

double	Mean () const

double	MeanErr () const

double	rms () const

double	Rms () const

double	RMS () const

double	Eff () const

double	Min () const

double	Max () const

double	flag () const

double	flag2 () const

double	flagMean () const

double	flagRMS () const

double	flagMeanErr () const

double	flagMin () const

double	flagMax () const

template<typename stream >
stream &	printFormattedImpl (stream &o, const std::string &format) const

std::ostream &	printFormatted (std::ostream &o, const std::string &format) const

MsgStream &	printFormatted (MsgStream &o, const std::string &format) const

template<typename stream >
stream &	printImpl (stream &o, bool tableFormat, std::string_view name, bool flag, std::string_view fmtHead) const

std::ostream &	print (std::ostream &o, bool tableFormat, std::string_view name, bool flag=true, std::string_view fmtHead="%\|-48.48s\|%\|27t\|") const

MsgStream &	print (MsgStream &o, bool tableFormat, std::string_view name, bool flag=true, std::string_view fmtHead="%\|-48.48s\|%\|27t\|") const

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

virtual MsgStream &	print (MsgStream &o, std::string_view tag) const override

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

std::string	toString () const

std::ostream &	fillStream (std::ostream &o) const

MsgStream &	fillStream (MsgStream &o) const

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 bool	toBePrinted () const
	hint whether we should print that counter or not. More...

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

Public Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >
constexpr	AccumulatorSet ()=default

	AccumulatorSet (construct_empty_t, const AccumulatorSet< double, ato, InputType, Gaudi::Accumulators::StatAccumulator ... > &)
	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< double, Ato, InputType, Gaudi::Accumulators::StatAccumulator ... > &other)

void	operator+ (AccumulatorSet< double, Ato, InputType, Gaudi::Accumulators::StatAccumulator ... > &&other)

Public Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, InputTypeT, Bases >
constexpr	AccumulatorSet ()=default

template<atomicity ato>
	AccumulatorSet (construct_empty_t, const AccumulatorSet< Arithmetic, ato, InputType, Bases... > &)
	constructor of an empty AccumulatorSet, copying the (non existent) config from another GenericAccumulator More...

AccumulatorSet &	operator+= (const InputType by)

OutputType	value () const

void	reset ()

template<atomicity Ato>
void	mergeAndReset (AccumulatorSet< Arithmetic, Ato, InputType, Bases... > &other)

template<atomicity Ato>
void	operator+ (AccumulatorSet< Arithmetic, Ato, InputType, Bases... > &&other)

Static Public Member Functions
static bool	effCounter (std::string_view name)

static StatEntity	fromJSON (const nlohmann::json &j)

Static Public Attributes
static const std::string	typeString { "statentity" }

Static Private Member Functions
static constexpr bool	essentiallyEqual (double const a, double const b)

Friends
void	reset (StatEntity &s)

void	to_json (nlohmann::json &j, StatEntity const &s)
	Basic JSON export for Gaudi::Monitoring::Hub support. More...

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >
	AccumulatorSet (const InternalType &t)

void	reset (const InternalType &t)

Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, InputTypeT, Bases >
	AccumulatorSet (const InternalType &t)

void	reset (const InternalType &t)

Static Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >
static InternalType	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

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

Detailed Description

backward compatible StatEntity class.

Should not be used. Only here for backward compatibility

Definition at line 20 of file StatEntity.h.

Member Typedef Documentation

◆ AccParent

using StatEntity::AccParent = Gaudi::Accumulators::AccumulatorSet<double, Gaudi::Accumulators::atomicity::full, double, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator>

Definition at line 26 of file StatEntity.h.

◆ BinomialAccParent

using StatEntity::BinomialAccParent = Gaudi::Accumulators::BinomialAccumulator<Gaudi::Accumulators::atomicity::full, double>

Definition at line 29 of file StatEntity.h.

Constructor & Destructor Documentation

◆ StatEntity() [1/2]

StatEntity::StatEntity ( )

default

the constructor with automatic registration in the owner's counter map

◆ StatEntity() [2/2]

StatEntity::StatEntity	(	const unsigned long	entries,
		const double	flag,
		const double	flag2,
		const double	minFlag,
		const double	maxFlag
	)

inline

Definition at line 34 of file StatEntity.h.

                                      {
     reset( std::make_tuple(
         std::make_tuple( std::make_tuple( std::make_tuple( entries, flag ), flag2 ), minFlag, maxFlag ),
         std::make_tuple( 0, 0 ) ) );
   }

Member Function Documentation

◆ add()

unsigned long StatEntity::add ( const double v )

inline

Definition at line 80 of file StatEntity.h.

                                       {
     *this += v;
     return nEntries();
   }

◆ addFlag()

unsigned long StatEntity::addFlag ( const double v )

inline

Definition at line 84 of file StatEntity.h.

84 { return add( v ); }

◆ Eff()

double StatEntity::Eff ( ) const

inline

Definition at line 92 of file StatEntity.h.

92 { return eff(); } // get efficiency

◆ effCounter()

static bool StatEntity::effCounter ( std::string_view name )

inlinestatic

Definition at line 103 of file StatEntity.h.

                                                 {
     using boost::algorithm::icontains;
     return icontains( name, "eff" ) || icontains( name, "acc" ) || icontains( name, "filt" ) ||
            icontains( name, "fltr" ) || icontains( name, "pass" );
   }

◆ essentiallyEqual()

static constexpr bool StatEntity::essentiallyEqual	(	double const	a,
		double const	b
	)

inlinestaticconstexprprivate

Definition at line 197 of file StatEntity.h.

                                                                            {
     return std::abs( a - b ) <= std::max( std::abs( a ), std::abs( b ) ) * std::numeric_limits<double>::epsilon();
   }

◆ fillStream() [1/2]

MsgStream& StatEntity::fillStream ( MsgStream & o ) const

inline

Definition at line 186 of file StatEntity.h.

186 { return print( o ); }

◆ fillStream() [2/2]

std::ostream& StatEntity::fillStream ( std::ostream & o ) const

inline

Definition at line 185 of file StatEntity.h.

185 { return print( o ); }

◆ flag()

double StatEntity::flag ( ) const

inline

Definition at line 96 of file StatEntity.h.

96 { return sum(); }

◆ flag2()

double StatEntity::flag2 ( ) const

inline

Definition at line 97 of file StatEntity.h.

97 { return sum2(); }

◆ flagMax()

double StatEntity::flagMax ( ) const

inline

Definition at line 102 of file StatEntity.h.

102 { return max(); }

◆ flagMean()

double StatEntity::flagMean ( ) const

inline

Definition at line 98 of file StatEntity.h.

98 { return mean(); }

◆ flagMeanErr()

double StatEntity::flagMeanErr ( ) const

inline

Definition at line 100 of file StatEntity.h.

100 { return meanErr(); }

◆ flagMin()

double StatEntity::flagMin ( ) const

inline

Definition at line 101 of file StatEntity.h.

101 { return min(); }

◆ flagRMS()

double StatEntity::flagRMS ( ) const

inline

Definition at line 99 of file StatEntity.h.

99 { return standard_deviation(); }

◆ fromJSON()

static StatEntity StatEntity::fromJSON ( const nlohmann::json & j )

inlinestatic

Definition at line 189 of file StatEntity.h.

                                                       {
     StatEntity res;
     res.reset( AccParent::extractJSONData(
         j, { { { { "nEntries", "sum" }, "sum2" }, "min", "max" }, { "nTrueEntries", "nFalseEntries" } } ) );
     return res;
   }

◆ Max()

double StatEntity::Max ( ) const

inline

Definition at line 94 of file StatEntity.h.

94 { return max(); } // get maximal value

◆ Mean()

double StatEntity::Mean ( ) const

inline

Definition at line 87 of file StatEntity.h.

87 { return mean(); } // get mean

◆ MeanErr()

double StatEntity::MeanErr ( ) const

inline

Definition at line 88 of file StatEntity.h.

88 { return meanErr(); } // get error in mean

◆ Min()

double StatEntity::Min ( ) const

inline

Definition at line 93 of file StatEntity.h.

93 { return min(); } // get minimal value

◆ operator++() [1/2]

StatEntity& StatEntity::operator++ ( )

inline

Definition at line 49 of file StatEntity.h.

                            {
     ( *this ) += 1.0;
     return *this;
   }

◆ operator++() [2/2]

StatEntity StatEntity::operator++ ( int )

inline

Definition at line 53 of file StatEntity.h.

                                {
     auto copy = *this;
     ++( *this );
     return copy;
   }

◆ operator+=() [1/2]

StatEntity& StatEntity::operator+= ( double by )

inline

Definition at line 72 of file StatEntity.h.

                                       {
     this->AccumulatorSet::operator+=( by );
     return *this;
   }

◆ operator+=() [2/2]

StatEntity& StatEntity::operator+= ( StatEntity by )

inline

Definition at line 76 of file StatEntity.h.

                                           {
     mergeAndReset( by );
     return *this;
   }

◆ operator--() [1/2]

StatEntity& StatEntity::operator-- ( )

inline

Definition at line 58 of file StatEntity.h.

                            {
     ( *this ) += -1.0;
     return *this;
   }

◆ operator--() [2/2]

StatEntity StatEntity::operator-- ( int )

inline

Definition at line 62 of file StatEntity.h.

                                {
     auto copy = *this;
     --( *this );
     return copy;
   }

◆ operator-=()

StatEntity& StatEntity::operator-= ( double by )

inline

Definition at line 45 of file StatEntity.h.

                                       {
     ( *this ) += ( -by );
     return *this;
   }

◆ operator<()

bool StatEntity::operator< ( const StatEntity & se ) const

inline

Definition at line 67 of file StatEntity.h.

                                                {
     return std::make_tuple( nEntries(), sum(), min(), max(), sum2() ) <
            std::make_tuple( se.nEntries(), se.sum(), se.min(), se.max(), se.sum2() );
   };

◆ operator=()

void StatEntity::operator= ( double by )

inline

Definition at line 41 of file StatEntity.h.

                                      {
     this->reset();
     ( *this ) += by;
   }

◆ print() [1/6]

MsgStream& StatEntity::print	(	MsgStream &	o,
		bool	tableFormat,
		std::string_view	name,
		bool	flag = `true`,
		std::string_view	fmtHead = `"%\|-48.48s\|%\|27t\|"`
	)		const

inline

Definition at line 164 of file StatEntity.h.

                                                                         {
     return printImpl( o, tableFormat, name, flag, fmtHead );
   }

◆ print() [2/6]

MsgStream& StatEntity::print	(	MsgStream &	o,
		bool	tableFormat = `false`
	)		const

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 176 of file StatEntity.h.

                                                                             {
     std::string emptyName;
     return print( o, tableFormat, emptyName, true );
   }

◆ print() [3/6]

virtual MsgStream& StatEntity::print	(	MsgStream &	o,
		std::string_view	tag
	)		const

inlineoverridevirtual

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 171 of file StatEntity.h.

171 { return print( o, true, tag, true ); }

◆ print() [4/6]

std::ostream& StatEntity::print	(	std::ostream &	o,
		bool	tableFormat,
		std::string_view	name,
		bool	flag = `true`,
		std::string_view	fmtHead = `"%\|-48.48s\|%\|27t\|"`
	)		const

inline

Definition at line 160 of file StatEntity.h.

                                                                            {
     return printImpl( o, tableFormat, name, flag, fmtHead );
   }

◆ print() [5/6]

std::ostream& StatEntity::print	(	std::ostream &	,
		bool	tableFormat = `false`
	)		const

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 172 of file StatEntity.h.

                                                                                    {
     std::string emptyName;
     return print( o, tableFormat, emptyName, true );
   }

◆ print() [6/6]

virtual std::ostream& StatEntity::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 168 of file StatEntity.h.

                                                                                 {
     return print( o, true, tag, true );
   }

◆ printFormatted() [1/2]

MsgStream& StatEntity::printFormatted	(	MsgStream &	o,
		const std::string &	format
	)		const

inline

Definition at line 117 of file StatEntity.h.

117 { return printFormattedImpl( o, format ); }

◆ printFormatted() [2/2]

std::ostream& StatEntity::printFormatted	(	std::ostream &	o,
		const std::string &	format
	)		const

inline

Definition at line 114 of file StatEntity.h.

                                                                              {
     return printFormattedImpl( o, format );
   }

◆ printFormattedImpl()

template<typename stream >

stream& StatEntity::printFormattedImpl	(	stream &	o,
		const std::string &	format
	)		const

inline

Definition at line 109 of file StatEntity.h.

                                                                          {
     boost::format fmt{ format };
     fmt % nEntries() % sum() % mean() % standard_deviation() % min() % max();
     return o << fmt.str();
   }

◆ printImpl()

template<typename stream >

stream& StatEntity::printImpl	(	stream &	o,
		bool	tableFormat,
		std::string_view	name,
		bool	flag,
		std::string_view	fmtHead
	)		const

inline

Definition at line 120 of file StatEntity.h.

                                                                                                                  {
     if ( flag && effCounter( name ) && 0 <= eff() && 0 <= effErr() && sum() <= nEntries() &&
          ( essentiallyEqual( min(), 0 ) || essentiallyEqual( min(), 1 ) ) &&
          ( essentiallyEqual( max(), 0 ) || essentiallyEqual( max(), 1 ) ) ) {
       // efficiency printing
       if ( tableFormat ) {
         if ( name.empty() ) {
           constexpr auto fmt = "|%|10d| |%|11.5g| |(%|#9.7g| +- %|-#8.7g|)%%|   -------   |   -------   |";
           return o << boost::format{ fmt } % BinomialAccParent::nEntries() % sum() % ( efficiency() * 100 ) %
                           ( efficiencyErr() * 100 );
         } else {
           auto fmt = std::string{ " |*" }.append( fmtHead ).append(
               "|%|10d| |%|11.5g| |(%|#9.7g| +- %|-#8.7g|)%%|   -------   |   -------   |" );
           return o << boost::format{ fmt } % ( std::string{ "\"" }.append( name ).append( "\"" ) ) %
                           BinomialAccParent::nEntries() % sum() % ( efficiency() * 100 ) % ( efficiencyErr() * 100 );
         }
       } else {
         constexpr auto fmt = "#=%|-7lu| Sum=%|-11.5g| Eff=|(%|#9.7g| +- %|-#8.6g|)%%|";
         return o << boost::format{ fmt } % BinomialAccParent::nEntries() % sum() % ( efficiency() * 100 ) %
                         ( efficiencyErr() * 100 );
       }
     } else {
       // Standard printing
       if ( tableFormat ) {
         if ( name.empty() ) {
           constexpr auto fmt = "|%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |";
           return o << boost::format{ fmt } % nEntries() % sum() % mean() % standard_deviation() % min() % max();
  
         } else {
           auto fmt = std::string{ " | " }.append( fmtHead ).append(
               "|%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |" );
           return o << boost::format{ fmt } % std::string{ "\"" }.append( name ).append( "\"" ) % nEntries() % sum() %
                           mean() % standard_deviation() % min() % max();
         }
       } else {
         constexpr auto fmt = "#=%|-7lu| Sum=%|-11.5g| Mean=%|#10.4g| +- %|-#10.5g| Min/Max=%|#10.4g|/%|-#10.4g|";
         return o << boost::format{ fmt } % nEntries() % sum() % mean() % standard_deviation() % min() % max();
       }
     }
   }

◆ rms()

double StatEntity::rms ( ) const

inline

Definition at line 89 of file StatEntity.h.

89 { return standard_deviation(); } // get rms

◆ Rms()

double StatEntity::Rms ( ) const

inline

Definition at line 90 of file StatEntity.h.

90 { return standard_deviation(); } // get rms

◆ RMS()

double StatEntity::RMS ( ) const

inline

Definition at line 91 of file StatEntity.h.

91 { return standard_deviation(); } // get rms

◆ Sum()

double StatEntity::Sum ( ) const

inline

Definition at line 86 of file StatEntity.h.

86 { return sum(); } // get sum

◆ toString()

std::string StatEntity::toString ( ) const

inline

Definition at line 180 of file StatEntity.h.

                              {
     std::ostringstream ost;
     print( ost );
     return ost.str();
   }

Friends And Related Function Documentation

◆ reset

void reset ( StatEntity & s )

friend

Definition at line 40 of file StatEntity.h.

40 { s.reset(); }

◆ to_json

void to_json	(	nlohmann::json &	j,
		StatEntity const &	s
	)

friend

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

Definition at line 14 of file StatEntity.cpp.

                                                      {
   j = { { "type", s.typeString },
         { "empty", s.nEntries() == 0 },
         { "nEntries", s.nEntries() },
         { "sum", s.sum() },
         { "mean", s.mean() },
         { "sum2", s.sum2() },
         { "standard_deviation", s.standard_deviation() },
         { "min", s.min() },
         { "max", s.max() },
         { "nTrueEntries", s.nTrueEntries() },
         { "nFalseEntries", s.nFalseEntries() },
         { "efficiency", s.efficiency() },
         { "efficiencyErr", s.efficiencyErr() } };
 }

Member Data Documentation

◆ typeString

const std::string StatEntity::typeString { "statentity" }

inlinestatic

Definition at line 25 of file StatEntity.h.

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

GaudiKernel/include/GaudiKernel/StatEntity.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AccParent

◆ BinomialAccParent

Constructor & Destructor Documentation

◆ StatEntity() [1/2]

◆ StatEntity() [2/2]

Member Function Documentation

◆ add()

◆ addFlag()

◆ Eff()

◆ effCounter()

◆ essentiallyEqual()

◆ fillStream() [1/2]

◆ fillStream() [2/2]

◆ flag()

◆ flag2()

◆ flagMax()

◆ flagMean()

◆ flagMeanErr()

◆ flagMin()

◆ flagRMS()

◆ fromJSON()

◆ Max()

◆ Mean()

◆ MeanErr()

◆ Min()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator<()

◆ operator=()

◆ print() [1/6]

◆ print() [2/6]

◆ print() [3/6]

◆ print() [4/6]

◆ print() [5/6]

◆ print() [6/6]

◆ printFormatted() [1/2]

◆ printFormatted() [2/2]

◆ printFormattedImpl()

◆ printImpl()

◆ rms()

◆ Rms()

◆ RMS()

◆ Sum()

◆ toString()

Friends And Related Function Documentation

◆ reset

◆ to_json

Member Data Documentation

◆ typeString