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

Base class for bins in 1D and 2D histograms. More...

#include <Bin.h>

Inheritance diagram for YODA::Bin:
YODA::Bin1D< Dbn1D > YODA::Bin1D< Dbn2D > YODA::Bin2D< Dbn2D > YODA::Bin2D< Dbn3D > YODA::Bin1D< DBN > YODA::Bin2D< DBN > YODA::HistoBin1D YODA::ProfileBin1D YODA::HistoBin2D YODA::ProfileBin2D

Public Member Functions

virtual ~Bin ()
 Virtual destructor for inheritance. More...
 
Miscellaneous
virtual void reset ()=0
 Reset this bin. More...
 
Dimensions
virtual size_t dim ()=0
 
virtual size_t fillDim ()=0
 Dimension of the fill space. More...
 
Fill statistics
virtual double numEntries () const =0
 The number of entries (fractional fills are possible) More...
 
virtual double effNumEntries () const =0
 The effective number of entries. More...
 
virtual double sumW () const =0
 The sum of weights. More...
 
virtual double sumW2 () const =0
 The sum of weights squared. More...
 

Detailed Description

Base class for bins in 1D and 2D histograms.

This base class only provides very basic functionality for fill weight statistics access, as 1D/2D and basic/profile histos have quite difference implementations.

Definition at line 20 of file Bin.h.

Constructor & Destructor Documentation

◆ ~Bin()

virtual YODA::Bin::~Bin ( )
inlinevirtual

Virtual destructor for inheritance.

Definition at line 24 of file Bin.h.

References dim(), effNumEntries(), fillDim(), numEntries(), reset(), sumW(), and sumW2().

24 { }

Member Function Documentation

◆ dim()

virtual size_t YODA::Bin::dim ( )
pure virtual

Dimension of the fill space

Todo:
Convert to be the total dimension

Implemented in YODA::Bin2D< DBN >, YODA::Bin2D< Dbn2D >, YODA::Bin2D< Dbn3D >, YODA::Bin1D< DBN >, YODA::Bin1D< Dbn1D >, and YODA::Bin1D< Dbn2D >.

Referenced by ~Bin().

◆ effNumEntries()

virtual double YODA::Bin::effNumEntries ( ) const
pure virtual

◆ fillDim()

virtual size_t YODA::Bin::fillDim ( )
pure virtual

◆ numEntries()

virtual double YODA::Bin::numEntries ( ) const
pure virtual

The number of entries (fractional fills are possible)

Implemented in YODA::Bin2D< DBN >, YODA::Bin2D< Dbn2D >, YODA::Bin2D< Dbn3D >, YODA::Bin1D< DBN >, YODA::Bin1D< Dbn1D >, and YODA::Bin1D< Dbn2D >.

Referenced by ~Bin().

◆ reset()

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

◆ sumW()

virtual double YODA::Bin::sumW ( ) const
pure virtual

◆ sumW2()

virtual double YODA::Bin::sumW2 ( ) const
pure virtual

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