ROOT   Reference Guide
Loading...
Searching...
No Matches
RooGaussKronrodIntegrator1D Class Reference

RooGaussKronrodIntegrator1D implements the Gauss-Kronrod integration algorithm.

An Gaussian quadrature method for numerical integration in which error is estimation based on evaluation at special points known as "Kronrod points." By suitably picking these points, abscissas from previous iterations can be reused as part of the new set of points, whereas usual Gaussian quadrature would require recomputation of all abscissas at each iteration.

This class automatically handles (-inf,+inf) integrals by dividing the integration in three regions (-inf,-1), (-1,1), (1,inf) and calculating the 1st and 3rd term using a x -> 1/x coordinate transformation

This class embeds the Gauss-Kronrod integrator from the GNU Scientific Library version 1.5 and applies the 10-, 21-, 43- and 87-point rule in succession until the required target precision is reached

Definition at line 24 of file RooGaussKronrodIntegrator1D.h.

## Public Member Functions

RooGaussKronrodIntegrator1D (const RooAbsFunc &function, const RooNumIntConfig &config)
Construct integral on 'function' using given configuration object.

RooGaussKronrodIntegrator1D (const RooAbsFunc &function, double xmin, double xmax, const RooNumIntConfig &config)
Construct integral on 'function' using given configuration object in the given range.

bool checkLimits () const override
Check that our integration range is finite and otherwise return false.

double integral (const double *yvec=nullptr) override
Calculate and return integral.

TClassIsA () const override

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 Streamer (TBuffer &) override
Stream an object of class TObject.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooAbsIntegrator
RooAbsIntegrator ()

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

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

const RooAbsFuncintegrand () 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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
Must be redefined in derived classes.

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

virtual Option_tGetDrawOption () 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_tGetOption () 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 (the base implementation is no-op).

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, void *vp)
Only called by placement new when throwing an exception.

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

void operator delete[] (void *ptr, void *vp)
Only called by placement new[] when throwing an exception.

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.

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 TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()
Upper integration bound.

static const char * DeclFileName ()

Static Public Member Functions inherited from RooAbsIntegrator
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

Static Public Member Functions inherited from TObject
static TClassClass ()

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.

## Protected Member Functions

bool initialize ()
Perform one-time initialization of integrator.

doublexvec (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 ()

## Static Protected Member Functions

static void registerIntegrator (RooNumIntFactory &fact)
Register RooGaussKronrodIntegrator1D, its parameters and capabilities with RooNumIntConfig.

## Protected Attributes

double _epsAbs
do not persist

double _epsRel

bool _useIntegrandLimits

std::vector< double_x

double _xmax
Lower integration bound.

double _xmin

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

double RooGaussKronrodIntegrator1D_GSL_GlueFunction (double x, void *data)

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 <RooGaussKronrodIntegrator1D.h>

Inheritance diagram for RooGaussKronrodIntegrator1D:
[legend]

## ◆ RooGaussKronrodIntegrator1D() [1/2]

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

Construct integral on 'function' using given configuration object.

The integration range is taken from the definition in the function binding

Definition at line 113 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ RooGaussKronrodIntegrator1D() [2/2]

 RooGaussKronrodIntegrator1D::RooGaussKronrodIntegrator1D ( const RooAbsFunc & function, double xmin, double xmax, const RooNumIntConfig & config )

Construct integral on 'function' using given configuration object in the given range.

Definition at line 127 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ checkLimits()

 bool RooGaussKronrodIntegrator1D::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 175 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ Class()

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

## ◆ Class_Name()

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

## ◆ Class_Version()

 static constexpr Version_t RooGaussKronrodIntegrator1D::Class_Version ( )
inlinestaticconstexpr

Upper integration bound.

Returns
Version of this class

Definition at line 57 of file RooGaussKronrodIntegrator1D.h.

## ◆ DeclFileName()

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

Definition at line 57 of file RooGaussKronrodIntegrator1D.h.

## ◆ initialize()

 bool RooGaussKronrodIntegrator1D::initialize ( )
protected

Perform one-time initialization of integrator.

Definition at line 143 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ integral()

 double RooGaussKronrodIntegrator1D::integral ( const double * yvec = nullptr )
overridevirtual

Calculate and return integral.

Implements RooAbsIntegrator.

Definition at line 198 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ IsA()

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

Reimplemented from RooAbsIntegrator.

Definition at line 57 of file RooGaussKronrodIntegrator1D.h.

## ◆ registerIntegrator()

 void RooGaussKronrodIntegrator1D::registerIntegrator ( RooNumIntFactory & fact )
staticprotected

Register RooGaussKronrodIntegrator1D, its parameters and capabilities with RooNumIntConfig.

Definition at line 92 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ setLimits() [1/3]

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

Reimplemented from RooAbsIntegrator.

Definition at line 53 of file RooAbsIntegrator.h.

## ◆ setLimits() [2/3]

 bool RooGaussKronrodIntegrator1D::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 158 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ setLimits() [3/3]

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

Interface to set limits on integration.

Reimplemented from RooAbsIntegrator.

Definition at line 54 of file RooAbsIntegrator.cxx.

## ◆ setUseIntegrandLimits()

 bool RooGaussKronrodIntegrator1D::setUseIntegrandLimits ( bool flag )
inlineoverridevirtual

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

Reimplemented from RooAbsIntegrator.

Definition at line 35 of file RooGaussKronrodIntegrator1D.h.

## ◆ Streamer()

 void RooGaussKronrodIntegrator1D::Streamer ( TBuffer & R__b )
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsIntegrator.

## ◆ StreamerNVirtual()

 void RooGaussKronrodIntegrator1D::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )
inline

Definition at line 57 of file RooGaussKronrodIntegrator1D.h.

## ◆ xvec()

 double * RooGaussKronrodIntegrator1D::xvec ( double & xx )
inlineprotected

Definition at line 48 of file RooGaussKronrodIntegrator1D.h.

## ◆ RooGaussKronrodIntegrator1D_GSL_GlueFunction

 double RooGaussKronrodIntegrator1D_GSL_GlueFunction ( double x, void * data )
friend

Definition at line 187 of file RooGaussKronrodIntegrator1D.cxx.

## ◆ RooNumIntFactory

 friend class RooNumIntFactory
friend

Definition at line 39 of file RooGaussKronrodIntegrator1D.h.

## ◆ _epsAbs

 double RooGaussKronrodIntegrator1D::_epsAbs
protected

do not persist

Definition at line 51 of file RooGaussKronrodIntegrator1D.h.

## ◆ _epsRel

 double RooGaussKronrodIntegrator1D::_epsRel
protected

Definition at line 52 of file RooGaussKronrodIntegrator1D.h.

## ◆ _useIntegrandLimits

 bool RooGaussKronrodIntegrator1D::_useIntegrandLimits
protected

Definition at line 46 of file RooGaussKronrodIntegrator1D.h.

## ◆ _x

 std::vector RooGaussKronrodIntegrator1D::_x
protected

Definition at line 49 of file RooGaussKronrodIntegrator1D.h.

## ◆ _xmax

 double RooGaussKronrodIntegrator1D::_xmax
mutableprotected

Lower integration bound.

Definition at line 55 of file RooGaussKronrodIntegrator1D.h.

## ◆ _xmin

 double RooGaussKronrodIntegrator1D::_xmin
mutableprotected

Definition at line 54 of file RooGaussKronrodIntegrator1D.h.

Libraries for RooGaussKronrodIntegrator1D:

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