RooIntegrator2D implements a numeric two-dimensiona integrator in terms of a recursive application of RooIntegrator1D.

Definition at line 22 of file RooIntegrator2D.h.

Public Member Functions
	RooIntegrator2D ()
	Default constructor.

	RooIntegrator2D (const RooAbsFunc &function, const RooNumIntConfig &config)
	Constructor with a function binding and a configuration object.

	RooIntegrator2D (const RooAbsFunc &function, double xmin, double xmax, double ymin, double ymax, const RooNumIntConfig &config)
	Constructor with a function binding, a configuration object and an explicit definition of the integration limits.

	RooIntegrator2D (const RooAbsFunc &function, double xmin, double xmax, double ymin, double ymax, SummationRule rule=Trapezoid, Int_t maxSteps=0, double eps=0)
	Constructor with a given function binding, summation rule, maximum number of steps, conversion tolerance and an explicit choice of integration limits on both dimensions.

	RooIntegrator2D (const RooAbsFunc &function, RooIntegrator1D::SummationRule rule=RooIntegrator1D::Trapezoid, Int_t maxSteps=0, double eps=0)
	Constructor with a given function binding, summation rule, maximum number of steps and conversion tolerance.

	~RooIntegrator2D () override
	Destructor.

bool	canIntegrate1D () const override

bool	canIntegrate2D () const override

bool	canIntegrateND () const override

bool	canIntegrateOpenEnded () const override

bool	checkLimits () const override
	Verify that the limits are OK for this integrator (i.e. no open-ended ranges)

RooAbsIntegrator *	clone (const RooAbsFunc &function, const RooNumIntConfig &config) const override
	Clone integrator with new function and configuration. Needed to support RooNumIntFactory.

TClass *	IsA () const override

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooIntegrator1D
	RooIntegrator1D ()

	RooIntegrator1D (const RooAbsFunc &function, const RooNumIntConfig &config)
	Construct integrator on given function binding, using specified configuration object.

	RooIntegrator1D (const RooAbsFunc &function, double xmin, double xmax, const RooNumIntConfig &config)
	Construct integrator on given function binding, using specified configuration object and integration range.

	RooIntegrator1D (const RooAbsFunc &function, double xmin, double xmax, SummationRule rule=Trapezoid, Int_t maxSteps=0, double eps=0)
	Construct integrator on given function binding for given range, using specified summation rule, maximum number of steps and conversion tolerance.

	RooIntegrator1D (const RooAbsFunc &function, SummationRule rule=Trapezoid, Int_t maxSteps=0, double eps=0)
	Construct integrator on given function binding, using specified summation rule, maximum number of steps and conversion tolerance.

double	integral (const double *yvec=nullptr) override
	Calculate numeric integral at given set of function binding parameters.

virtual bool	setLimits (double , double )

bool	setLimits (double xmin, double xmax) override
	Change our integration limits.

virtual bool	setLimits (double xmin, double xmax)
	Interface to set limits on integration.

bool	setUseIntegrandLimits (bool flag) override
	Interface function that allows to defer limit definition to integrand definition.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooAbsIntegrator
	RooAbsIntegrator ()

	RooAbsIntegrator (const RooAbsFunc &function, bool printEvalCounter=false)
	Copy constructor.

	~RooAbsIntegrator () override
	Destructor.

double	calculate (const double *yvec=nullptr)
	Calculate integral value with given array of parameter values.

const RooAbsFunc *	integrand () const
	Return integrand function binding.

double	integrand (const double x[]) const
	Return value of integrand at given observable values.

bool	isValid () const
	Is integrator in valid state.

bool	printEvalCounter () const

void	setPrintEvalCounter (bool value)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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.

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

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)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

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.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooIntegrator1D
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()
	do not persist

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooAbsIntegrator
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Protected Member Functions
static void	registerIntegrator (RooNumIntFactory &fact)
	Register RooIntegrator2D, is parameters and capabilities with RooNumIntFactory.

Static Protected Member Functions inherited from RooIntegrator1D
static void	registerIntegrator (RooNumIntFactory &fact)
	Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.

Protected Attributes
RooAbsFunc *	_xint
	Function binding representing integral over first dimension.

RooIntegrator1D *	_xIntegrator
	Integrator in first dimension.

Protected Attributes inherited from RooIntegrator1D
std::vector< double >	_c
	! Integrator workspace

std::vector< double >	_d
	! Integrator workspace

bool	_doExtrap
	Apply conversion step?

double	_epsAbs
	Absolute convergence tolerance.

double	_epsRel
	Relative convergence tolerance.

double	_extrapError
	! Error on extrapolated value

double	_extrapValue
	! Extrapolated value

Int_t	_fixSteps
	Fixed number of steps.

std::vector< double >	_h
	! Integrator workspace

Int_t	_maxSteps
	Maximum number of steps.

Int_t	_minStepsZero
	Minimum number of steps to declare convergence to zero.

double	_range
	! Size of integration range

SummationRule	_rule

std::vector< double >	_s
	! Integrator workspace

double	_savedResult
	! Integrator workspace

bool	_useIntegrandLimits
	If true limits of function binding are used.

std::vector< double >	_x

double	_xmax
	! Upper integration bound

double	_xmin
	! Lower integration bound

Protected Attributes inherited from RooAbsIntegrator
const RooAbsFunc *	_function = nullptr
	Pointer to function binding of integrand.

bool	_printEvalCounter = false
	If true print number of function evaluation required for integration.

bool	_valid = false
	Is integrator in valid state?

Friends
class	RooNumIntFactory

Additional Inherited Members
Public Types inherited from RooIntegrator1D
enum	SummationRule { Trapezoid , Midpoint }

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 RooIntegrator1D
enum	{ _nPoints = 5 }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from RooIntegrator1D
double	addMidpoints (Int_t n)
	Calculate the n-th stage of refinement of the Second Euler-Maclaurin summation rule which has the useful property of not evaluating the integrand at either of its endpoints but requires more function evaluations than the trapezoidal rule.

double	addTrapezoids (Int_t n)
	Calculate the n-th stage of refinement of the extended trapezoidal summation rule.

void	extrapolate (Int_t n)
	Extrapolate result to final value.

bool	initialize ()
	Initialize the integrator.

double *	xvec (double &xx)

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).

void	MakeZombie ()

#include <RooIntegrator2D.h>

Inheritance diagram for RooIntegrator2D:

[legend]

Constructor & Destructor Documentation

◆ RooIntegrator2D() [1/5]

RooIntegrator2D::RooIntegrator2D ( )

Default constructor.

Definition at line 57 of file RooIntegrator2D.cxx.

◆ RooIntegrator2D() [2/5]

RooIntegrator2D::RooIntegrator2D	(	const RooAbsFunc &	function,
		RooIntegrator1D::SummationRule	rule = `RooIntegrator1D::Trapezoid`,
		Int_t	maxSteps = `0`,
		double	eps = `0`
	)

Constructor with a given function binding, summation rule, maximum number of steps and conversion tolerance.

The integration limits are taken from the definition in the function binding.

Definition at line 68 of file RooIntegrator2D.cxx.

◆ RooIntegrator2D() [3/5]

RooIntegrator2D::RooIntegrator2D	(	const RooAbsFunc &	function,
		double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		SummationRule	rule = `Trapezoid`,
		Int_t	maxSteps = `0`,
		double	eps = `0`
	)

Constructor with a given function binding, summation rule, maximum number of steps, conversion tolerance and an explicit choice of integration limits on both dimensions.

Definition at line 80 of file RooIntegrator2D.cxx.

◆ RooIntegrator2D() [4/5]

RooIntegrator2D::RooIntegrator2D	(	const RooAbsFunc &	function,
		const RooNumIntConfig &	config
	)

Constructor with a function binding and a configuration object.

The integration limits are taken from the definition in the function binding

Definition at line 93 of file RooIntegrator2D.cxx.

◆ RooIntegrator2D() [5/5]

RooIntegrator2D::RooIntegrator2D	(	const RooAbsFunc &	function,
		double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		const RooNumIntConfig &	config
	)

Constructor with a function binding, a configuration object and an explicit definition of the integration limits.

Definition at line 104 of file RooIntegrator2D.cxx.

◆ ~RooIntegrator2D()

RooIntegrator2D::~RooIntegrator2D ( )

override

Destructor.

Definition at line 125 of file RooIntegrator2D.cxx.

Member Function Documentation

◆ canIntegrate1D()

bool RooIntegrator2D::canIntegrate1D ( ) const

inlineoverridevirtual

Reimplemented from RooIntegrator1D.

Definition at line 41 of file RooIntegrator2D.h.

◆ canIntegrate2D()

bool RooIntegrator2D::canIntegrate2D ( ) const

inlineoverridevirtual

Reimplemented from RooIntegrator1D.

Definition at line 42 of file RooIntegrator2D.h.

◆ canIntegrateND()

bool RooIntegrator2D::canIntegrateND ( ) const

inlineoverridevirtual

Reimplemented from RooIntegrator1D.

Definition at line 43 of file RooIntegrator2D.h.

◆ canIntegrateOpenEnded()

bool RooIntegrator2D::canIntegrateOpenEnded ( ) const

inlineoverridevirtual

Reimplemented from RooIntegrator1D.

Definition at line 44 of file RooIntegrator2D.h.

◆ checkLimits()

bool RooIntegrator2D::checkLimits ( ) const

overridevirtual

Verify that the limits are OK for this integrator (i.e. no open-ended ranges)

Reimplemented from RooIntegrator1D.

Definition at line 135 of file RooIntegrator2D.cxx.

◆ Class()

static TClass * RooIntegrator2D::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooIntegrator2D::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooIntegrator2D::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 54 of file RooIntegrator2D.h.

◆ clone()

RooAbsIntegrator * RooIntegrator2D::clone	(	const RooAbsFunc &	function,
		const RooNumIntConfig &	config
	)		const

overridevirtual

Clone integrator with new function and configuration. Needed to support RooNumIntFactory.

Reimplemented from RooIntegrator1D.

Definition at line 115 of file RooIntegrator2D.cxx.

◆ DeclFileName()

static const char * RooIntegrator2D::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 54 of file RooIntegrator2D.h.

◆ IsA()

TClass * RooIntegrator2D::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from RooIntegrator1D.

Definition at line 54 of file RooIntegrator2D.h.

◆ registerIntegrator()

void RooIntegrator2D::registerIntegrator ( RooNumIntFactory & fact )

staticprotected

Register RooIntegrator2D, is parameters and capabilities with RooNumIntFactory.

Definition at line 46 of file RooIntegrator2D.cxx.

◆ Streamer()

void RooIntegrator2D::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from RooIntegrator1D.

◆ StreamerNVirtual()

void RooIntegrator2D::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 54 of file RooIntegrator2D.h.

Friends And Related Symbol Documentation

◆ RooNumIntFactory

friend class RooNumIntFactory

friend

Definition at line 48 of file RooIntegrator2D.h.

Member Data Documentation

◆ _xint

RooAbsFunc* RooIntegrator2D::_xint

protected

Function binding representing integral over first dimension.

Definition at line 52 of file RooIntegrator2D.h.

◆ _xIntegrator

RooIntegrator1D* RooIntegrator2D::_xIntegrator

protected

Integrator in first dimension.

Definition at line 51 of file RooIntegrator2D.h.

Libraries for RooIntegrator2D:

[legend]

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

roofit/roofitcore/inc/RooIntegrator2D.h
roofit/roofitcore/src/RooIntegrator2D.cxx

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooIntegrator2D() [1/5]

◆ RooIntegrator2D() [2/5]

◆ RooIntegrator2D() [3/5]

◆ RooIntegrator2D() [4/5]

◆ RooIntegrator2D() [5/5]

◆ ~RooIntegrator2D()

Member Function Documentation

◆ canIntegrate1D()

◆ canIntegrate2D()

◆ canIntegrateND()

◆ canIntegrateOpenEnded()

◆ checkLimits()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ clone()

◆ DeclFileName()

◆ IsA()

◆ registerIntegrator()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ RooNumIntFactory

Member Data Documentation

◆ _xint

◆ _xIntegrator