cet::simple_stats Class Reference

#include <simple_stats.h>

Public Member Functions
	simple_stats () noexcept
	simple_stats (double x) noexcept
std::size_t	size () const noexcept
double	max () const noexcept
double	min () const noexcept
double	small () const noexcept
double	sum () const noexcept
double	sumsq () const noexcept
double	mean () const noexcept
double	range () const noexcept
double	err_mean (std::size_t nparams=1u) const noexcept
double	rms (std::size_t nparams=1u) const noexcept
double	rms0 (std::size_t nparams=0u) const noexcept
double	err_rms (std::size_t nparams=1u) const noexcept
void	reset () noexcept
void	sample (double) noexcept
template<class Iter >
void	sample (Iter begin, Iter end) noexcept

Private Attributes
std::size_t	n_
double	min_
double	max_
double	small_
double	sum_
double	sumsq_

Detailed Description

Definition at line 25 of file simple_stats.h.

Constructor & Destructor Documentation

simple_stats::simple_stats ( )

noexcept

Definition at line 20 of file simple_stats.cc.

  : n_(0u)
  , min_(+std::numeric_limits<double>::infinity())
  , max_(-std::numeric_limits<double>::infinity())
  , small_(+std::numeric_limits<double>::infinity())
  , sum_(0.0)
  , sumsq_(0.0)
{
  ;
}

simple_stats::simple_stats ( double  x )

noexcept

Definition at line 31 of file simple_stats.cc.

  : n_(0u)
  , min_(+std::numeric_limits<double>::infinity())
  , max_(-std::numeric_limits<double>::infinity())
  , small_(+std::numeric_limits<double>::infinity())
  , sum_(0.0)
  , sumsq_(0.0)
{
  sample(x);
}

Member Function Documentation

double simple_stats::err_mean ( std::size_t  nparams = 1u ) const

noexcept

Definition at line 59 of file simple_stats.cc.

{
  return n_ == 0u ? std::numeric_limits<double>::quiet_NaN() :
                    rms(nparams) / std::sqrt(double(n_));
}

double simple_stats::err_rms ( std::size_t  nparams = 1u ) const

noexcept

Definition at line 94 of file simple_stats.cc.

{
  return n_ == 0u ? std::numeric_limits<double>::quiet_NaN() :
                    rms(nparams) / std::sqrt(double(2u * n_));
}

double cet::simple_stats::max ( ) const

inlinenoexcept

Definition at line 40 of file simple_stats.h.

  {
    return max_;
  }

double simple_stats::mean ( ) const

noexcept

Definition at line 46 of file simple_stats.cc.

{
  return n_ == 0u ? std::numeric_limits<double>::quiet_NaN() :
                    sum_ / double(n_);
}

double cet::simple_stats::min ( ) const

inlinenoexcept

Definition at line 45 of file simple_stats.h.

  {
    return min_;
  }

double simple_stats::range ( ) const

noexcept

Definition at line 53 of file simple_stats.cc.

{
  return max_ - min_;
}

void simple_stats::reset ( )

noexcept

Definition at line 104 of file simple_stats.cc.

{
  *this = simple_stats();
}

double simple_stats::rms ( std::size_t  nparams = 1u ) const

noexcept

Definition at line 66 of file simple_stats.cc.

{
  if (n_ <= nparams)
    return std::numeric_limits<double>::quiet_NaN();

  double diff = sumsq_ / double(n_) - square(mean());
  if (diff < 0.0)
    return 0.0;

  double factor = double(n_) / double(n_ - nparams);
  return std::sqrt(factor * diff);
}

double simple_stats::rms0 ( std::size_t  nparams = 0u ) const

noexcept

Definition at line 80 of file simple_stats.cc.

{
  if (n_ <= nparams)
    return std::numeric_limits<double>::quiet_NaN();

  double diff = sumsq_ / double(n_);
  if (diff < 0.0)
    return 0.0;

  double factor = double(n_) / double(n_ - nparams);
  return std::sqrt(factor * diff);
}

void simple_stats::sample ( double  x )

noexcept

Definition at line 110 of file simple_stats.cc.

{
  ++n_;
  min_ = std::min(x, min_);
  max_ = std::max(x, max_);
  small_ = std::min(std::abs(x), small_);
  sum_ += x;
  sumsq_ += square(x);
}

template<class Iter >

void cet::simple_stats::sample ( Iter  begin, Iter  end  )

inlinenoexcept

Definition at line 78 of file simple_stats.h.

  {
    for (; begin != end; ++begin)
      sample(*begin);
  }

std::size_t cet::simple_stats::size ( ) const

inlinenoexcept

Definition at line 35 of file simple_stats.h.

  {
    return n_;
  }

double cet::simple_stats::small ( ) const

inlinenoexcept

Definition at line 50 of file simple_stats.h.

  {
    return small_;
  }

double cet::simple_stats::sum ( ) const

inlinenoexcept

Definition at line 55 of file simple_stats.h.

  {
    return sum_;
  }

double cet::simple_stats::sumsq ( ) const

inlinenoexcept

Definition at line 60 of file simple_stats.h.

  {
    return sumsq_;
  }

Member Data Documentation

double cet::simple_stats::max_

private

Definition at line 86 of file simple_stats.h.

double cet::simple_stats::min_

private

Definition at line 86 of file simple_stats.h.

std::size_t cet::simple_stats::n_

private

Definition at line 85 of file simple_stats.h.

double cet::simple_stats::small_

private

Definition at line 86 of file simple_stats.h.

double cet::simple_stats::sum_

private

Definition at line 87 of file simple_stats.h.

double cet::simple_stats::sumsq_

private

Definition at line 87 of file simple_stats.h.

---

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

• cetlib/cetlib/simple_stats.h
• cetlib/cetlib/simple_stats.cc