YODA::Fillable Class Reference

A base class for all fillable objects. More...

#include <Fillable.h>

Inheritance diagram for YODA::Fillable:

Public Member Functions
Constructors
virtual	~Fillable ()=default
	Virtual destructor for inheritance.
Modifiers
virtual void	reset ()=0
	Reset.
virtual void	scaleW (double scalefactor)=0
	Rescale as if all fill weights had been different by factor scalefactor.
Whole histo data
virtual size_t	fillDim () const noexcept=0
	Fill-dimension of this data object.
virtual double	numEntries (const bool includeoverflows=true) const =0
	Get the number of fills.
virtual double	effNumEntries (const bool includeoverflows=true) const =0
	Get the effective number of fills.
virtual double	sumW (const bool includeoverflows=true) const =0
	Get sum of weights in histo.
virtual double	sumW2 (const bool includeoverflows=true) const =0
	Get sum of squared weights in histo.

Detailed Description

A base class for all fillable objects.

Definition at line 13 of file Fillable.h.

Constructor & Destructor Documentation

~Fillable()

virtual YODA::Fillable::~Fillable ( )

virtualdefault

Virtual destructor for inheritance.

Member Function Documentation

effNumEntries()

virtual double YODA::Fillable::effNumEntries ( const bool  includeoverflows = true ) const

pure virtual

Get the effective number of fills.

Implemented in YODA::Counter, YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, and YODA::DbnStorage< DbnN, AxisT... >.

fillDim()

virtual size_t YODA::Fillable::fillDim ( ) const

pure virtualnoexcept

Fill-dimension of this data object.

Implemented in YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< DbnN, AxisT... >, and YODA::Counter.

numEntries()

virtual double YODA::Fillable::numEntries ( const bool  includeoverflows = true ) const

pure virtual

Get the number of fills.

Implemented in YODA::Counter, YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, and YODA::DbnStorage< DbnN, AxisT... >.

reset()

virtual void YODA::Fillable::reset ( )

pure virtual

Reset.

Implemented in YODA::Counter, YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, and YODA::DbnStorage< DbnN, AxisT... >.

scaleW()

virtual void YODA::Fillable::scaleW ( double  scalefactor )

pure virtual

Rescale as if all fill weights had been different by factor scalefactor.

Implemented in YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< DbnN, AxisT... >, and YODA::Counter.

sumW()

virtual double YODA::Fillable::sumW ( const bool  includeoverflows = true ) const

pure virtual

Get sum of weights in histo.

Implemented in YODA::Counter, YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, and YODA::DbnStorage< DbnN, AxisT... >.

sumW2()

virtual double YODA::Fillable::sumW2 ( const bool  includeoverflows = true ) const

pure virtual

Get sum of squared weights in histo.

Implemented in YODA::Counter, YODA::DbnStorage< DbnN, AxisT >, YODA::DbnStorage< 1, AxisT >, YODA::DbnStorage< 2, AxisT >, YODA::DbnStorage< 2, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2 >, YODA::DbnStorage< 3, AxisT1, AxisT2, AxisT3 >, YODA::DbnStorage< 4, AxisT1, AxisT2, AxisT3 >, and YODA::DbnStorage< DbnN, AxisT... >.

---

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

• include/YODA/Fillable.h