StatEntity Class Reference

backward compatible StatEntity class. More...

#include <GaudiKernel/StatEntity.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 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, 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
virtual MsgStream &	print (MsgStream &o, std::string_view tag) const override
std::ostream &	print (std::ostream &o, bool tableFormat=false) const override
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

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

Detailed Description

backward compatible StatEntity class.

Should not be used. Only here for backward compatibility

Definition at line 18 of file StatEntity.h.

Member Typedef Documentation

AccParent

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

Definition at line 25 of file StatEntity.h.

BinomialAccParent

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

Definition at line 26 of file StatEntity.h.

Constructor & Destructor Documentation

StatEntity() [1/3]

StatEntity::StatEntity ( )

default

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

StatEntity() [2/3]

template<class OWNER >

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

inline

Definition at line 32 of file StatEntity.h.

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

StatEntity() [3/3]

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

inline

Definition at line 35 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 81 of file StatEntity.h.

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

addFlag()

unsigned long StatEntity::addFlag ( const double  v )

inline

Definition at line 85 of file StatEntity.h.

{ return add( v ); }

Eff()

double StatEntity::Eff ( ) const

inline

Definition at line 93 of file StatEntity.h.

{ return eff(); }                // get efficiency

effCounter()

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

inlinestatic

Definition at line 104 of file StatEntity.h.

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

fillStream() [1/2]

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

inline

Definition at line 185 of file StatEntity.h.

{ return print( o ); }

fillStream() [2/2]

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

inline

Definition at line 186 of file StatEntity.h.

{ return print( o ); }

flag()

double StatEntity::flag ( ) const

inline

Definition at line 97 of file StatEntity.h.

{ return sum(); }

flag2()

double StatEntity::flag2 ( ) const

inline

Definition at line 98 of file StatEntity.h.

{ return sum2(); }

flagMax()

double StatEntity::flagMax ( ) const

inline

Definition at line 103 of file StatEntity.h.

{ return max(); }

flagMean()

double StatEntity::flagMean ( ) const

inline

Definition at line 99 of file StatEntity.h.

{ return mean(); }

flagMeanErr()

double StatEntity::flagMeanErr ( ) const

inline

Definition at line 101 of file StatEntity.h.

{ return meanErr(); }

flagMin()

double StatEntity::flagMin ( ) const

inline

Definition at line 102 of file StatEntity.h.

{ return min(); }

flagRMS()

double StatEntity::flagRMS ( ) const

inline

Definition at line 100 of file StatEntity.h.

{ return standard_deviation(); }

Max()

double StatEntity::Max ( ) const

inline

Definition at line 95 of file StatEntity.h.

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

Mean()

double StatEntity::Mean ( ) const

inline

Definition at line 88 of file StatEntity.h.

{ return mean(); }              // get mean

MeanErr()

double StatEntity::MeanErr ( ) const

inline

Definition at line 89 of file StatEntity.h.

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

Min()

double StatEntity::Min ( ) const

inline

Definition at line 94 of file StatEntity.h.

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

operator++() [1/2]

StatEntity& StatEntity::operator++ ( )

inline

Definition at line 50 of file StatEntity.h.

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

operator++() [2/2]

StatEntity StatEntity::operator++ ( int  )

inline

Definition at line 54 of file StatEntity.h.

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

operator+=() [1/2]

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

inline

Definition at line 73 of file StatEntity.h.

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

operator+=() [2/2]

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

inline

Definition at line 77 of file StatEntity.h.

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

operator--() [1/2]

StatEntity& StatEntity::operator-- ( )

inline

Definition at line 59 of file StatEntity.h.

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

operator--() [2/2]

StatEntity StatEntity::operator-- ( int  )

inline

Definition at line 63 of file StatEntity.h.

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

operator-=()

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

inline

Definition at line 46 of file StatEntity.h.

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

operator<()

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

inline

Definition at line 68 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 42 of file StatEntity.h.

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

print() [1/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() [2/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() [3/6]

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

inlineoverridevirtual

Definition at line 168 of file StatEntity.h.

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

print() [4/6]

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

inlineoverridevirtual

Definition at line 171 of file StatEntity.h.

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

print() [5/6]

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

inlineoverride

Definition at line 172 of file StatEntity.h.

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

print() [6/6]

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

inlineoverride

Definition at line 176 of file StatEntity.h.

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

printFormatted() [1/2]

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

inline

Definition at line 115 of file StatEntity.h.

                                                                             {
    return printFormattedImpl( o, format );
  }

printFormatted() [2/2]

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

inline

Definition at line 118 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 110 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 121 of file StatEntity.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 = 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();
      }
    }
  }

reset()

void StatEntity::reset ( )

inline

Definition at line 41 of file StatEntity.h.

{ AccParent::reset(); }

rms()

double StatEntity::rms ( ) const

inline

Definition at line 90 of file StatEntity.h.

{ return standard_deviation(); } // get rms

Rms()

double StatEntity::Rms ( ) const

inline

Definition at line 91 of file StatEntity.h.

{ return standard_deviation(); } // get rms

RMS()

double StatEntity::RMS ( ) const

inline

Definition at line 92 of file StatEntity.h.

{ return standard_deviation(); } // get rms

Sum()

double StatEntity::Sum ( ) const

inline

Definition at line 87 of file StatEntity.h.

{ 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();
  }

---

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

• GaudiKernel/GaudiKernel/StatEntity.h