yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis 2.0.0
YODA::ZStatsMixin< Derived > Struct Template Reference

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

#include <BinnedUtils.h>

Public Member Functions

Whole histo data
double zMean (const bool includeOverflows=true) const noexcept
 Calculate the mean on Z axis.
 
double zVariance (const bool includeOverflows=true) const noexcept
 Calculate the variance on Z axis.
 
double zStdDev (const bool includeOverflows=true) const noexcept
 Calculate the standard deviation on Z axis.
 
double zStdErr (const bool includeOverflows=true) const noexcept
 Calculate the standard error on Z axis.
 
double zRMS (const bool includeOverflows=true) const noexcept
 Calculate the RMS on Z axis.
 

Detailed Description

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

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

Definition at line 252 of file BinnedUtils.h.

Member Function Documentation

◆ zMean()

template<class Derived >
double YODA::ZStatsMixin< Derived >::zMean ( const bool  includeOverflows = true) const
inlinenoexcept

Calculate the mean on Z axis.

Definition at line 258 of file BinnedUtils.h.

258 {
259 return static_cast<const Derived*>(this)->mean(2, includeOverflows);
260 }
double mean(const std::vector< int > &sample)
Calculate the mean of a sample.
Definition MathUtils.h:391

References YODA::mean().

◆ zRMS()

template<class Derived >
double YODA::ZStatsMixin< Derived >::zRMS ( const bool  includeOverflows = true) const
inlinenoexcept

Calculate the RMS on Z axis.

Definition at line 278 of file BinnedUtils.h.

278 {
279 return static_cast<const Derived*>(this)->rms(2, includeOverflows);
280 }

◆ zStdDev()

template<class Derived >
double YODA::ZStatsMixin< Derived >::zStdDev ( const bool  includeOverflows = true) const
inlinenoexcept

Calculate the standard deviation on Z axis.

Definition at line 268 of file BinnedUtils.h.

268 {
269 return static_cast<const Derived*>(this)->stdDev(2, includeOverflows);
270 }
double stdDev(const double sumWX, const double sumW, const double sumWX2, const double sumW2)
Calculate the weighted standard deviation of a sample.
Definition MathUtils.h:458

References YODA::stdDev().

◆ zStdErr()

template<class Derived >
double YODA::ZStatsMixin< Derived >::zStdErr ( const bool  includeOverflows = true) const
inlinenoexcept

Calculate the standard error on Z axis.

Definition at line 273 of file BinnedUtils.h.

273 {
274 return static_cast<const Derived*>(this)->stdErr(2, includeOverflows);
275 }
double stdErr(const double sumWX, const double sumW, const double sumWX2, const double sumW2)
Calculate the weighted standard error of a sample.
Definition MathUtils.h:470

References YODA::stdErr().

◆ zVariance()

template<class Derived >
double YODA::ZStatsMixin< Derived >::zVariance ( const bool  includeOverflows = true) const
inlinenoexcept

Calculate the variance on Z axis.

Definition at line 263 of file BinnedUtils.h.

263 {
264 return static_cast<const Derived*>(this)->variance(2, includeOverflows);
265 }
double variance(const double sumWX, const double sumW, const double sumWX2, const double sumW2)
Calculate the weighted variance of a sample.
Definition MathUtils.h:421

References YODA::variance().


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