Logo ROOT  
Reference Guide
RooBinIntegrator Class Reference

RooBinIntegrator computes the integral over a binned distribution by summing the bin contents of all bins.

Definition at line 28 of file RooBinIntegrator.h.

Public Member Functions

 RooBinIntegrator ()
 Default constructor. More...
 
 RooBinIntegrator (const RooAbsFunc &function)
 Construct integrator on given function binding binding. More...
 
 RooBinIntegrator (const RooAbsFunc &function, const RooNumIntConfig &config)
 Construct integrator on given function binding binding. More...
 
 ~RooBinIntegrator () override
 Destructor. More...
 
bool canIntegrate1D () const override
 
bool canIntegrate2D () const override
 
bool canIntegrateND () const override
 
bool canIntegrateOpenEnded () const override
 
bool checkLimits () const override
 Check that our integration range is finite and otherwise return false. More...
 
RooAbsIntegratorclone (const RooAbsFunc &function, const RooNumIntConfig &config) const override
 Clone integrator with new function binding and configuration. Needed by RooNumIntFactory. More...
 
double integral (const double *yvec=0) override
 Calculate numeric integral at given set of function binding parameters. More...
 
TClassIsA () const override
 
virtual bool setLimits (double *, double *)
 
bool setLimits (double *xmin, double *xmax) override
 Change our integration limits. More...
 
virtual bool setLimits (double xmin, double xmax)
 Interface to set limits on integration. More...
 
bool setUseIntegrandLimits (bool flag) override
 Interface function that allows to defer limit definition to integrand definition. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from RooAbsIntegrator
 RooAbsIntegrator ()
 Default constructor. More...
 
 RooAbsIntegrator (const RooAbsFunc &function, bool printEvalCounter=false)
 Copy constructor. More...
 
 ~RooAbsIntegrator () override
 Destructor. More...
 
double calculate (const double *yvec=0)
 Calculate integral value with given array of parameter values. More...
 
virtual bool canIntegrate1D () const =0
 
virtual bool canIntegrate2D () const =0
 
virtual bool canIntegrateND () const =0
 
virtual bool canIntegrateOpenEnded () const =0
 
virtual bool checkLimits () const
 If true, finite limits are required on the observable range. More...
 
virtual RooAbsIntegratorclone (const RooAbsFunc &function, const RooNumIntConfig &config) const =0
 
virtual double integral (const double *yvec=0)=0
 
const RooAbsFuncintegrand () const
 Return integrand function binding. More...
 
double integrand (const double x[]) const
 Return value of integrand at given observable values. More...
 
TClassIsA () const override
 
bool isValid () const
 Is integrator in valid state. More...
 
bool printEvalCounter () const
 
virtual bool setLimits (double *, double *)
 
virtual bool setLimits (double xmin, double xmax)
 Interface to set limits on integration. More...
 
void setPrintEvalCounter (bool value)
 
virtual bool setUseIntegrandLimits (bool flag)
 Interface function that allows to defer limit definition to integrand definition. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual TClassIsA () const
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooAbsIntegrator
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

 RooBinIntegrator (const RooBinIntegrator &)
 
doublexvec (double xx)
 
doublexvec (double xx, double yy)
 
doublexvec (double xx, double yy, double zz)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Static Protected Member Functions

static void registerIntegrator (RooNumIntFactory &fact)
 Register RooBinIntegrator, is parameters and capabilities with RooNumIntFactory. More...
 

Protected Attributes

std::vector< std::vector< double > > _binb
 ! list of bin boundaries More...
 
std::unique_ptr< RooBatchCompute::RunContext_evalData
 ! Run context for evaluating a function. More...
 
std::unique_ptr< RooBatchCompute::RunContext_evalDataOrig
 ! Run context to save bin centres in between invocations. More...
 
Int_t _numBins
 ! Size of integration range More...
 
bool _useIntegrandLimits
 If true limits of function binding are ued. More...
 
double_x
 ! do not persist More...
 
std::vector< double_xmax
 ! Upper integration bound More...
 
std::vector< double_xmin
 ! Lower integration bound More...
 
- Protected Attributes inherited from RooAbsIntegrator
const RooAbsFunc_function
 Pointer to function binding of integrand. More...
 
bool _printEvalCounter
 If true print number of function evaluation required for integration. More...
 
bool _valid
 Is integrator in valid state? More...
 

Friends

class RooNumIntFactory
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include <RooBinIntegrator.h>

Inheritance diagram for RooBinIntegrator:
[legend]

Constructor & Destructor Documentation

◆ RooBinIntegrator() [1/4]

RooBinIntegrator::RooBinIntegrator ( )

Default constructor.

Definition at line 68 of file RooBinIntegrator.cxx.

◆ RooBinIntegrator() [2/4]

RooBinIntegrator::RooBinIntegrator ( const RooAbsFunc function)

Construct integrator on given function binding binding.

Definition at line 76 of file RooBinIntegrator.cxx.

◆ RooBinIntegrator() [3/4]

RooBinIntegrator::RooBinIntegrator ( const RooAbsFunc function,
const RooNumIntConfig config 
)

Construct integrator on given function binding binding.

Definition at line 127 of file RooBinIntegrator.cxx.

◆ ~RooBinIntegrator()

RooBinIntegrator::~RooBinIntegrator ( )
override

Destructor.

Definition at line 188 of file RooBinIntegrator.cxx.

◆ RooBinIntegrator() [4/4]

RooBinIntegrator::RooBinIntegrator ( const RooBinIntegrator )
protected

Member Function Documentation

◆ canIntegrate1D()

bool RooBinIntegrator::canIntegrate1D ( ) const
inlineoverridevirtual

Implements RooAbsIntegrator.

Definition at line 47 of file RooBinIntegrator.h.

◆ canIntegrate2D()

bool RooBinIntegrator::canIntegrate2D ( ) const
inlineoverridevirtual

Implements RooAbsIntegrator.

Definition at line 48 of file RooBinIntegrator.h.

◆ canIntegrateND()

bool RooBinIntegrator::canIntegrateND ( ) const
inlineoverridevirtual

Implements RooAbsIntegrator.

Definition at line 49 of file RooBinIntegrator.h.

◆ canIntegrateOpenEnded()

bool RooBinIntegrator::canIntegrateOpenEnded ( ) const
inlineoverridevirtual

Implements RooAbsIntegrator.

Definition at line 50 of file RooBinIntegrator.h.

◆ checkLimits()

bool RooBinIntegrator::checkLimits ( ) const
overridevirtual

Check that our integration range is finite and otherwise return false.

Update the limits from the integrand if requested.

Reimplemented from RooAbsIntegrator.

Definition at line 215 of file RooBinIntegrator.cxx.

◆ Class()

static TClass * RooBinIntegrator::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooBinIntegrator::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static Version_t RooBinIntegrator::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 75 of file RooBinIntegrator.h.

◆ clone()

RooAbsIntegrator * RooBinIntegrator::clone ( const RooAbsFunc function,
const RooNumIntConfig config 
) const
overridevirtual

Clone integrator with new function binding and configuration. Needed by RooNumIntFactory.

Implements RooAbsIntegrator.

Definition at line 176 of file RooBinIntegrator.cxx.

◆ DeclFileName()

static const char * RooBinIntegrator::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 75 of file RooBinIntegrator.h.

◆ integral()

double RooBinIntegrator::integral ( const double yvec = 0)
overridevirtual

Calculate numeric integral at given set of function binding parameters.

Implements RooAbsIntegrator.

Definition at line 242 of file RooBinIntegrator.cxx.

◆ IsA()

TClass * RooBinIntegrator::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from RooAbsIntegrator.

Definition at line 75 of file RooBinIntegrator.h.

◆ registerIntegrator()

void RooBinIntegrator::registerIntegrator ( RooNumIntFactory fact)
staticprotected

Register RooBinIntegrator, is parameters and capabilities with RooNumIntFactory.

Definition at line 55 of file RooBinIntegrator.cxx.

◆ setLimits() [1/3]

virtual bool RooAbsIntegrator::setLimits ( double ,
double  
)
inlinevirtual

Reimplemented from RooAbsIntegrator.

Definition at line 62 of file RooAbsIntegrator.h.

◆ setLimits() [2/3]

bool RooBinIntegrator::setLimits ( double xmin,
double xmax 
)
overridevirtual

Change our integration limits.

Return true if the new limits are ok, or otherwise false. Always returns false and does nothing if this object was constructed to always use our integrand's limits.

Reimplemented from RooAbsIntegrator.

Definition at line 199 of file RooBinIntegrator.cxx.

◆ setLimits() [3/3]

bool RooAbsIntegrator::setLimits ( double  xmin,
double  xmax 
)
virtual

Interface to set limits on integration.

Reimplemented from RooAbsIntegrator.

Definition at line 63 of file RooAbsIntegrator.cxx.

◆ setUseIntegrandLimits()

bool RooBinIntegrator::setUseIntegrandLimits ( bool  flag)
inlineoverridevirtual

Interface function that allows to defer limit definition to integrand definition.

Reimplemented from RooAbsIntegrator.

Definition at line 45 of file RooBinIntegrator.h.

◆ Streamer()

void RooBinIntegrator::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsIntegrator.

◆ StreamerNVirtual()

void RooBinIntegrator::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 75 of file RooBinIntegrator.h.

◆ xvec() [1/3]

double * RooBinIntegrator::xvec ( double  xx)
inlineprotected

Definition at line 69 of file RooBinIntegrator.h.

◆ xvec() [2/3]

double * RooBinIntegrator::xvec ( double  xx,
double  yy 
)
inlineprotected

Definition at line 70 of file RooBinIntegrator.h.

◆ xvec() [3/3]

double * RooBinIntegrator::xvec ( double  xx,
double  yy,
double  zz 
)
inlineprotected

Definition at line 71 of file RooBinIntegrator.h.

Friends And Related Function Documentation

◆ RooNumIntFactory

friend class RooNumIntFactory
friend

Definition at line 54 of file RooBinIntegrator.h.

Member Data Documentation

◆ _binb

std::vector<std::vector<double> > RooBinIntegrator::_binb
protected

! list of bin boundaries

Definition at line 61 of file RooBinIntegrator.h.

◆ _evalData

std::unique_ptr<RooBatchCompute::RunContext> RooBinIntegrator::_evalData
protected

! Run context for evaluating a function.

Definition at line 66 of file RooBinIntegrator.h.

◆ _evalDataOrig

std::unique_ptr<RooBatchCompute::RunContext> RooBinIntegrator::_evalDataOrig
protected

! Run context to save bin centres in between invocations.

Definition at line 67 of file RooBinIntegrator.h.

◆ _numBins

Int_t RooBinIntegrator::_numBins
mutableprotected

! Size of integration range

Definition at line 62 of file RooBinIntegrator.h.

◆ _useIntegrandLimits

bool RooBinIntegrator::_useIntegrandLimits
protected

If true limits of function binding are ued.

Definition at line 64 of file RooBinIntegrator.h.

◆ _x

double* RooBinIntegrator::_x
protected

! do not persist

Definition at line 73 of file RooBinIntegrator.h.

◆ _xmax

std::vector<double> RooBinIntegrator::_xmax
mutableprotected

! Upper integration bound

Definition at line 60 of file RooBinIntegrator.h.

◆ _xmin

std::vector<double> RooBinIntegrator::_xmin
mutableprotected

! Lower integration bound

Definition at line 59 of file RooBinIntegrator.h.

Libraries for RooBinIntegrator:
[legend]

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