YODA::XStatsMixin< Derived > Struct Template Reference

CRTP mixin introducing convenience aliases to access statistics along X axis. More...

#include <BinnedUtils.h>

Public Member Functions
Whole histo data
double	xMean (const bool includeOverflows=true) const noexcept
	Calculate the mean on X axis.
double	xVariance (const bool includeOverflows=true) const noexcept
	Calculate the variance on X axis.
double	xStdDev (const bool includeOverflows=true) const noexcept
	Calculate the standard deviation on X axis.
double	xStdErr (const bool includeOverflows=true) const noexcept
	Calculate the standard error on X axis.
double	xRMS (const bool includeOverflows=true) const noexcept
	Calculate the RMS on X axis.

Detailed Description

template<class Derived>
struct YODA::XStatsMixin< Derived >

CRTP mixin introducing convenience aliases to access statistics along X axis.

Definition at line 73 of file BinnedUtils.h.

Member Function Documentation

xMean()

template<class Derived >

double YODA::XStatsMixin< Derived >::xMean ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the mean on X axis.

Definition at line 79 of file BinnedUtils.h.

                                                                  {
      return static_cast<const Derived*>(this)->mean(0, includeOverflows);
    }

References YODA::mean().

xRMS()

template<class Derived >

double YODA::XStatsMixin< Derived >::xRMS ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the RMS on X axis.

Definition at line 99 of file BinnedUtils.h.

                                                                 {
      return static_cast<const Derived*>(this)->rms(0, includeOverflows);
    }

xStdDev()

template<class Derived >

double YODA::XStatsMixin< Derived >::xStdDev ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the standard deviation on X axis.

Definition at line 89 of file BinnedUtils.h.

                                                                    {
      return static_cast<const Derived*>(this)->stdDev(0, includeOverflows);
    }

References YODA::stdDev().

xStdErr()

template<class Derived >

double YODA::XStatsMixin< Derived >::xStdErr ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the standard error on X axis.

Definition at line 94 of file BinnedUtils.h.

                                                                    {
      return static_cast<const Derived*>(this)->stdErr(0, includeOverflows);
    }

References YODA::stdErr().

xVariance()

template<class Derived >

double YODA::XStatsMixin< Derived >::xVariance ( const bool  includeOverflows = true ) const

inlinenoexcept

Calculate the variance on X axis.

Definition at line 84 of file BinnedUtils.h.

                                                                      {
      return static_cast<const Derived*>(this)->variance(0, includeOverflows);
    }

References YODA::variance().

---

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

• include/YODA/Utils/BinnedUtils.h