StatEntity::se Struct Reference

Public Member Functions
se &	operator+= (const struct se &other)
unsigned long	add (double Flag)
double	mean () const
double	rms () const
double	meanErr () const
double	efficiency () const
double	efficiencyErr () const

Public Attributes
unsigned long	nEntries = 0
	number of calls More...
double	accumulatedFlag = 0
	accumulated flag More...
double	accumulatedFlag2 = 0
double	minimalFlag = std::numeric_limits<double>::max()
double	maximalFlag = -1 * std::numeric_limits<double>::max()
long	nEntriesBeforeReset = -1

Friends
bool	operator< (const struct se &lhs, const struct se &rhs)

Detailed Description

Definition at line 446 of file StatEntity.h.

Member Function Documentation

unsigned long StatEntity::se::add

(

double

Flag

)

accumulate the flag

evaluate min/max

Definition at line 83 of file StatEntity.cpp.

{
  if ( 0 < nEntriesBeforeReset ) {
    --nEntriesBeforeReset;
  } else if ( 0 == nEntriesBeforeReset ) {
    *this = {};
  } 
  accumulatedFlag += Flag; // accumulate the flag
  minimalFlag = std::min( minimalFlag, Flag ); // evaluate min/max
  maximalFlag = std::max( maximalFlag, Flag ); // evaluate min/max
  // accumulate statistics, but avoid FPE for small flags...
  static double s_min1 = 2 * ::sqrt( std::numeric_limits<double>::min() );
  if ( s_min1 < Flag || -s_min1 > Flag ) {
    accumulatedFlag2 += Flag * Flag;
  } // accumulate statistics:
  //
  return ++nEntries;
}

double StatEntity::se::efficiency

(

)

const

Definition at line 149 of file StatEntity.cpp.

{
  if ( 1 > nEntries || 0 > accumulatedFlag || accumulatedFlag > nEntries ) {
    return -1;
  }
  const long double fMin = minimalFlag;
  if ( 0 != fMin && 1 != fMin ) {
    return -1;
  }
  const long double fMax = maximalFlag;
  if ( 0 != fMax && 1 != fMax ) {
    return -1;
  }
  return mean();
}

double StatEntity::se::efficiencyErr

(

)

const

Definition at line 167 of file StatEntity.cpp.

{
  if ( 0 > efficiency() ) {
    return -1;
  }
  //
  long double n1 = accumulatedFlag;
  // treat properly the bins with eff=0
  if ( 0 == n1 ) {
    n1 = 1;
  } 
  const long double n3 = nEntries;
  long double n2       = n3 - accumulatedFlag;
  // treat properly the bins with eff=100%
  if ( 1 > fabsl( n2 ) ) {
    n2 = 1;
  } 
  //
  return ::sqrtl( n1 * n2 / n3 ) / n3;
}

double StatEntity::se::mean

(

)

const

Definition at line 106 of file StatEntity.cpp.

{
  const long double f1 = accumulatedFlag;
  const long double f2 = nEntries;
  return nEntries > 0 ? f1 / f2 : 0;
}

double StatEntity::se::meanErr

(

)

const

Definition at line 130 of file StatEntity.cpp.

{
  if ( 0 >= nEntries ) {
    return 0;
  }
  const long double f1     = accumulatedFlag;
  const long double f2     = f1 / nEntries;
  const long double f3     = accumulatedFlag2;
  const long double f4     = f3 / nEntries;
  const long double result = f4 - f2 * f2;
  if ( 0 > result ) {
    return 0;
  }
  //
  return ::sqrtl( result / nEntries );
}

se& StatEntity::se::operator+= ( const struct se &  other )

inline

Definition at line 457 of file StatEntity.h.

    {
      nEntries += other.nEntries;
      accumulatedFlag += other.accumulatedFlag;
      accumulatedFlag2 += other.accumulatedFlag2;
      minimalFlag = std::min( minimalFlag, other.minimalFlag );
      maximalFlag = std::max( maximalFlag, other.maximalFlag );
      return *this;
    }

double StatEntity::se::rms

(

)

const

Definition at line 115 of file StatEntity.cpp.

{
  if ( 0 >= nEntries ) {
    return 0;
  }
  const long double f1     = accumulatedFlag;
  const long double f2     = f1 / nEntries;
  const long double f3     = accumulatedFlag2;
  const long double f4     = f3 / nEntries;
  const long double result = f4 - f2 * f2;
  return ( 0 > result ) ? 0 : ::sqrtl( result );
}

Friends And Related Function Documentation

bool operator< ( const struct se &  lhs, const struct se &  rhs  )

friend

Definition at line 474 of file StatEntity.h.

    {
      auto order = []( const auto& s ) {
        return std::tie( s.nEntries, s.accumulatedFlag, s.minimalFlag, s.maximalFlag, s.accumulatedFlag2 );
      };
      return order( lhs ) < order( rhs );
    };

Member Data Documentation

double StatEntity::se::accumulatedFlag = 0

accumulated flag

Definition at line 450 of file StatEntity.h.

double StatEntity::se::accumulatedFlag2 = 0

Definition at line 451 of file StatEntity.h.

double StatEntity::se::maximalFlag = -1 * std::numeric_limits<double>::max()

Definition at line 453 of file StatEntity.h.

double StatEntity::se::minimalFlag = std::numeric_limits<double>::max()

Definition at line 452 of file StatEntity.h.

unsigned long StatEntity::se::nEntries = 0

number of calls

Definition at line 448 of file StatEntity.h.

long StatEntity::se::nEntriesBeforeReset = -1

Definition at line 455 of file StatEntity.h.

---

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

• GaudiKernel/GaudiKernel/StatEntity.h
• GaudiKernel/src/Lib/StatEntity.cpp