StatEntity Class Reference

backward compatible StatEntity class. More...

#include <GaudiKernel/Counters.h>

Inheritance diagram for StatEntity:

Collaboration diagram for StatEntity:

Public Types
using	AccParent = Gaudi::Accumulators::AccumulatorSet< double, Gaudi::Accumulators::atomicity::full, Gaudi::Accumulators::StatAccumulator, Gaudi::Accumulators::BinomialAccumulator >
using	BinomialAccParent = Gaudi::Accumulators::BinomialAccumulator< double, Gaudi::Accumulators::atomicity::full >
Public Types inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, Bases >
using	InputType = Arithmetic
using	OutputType = std::tuple< typename Bases< Arithmetic, Atomicity >::OutputType... >

Public Member Functions
	StatEntity ()=default
	the constructor with automatic registration in the owner's counter map More...
template<class OWNER >
	StatEntity (OWNER *o, const std::string &tag)
	StatEntity (const unsigned long entries, const double flag, const double flag2, const double minFlag, const double maxFlag)
void	reset ()
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, const std::string &name, bool flag, std::string const &fmtHead) const
std::ostream &	print (std::ostream &o, bool tableFormat, const std::string &name, bool flag=true, std::string fmtHead="%|-48.48s|%|27t|") const
MsgStream &	print (MsgStream &o, bool tableFormat, const std::string &name, bool flag=true, std::string fmtHead="%|-48.48s|%|27t|") const
virtual std::ostream &	print (std::ostream &o, const std::string &tag) const override
	prints the counter to a stream in table format, with the given tag More...
virtual MsgStream &	print (MsgStream &o, const std::string &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
template<class OWNER >
	PrintableCounter (OWNER *o, const std::string &tag)
virtual	~PrintableCounter ()=default
	destructor More...
template<typename stream >
stream &	printImpl (stream &s, const std::string &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< Arithmetic, Atomicity, Bases >
constexpr	AccumulatorSet ()=default
AccumulatorSet &	operator+= (const InputType by)
OutputType	value () const
void	reset ()
template<atomicity Ato>
void	mergeAndReset (AccumulatorSet< Arithmetic, Ato, Bases... > &&other)

Static Public Member Functions
static bool	effCounter (const std::string &name)

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Accumulators::AccumulatorSet< Arithmetic, Atomicity, Bases >
void	reset (const std::tuple< typename Bases< Arithmetic, Atomicity >::OutputType... > &t)

Detailed Description

backward compatible StatEntity class.

Should not be used. Only here for backward compatibility

Definition at line 824 of file Counters.h.

Member Typedef Documentation

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

Definition at line 831 of file Counters.h.

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

Definition at line 832 of file Counters.h.

Constructor & Destructor Documentation

StatEntity::StatEntity ( )

default

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

template<class OWNER >

StatEntity::StatEntity ( OWNER *  o, const std::string &  tag  )

inline

Definition at line 838 of file Counters.h.

                                               {
    o->declareCounter( tag, *this );
  }

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

inline

Definition at line 841 of file Counters.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

unsigned long StatEntity::add ( const double  v )

inline

Definition at line 887 of file Counters.h.

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

unsigned long StatEntity::addFlag ( const double  v )

inline

Definition at line 891 of file Counters.h.

{ return add( v ); }

double StatEntity::Eff ( ) const

inline

Definition at line 899 of file Counters.h.

{ return eff(); }                // get efficiency

static bool StatEntity::effCounter ( const std::string &  name )

inlinestatic

Definition at line 910 of file Counters.h.

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

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

inline

Definition at line 992 of file Counters.h.

{ return print( o ); }

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

inline

Definition at line 993 of file Counters.h.

{ return print( o ); }

double StatEntity::flag ( ) const

inline

Definition at line 903 of file Counters.h.

{ return sum(); }

double StatEntity::flag2 ( ) const

inline

Definition at line 904 of file Counters.h.

{ return sum2(); }

double StatEntity::flagMax ( ) const

inline

Definition at line 909 of file Counters.h.

{ return max(); }

double StatEntity::flagMean ( ) const

inline

Definition at line 905 of file Counters.h.

{ return mean(); }

double StatEntity::flagMeanErr ( ) const

inline

Definition at line 907 of file Counters.h.

{ return meanErr(); }

double StatEntity::flagMin ( ) const

inline

Definition at line 908 of file Counters.h.

{ return min(); }

double StatEntity::flagRMS ( ) const

inline

Definition at line 906 of file Counters.h.

{ return standard_deviation(); }

double StatEntity::Max ( ) const

inline

Definition at line 901 of file Counters.h.

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

double StatEntity::Mean ( ) const

inline

Definition at line 894 of file Counters.h.

{ return mean(); }              // get mean

double StatEntity::MeanErr ( ) const

inline

Definition at line 895 of file Counters.h.

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

double StatEntity::Min ( ) const

inline

Definition at line 900 of file Counters.h.

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

StatEntity& StatEntity::operator++ ( )

inline

Definition at line 856 of file Counters.h.

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

StatEntity StatEntity::operator++ ( int  )

inline

Definition at line 860 of file Counters.h.

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

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

inline

Definition at line 879 of file Counters.h.

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

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

inline

Definition at line 883 of file Counters.h.

                                          {
    mergeAndReset( std::move( by ) );
    return *this;
  }

StatEntity& StatEntity::operator-- ( )

inline

Definition at line 865 of file Counters.h.

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

StatEntity StatEntity::operator-- ( int  )

inline

Definition at line 869 of file Counters.h.

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

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

inline

Definition at line 852 of file Counters.h.

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

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

inline

Definition at line 874 of file Counters.h.

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

void StatEntity::operator= ( double  by )

inline

Definition at line 848 of file Counters.h.

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

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

inline

Definition at line 965 of file Counters.h.

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

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

inline

Definition at line 969 of file Counters.h.

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

virtual std::ostream& StatEntity::print ( std::ostream &  o, const std::string &  tag  ) const

inlineoverridevirtual

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

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 973 of file Counters.h.

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

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

inlineoverridevirtual

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 976 of file Counters.h.

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

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

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 979 of file Counters.h.

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

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

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 983 of file Counters.h.

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

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

inline

Definition at line 921 of file Counters.h.

                                                                             {
    return printFormattedImpl( o, format );
  }

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

inline

Definition at line 924 of file Counters.h.

{ return printFormattedImpl( o, format ); }

template<typename stream >

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

inline

Definition at line 916 of file Counters.h.

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

template<typename stream >

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

inline

Definition at line 927 of file Counters.h.

                                                      {
    if ( flag && effCounter( name ) && 0 <= eff() && 0 <= effErr() && sum() <= nEntries() &&
         ( 0 == min() || 1 == min() ) && ( 0 == max() || 1 == max() ) ) {
      // 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 = " |*" + fmtHead + "|%|10d| |%|11.5g| |(%|#9.7g| +- %|-#8.7g|)%%|   -------   |   -------   |";
          return o << boost::format{fmt} % ( "\"" + name + "\"" ) % 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 = " | " + fmtHead + "|%|10d| |%|11.7g| |%|#11.5g| |%|#11.5g| |%|#12.5g| |%|#12.5g| |";
          return o << boost::format{fmt} % ( "\"" + name + "\"" ) % 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();
      }
    }
  }

void StatEntity::reset ( )

inline

Definition at line 847 of file Counters.h.

{ AccParent::reset(); }

double StatEntity::rms ( ) const

inline

Definition at line 896 of file Counters.h.

{ return standard_deviation(); } // get rms

double StatEntity::Rms ( ) const

inline

Definition at line 897 of file Counters.h.

{ return standard_deviation(); } // get rms

double StatEntity::RMS ( ) const

inline

Definition at line 898 of file Counters.h.

{ return standard_deviation(); } // get rms

double StatEntity::Sum ( ) const

inline

Definition at line 893 of file Counters.h.

{ return sum(); }                // get sum

std::string StatEntity::toString ( ) const

inline

Definition at line 987 of file Counters.h.

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

---

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

• GaudiKernel/GaudiKernel/Counters.h