Partial template specialisation with CRTP for x-methods. More...

#include <Dbn.h>

Inheritance diagram for YODA::Dbn< 1 >:

Public Types
using	BaseT = DbnBase< 1 >

Public Types inherited from YODA::DbnBase< 1 >
using	BaseT = DbnBase< N >

using	FillDim = std::integral_constant< size_t, N >

using	DataSize = std::integral_constant< size_t, 1+2 (N+1)+(N (N-1)/2)>

Public Member Functions
	Dbn ()

	Dbn (const double numEntries, const double sumW, const double sumW2, const double sumWX, const double sumWX2)

	Dbn (const BaseT &other)

	Dbn (BaseT &&other)

void	fill (const std::array< double, 1 > &vals, const double weight=1.0, const double fraction=1.0)

void	fill (const double val, const double weight=1.0, const double fraction=1.0)

Public Member Functions inherited from YODA::DbnBase< 1 >
	DbnBase ()
	Default constructor of a new distribution.

	DbnBase (const double numEntries, const std::array< double, N+1 > &sumW, const std::array< double, N+1 > &sumW2)
	Constructor to set a distribution with a pre-filled state.

	DbnBase (const double numEntries, const std::array< double, N+1 > &sumW, const std::array< double, N+1 > &sumW2, const std::array< double, N *(N-1)/2 > &sumWcross)
	Constructor to set a distribution with a pre-filled state.

	DbnBase (const DbnBase &)=default

	DbnBase (DbnBase &&)=default

DbnBase &	operator= (const DbnBase &)=default

DbnBase &	operator= (DbnBase &&)=default

void	fill (const std::array< double, N > vals, const double weight=1.0, const double fraction=1.0)
	Contribute a sample at val (from an array) with weight weight.

void	fill (Args &&... args)
	Templated convenience overload of fill method.

void	set (const double numEntries, const std::array< double, N+1 > &sumW, const std::array< double, N+1 > &sumW2, const std::array< double, N *(N-1)/2 > &sumWcross)
	Set a sample with array-based number of entries numEntries, sum of weights sumW (and corresponding moments), sum of squared weights sumW2 (and corresponding moments).

void	set (const double numEntries, const std::vector< double > &sumW, const std::vector< double > &sumW2, const std::vector< double > &sumWcross={})
	Set a sample with vector-based number of entries numEntries, sum of weights sumW (and corresponding moments), sum of squared weights sumW2 (and corresponding moments).

void	set (const DbnBase< N > &other)
	Set a sample with other.

void	set (DbnBase< N > &&other)
	Set a sample with other.

void	reset ()
	Reset the internal counters.

void	scaleW (const double scalefactor)
	Rescale as if all fill weights had been different by factor scalefactor.

void	scale (const size_t dim, const double factor)

double	errW () const
	The absolute error on sumW.

double	relErrW () const
	The relative error on sumW.

double	mean (const size_t i) const
	Weighted mean, $\bar{x}$ , of distribution.

double	variance (const size_t i) const
	Weighted variance, $\sigma^2$ , of distribution.

double	stdDev (const size_t i) const
	Weighted standard deviation, $\sigma$ , of distribution.

double	stdErr (const size_t i) const
	Weighted standard error on the mean, $\sim \sigma/\sqrt{N-1}$ , of distribution.

double	relStdErr (const size_t i) const
	Relative weighted standard error on the mean, $\sim \sigma/\sqrt{N-1}$ , of distribution.

double	RMS (const size_t i) const
	Weighted RMS, $\sqrt{ \sum{w x^2}/\sum{w} }$ , of distribution.

double	numEntries () const
	Number of entries (number of times `fill` was called, ignoring weights)

double	effNumEntries () const
	Effective number of entries $= (\sum w)^2 / \sum w^2$ .

double	sumW () const
	The sum of weights.

double	sumW (const size_t i) const
	The sum of x*weight.

double	sumW2 () const
	The sum of weights squared.

double	sumW2 (const size_t i) const
	The sum of x^2*weight.

double	crossTerm (const size_t A1, const size_t A2) const
	The second-order cross term between axes k and l.

size_t	dim () const

std::string	toString () const
	String representation of the DbnBase for debugging.

DbnBase< sizeof...(size_t)>	reduceTo (size_t... axes) const
	Reduce operation that produces a lower-dimensional DbnBase keeping only the specified axes in the new DbnBase.

DbnBase< sizeof...(Is)>	reduceTo (std::index_sequence< Is... >) const
	Same as above but using an std::integer_sequence.

auto	reduce () const
	Reduce operation that produces a lower-dimensional DbnBase removing the specified axes for the new DbnBase.

DbnBase &	operator+= (const DbnBase &d)
	Add two DbnBases.

DbnBase &	operator+= (DbnBase &&d)
	Add two DbnBases.

DbnBase &	operator-= (const DbnBase &d)
	Subtract one DbnBase from another.

DbnBase &	operator-= (DbnBase &&d)
	Subtract one DbnBase from another.

Public Member Functions inherited from YODA::XDbnMixin< Dbn< 1 > >
void	scaleX (double factor)

double	xMean () const

double	xVariance () const

double	xStdDev () const

double	xStdErr () const

double	xRMS () const

double	sumWX () const

double	sumWX2 () const

Detailed Description

Partial template specialisation with CRTP for x-methods.

Definition at line 678 of file Dbn.h.

Member Typedef Documentation

◆ BaseT

using YODA::Dbn< 1 >::BaseT = DbnBase<1>

Definition at line 682 of file Dbn.h.

Constructor & Destructor Documentation

◆ Dbn() [1/4]

YODA::Dbn< 1 >::Dbn ( )

inline

Definition at line 686 of file Dbn.h.

686: BaseT() {}

YODA::Dbn< 1 >::BaseT

DbnBase< 1 > BaseT

Definition Dbn.h:682

◆ Dbn() [2/4]

YODA::Dbn< 1 >::Dbn	(	const double	numEntries,
		const double	sumW,
		const double	sumW2,
		const double	sumWX,
		const double	sumWX2
	)

inline

Definition at line 688 of file Dbn.h.

689 : BaseT(numEntries, {sumW, sumWX} , {sumW2, sumWX2}) { }

YODA::DbnBase< 1 >::sumW

double sumW() const

The sum of weights.

Definition Dbn.h:320

YODA::DbnBase< 1 >::numEntries

double numEntries() const

Number of entries (number of times fill was called, ignoring weights)

Definition Dbn.h:309

YODA::DbnBase< 1 >::sumW2

double sumW2() const

The sum of weights squared.

Definition Dbn.h:325

YODA::XDbnMixin< Dbn< 1 > >::sumWX

double sumWX() const

Definition DbnUtils.h:40

YODA::XDbnMixin< Dbn< 1 > >::sumWX2

double sumWX2() const

Definition DbnUtils.h:41

References YODA::DbnBase< N >::sumW().

◆ Dbn() [3/4]

YODA::Dbn< 1 >::Dbn ( const BaseT & other )

inline

Definition at line 691 of file Dbn.h.

691: BaseT(other) {}

◆ Dbn() [4/4]

YODA::Dbn< 1 >::Dbn ( BaseT && other )

inline

Definition at line 693 of file Dbn.h.

693: BaseT(std::move(other)) {}

Member Function Documentation

◆ fill() [1/2]

void YODA::Dbn< 1 >::fill	(	const double	val,
		const double	weight = `1.0`,
		const double	fraction = `1.0`
	)

inline

Definition at line 699 of file Dbn.h.

                                                                                    {
      BaseT::fill({val}, weight, fraction);
    }

References YODA::DbnBase< N >::fill().

◆ fill() [2/2]

void YODA::Dbn< 1 >::fill	(	const std::array< double, 1 > &	vals,
		const double	weight = `1.0`,
		const double	fraction = `1.0`
	)

inline

Definition at line 695 of file Dbn.h.

                                                                                                       {
      BaseT::fill(vals, weight, fraction);
    }

References YODA::DbnBase< N >::fill().

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

include/YODA/Dbn.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ BaseT

Constructor & Destructor Documentation

◆ Dbn() [1/4]

◆ Dbn() [2/4]

◆ Dbn() [3/4]

◆ Dbn() [4/4]

Member Function Documentation

◆ fill() [1/2]

◆ fill() [2/2]