yoda is hosted by Hepforge, IPPP Durham
YODA - Yet more Objects for Data Analysis  1.9.0
YODA::Fillable Class Referenceabstract

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

#include <Fillable.h>

Inheritance diagram for YODA::Fillable:
YODA::Counter YODA::Histo1D YODA::Histo2D YODA::Profile1D YODA::Profile2D

Public Member Functions

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

Detailed Description

A base class for all fillable objects.

Definition at line 16 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 ( bool  includeoverflows = true) const
pure virtual

Get the effective number of fills.

Implemented in YODA::Histo2D, YODA::Profile2D, YODA::Histo1D, YODA::Profile1D, and YODA::Counter.

◆ fillDim()

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

Fill-dimension of this data object.

Implemented in YODA::Histo2D, YODA::Profile2D, YODA::Histo1D, YODA::Profile1D, and YODA::Counter.

◆ numEntries()

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

Get the number of fills.

Implemented in YODA::Histo2D, YODA::Profile2D, YODA::Histo1D, YODA::Profile1D, and YODA::Counter.

◆ reset()

virtual void YODA::Fillable::reset ( )
pure virtual

◆ 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::Histo2D, YODA::Profile2D, YODA::Profile1D, YODA::Histo1D, and YODA::Counter.

◆ sumW()

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

Get sum of weights in histo.

Implemented in YODA::Histo2D, YODA::Profile2D, YODA::Histo1D, YODA::Profile1D, and YODA::Counter.

◆ sumW2()

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

Get sum of squared weights in histo.

Implemented in YODA::Histo2D, YODA::Profile2D, YODA::Histo1D, YODA::Profile1D, and YODA::Counter.


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