ActsUtils::Stat Class Reference

Simple class to gather statistics : min, max, mean, rms. More...

#include <StatUtils.h>

Inheritance diagram for ActsUtils::Stat:

Collaboration diagram for ActsUtils::Stat:

Public Member Functions
void	add (double val)
	@bruef Gather a new value will update min, max and the sums to compute mean and rms
unsigned int	n () const
double	min () const
double	max () const
double	mean () const
double	rms2 () const
double	rms () const
void	reset ()
	Set statistics to zero.
Stat &	operator+= (const Stat &b)
	@breif Add the statistics gathered in the Stat object b

Public Attributes
unsigned int	m_n =0
double	m_sum =0.
double	m_sum2 =0.
double	m_min =std::numeric_limits<double>::max()
double	m_max =-std::numeric_limits<double>::max()

Detailed Description

Simple class to gather statistics : min, max, mean, rms.

Definition at line 17 of file StatUtils.h.

Member Function Documentation

add()

void ActsUtils::Stat::add ( double val )

inline

@bruef Gather a new value will update min, max and the sums to compute mean and rms

Definition at line 21 of file StatUtils.h.

                        {
      ++m_n;
      m_sum += val;
      m_sum2 += val*val;
      m_min=std::min(m_min,val);
      m_max=std::max(m_max,val);
   }

max()

double ActsUtils::Stat::max ( ) const

inline

Definition at line 30 of file StatUtils.h.

{ return m_max; }

mean()

double ActsUtils::Stat::mean ( ) const

inline

Definition at line 31 of file StatUtils.h.

{ return m_n>0 ? m_sum/m_n : 0.; }

min()

double ActsUtils::Stat::min ( ) const

inline

Definition at line 29 of file StatUtils.h.

{ return m_min; }

n()

unsigned int ActsUtils::Stat::n ( ) const

inline

Definition at line 28 of file StatUtils.h.

{ return m_n; }

operator+=()

Stat & ActsUtils::Stat::operator+= ( const Stat & b )

inline

@breif Add the statistics gathered in the Stat object b

Definition at line 45 of file StatUtils.h.

                                    {
      m_n += b.m_n;
      m_sum += b.m_sum;
      m_sum2 += b.m_sum2;
      m_min = std::min(m_min, b.m_min);
      m_max = std::max(m_max, b.m_max);
      return *this;
   }

reset()

void ActsUtils::Stat::reset ( )

inline

Set statistics to zero.

Definition at line 36 of file StatUtils.h.

                {
      m_n=0;
      m_sum=0.;
      m_sum2=0.;
      m_min=std::numeric_limits<double>::max();
      m_max=-std::numeric_limits<double>::max();
   }

rms()

double ActsUtils::Stat::rms ( ) const

inline

Definition at line 33 of file StatUtils.h.

{ return std::sqrt( rms2() ); }

rms2()

double ActsUtils::Stat::rms2 ( ) const

inline

Definition at line 32 of file StatUtils.h.

{ return m_n>1 ? (m_sum2 - m_sum *m_sum/m_n)/(m_n-1) : 0.; }

Member Data Documentation

m_max

double ActsUtils::Stat::m_max =-std::numeric_limits<double>::max()

Definition at line 58 of file StatUtils.h.

m_min

double ActsUtils::Stat::m_min =std::numeric_limits<double>::max()

Definition at line 57 of file StatUtils.h.

m_n

unsigned int ActsUtils::Stat::m_n =0

Definition at line 54 of file StatUtils.h.

m_sum

double ActsUtils::Stat::m_sum =0.

Definition at line 55 of file StatUtils.h.

m_sum2

double ActsUtils::Stat::m_sum2 =0.

Definition at line 56 of file StatUtils.h.

---

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

• StatUtils.h