Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooIntegrator1D Class Reference

RooIntegrator1D implements an adaptive one-dimensional numerical integration algorithm.

Definition at line 22 of file RooIntegrator1D.h.

Public Types

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

Public Member Functions

 RooIntegrator1D ()
 coverity[UNINIT_CTOR] Default constructor
 
 RooIntegrator1D (const RooAbsFunc &function, const RooNumIntConfig &config)
 Construct integrator on given function binding, using specified configuration object.
 
 RooIntegrator1D (const RooAbsFunc &function, Double_t xmin, Double_t xmax, const RooNumIntConfig &config)
 Construct integrator on given function binding, using specified configuration object and integration range.
 
 RooIntegrator1D (const RooAbsFunc &function, Double_t xmin, Double_t xmax, SummationRule rule=Trapezoid, Int_t maxSteps=0, Double_t 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_t eps=0)
 Construct integrator on given function binding, using specified summation rule, maximum number of steps and conversion tolerance.
 
virtual ~RooIntegrator1D ()
 Destructor.
 
virtual Bool_t canIntegrate1D () const
 
virtual Bool_t canIntegrate2D () const
 
virtual Bool_t canIntegrateND () const
 
virtual Bool_t canIntegrateOpenEnded () const
 
virtual Bool_t checkLimits () const
 Check that our integration range is finite and otherwise return kFALSE.
 
virtual RooAbsIntegratorclone (const RooAbsFunc &function, const RooNumIntConfig &config) const
 Clone integrator with new function binding and configuration. Needed by RooNumIntFactory.
 
virtual Double_t integral (const Double_t *yvec=0)
 Calculate numeric integral at given set of function binding parameters.
 
virtual Bool_t setLimits (Double_t *, Double_t *)
 
Bool_t setLimits (Double_t *xmin, Double_t *xmax)
 Change our integration limits.
 
virtual Bool_t setLimits (Double_t xmin, Double_t xmax)
 Interface to set limits on integration.
 
virtual Bool_t setUseIntegrandLimits (Bool_t flag)
 Interface function that allows to defer limit definition to integrand definition.
 
- Public Member Functions inherited from RooAbsIntegrator
 RooAbsIntegrator ()
 Default constructor.
 
 RooAbsIntegrator (const RooAbsFunc &function, Bool_t printEvalCounter=kFALSE)
 Copy constructor.
 
virtual ~RooAbsIntegrator ()
 
Double_t calculate (const Double_t *yvec=0)
 Calculate integral value with given array of parameter values.
 
const RooAbsFuncintegrand () const
 
Double_t integrand (const Double_t x[]) const
 
Bool_t isValid () const
 
Bool_t printEvalCounter () const
 
void setPrintEvalCounter (Bool_t value)
 
- 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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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.
 
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 [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Protected Types

enum  { _nPoints = 5 }
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 

Protected Member Functions

Double_t 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_t 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_t initialize ()
 Initialize the integrator.
 
Double_txvec (Double_t &xx)
 Integrator workspace.
 
- 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 RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.
 

Protected Attributes

Double_t_c
 Integrator workspace.
 
Double_t_d
 Integrator workspace.
 
Bool_t _doExtrap
 
Double_t _epsAbs
 
Double_t _epsRel
 
Double_t _extrapError
 Extrapolated value.
 
Double_t _extrapValue
 Size of integration range.
 
Int_t _fixSteps
 
Double_t_h
 Error on extrapolated value.
 
Int_t _maxSteps
 
Int_t _minStepsZero
 
Double_t _range
 Upper integration bound.
 
SummationRule _rule
 
Double_t_s
 Integrator workspace.
 
Double_t _savedResult
 Integrator workspace.
 
Bool_t _useIntegrandLimits
 
Double_t_x
 
Double_t _xmax
 Lower integration bound.
 
Double_t _xmin
 
- Protected Attributes inherited from RooAbsIntegrator
const RooAbsFunc_function
 
Bool_t _printEvalCounter
 
Bool_t _valid
 

Friends

class RooNumIntFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
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.
 

#include <RooIntegrator1D.h>

Inheritance diagram for RooIntegrator1D:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
_nPoints 

Definition at line 70 of file RooIntegrator1D.h.

◆ SummationRule

Enumerator
Trapezoid 
Midpoint 

Definition at line 26 of file RooIntegrator1D.h.

Constructor & Destructor Documentation

◆ RooIntegrator1D() [1/5]

RooIntegrator1D::RooIntegrator1D ( )

coverity[UNINIT_CTOR] Default constructor

Definition at line 79 of file RooIntegrator1D.cxx.

◆ RooIntegrator1D() [2/5]

RooIntegrator1D::RooIntegrator1D ( const RooAbsFunc function,
SummationRule  rule = Trapezoid,
Int_t  maxSteps = 0,
Double_t  eps = 0 
)

Construct integrator on given function binding, using specified summation rule, maximum number of steps and conversion tolerance.

The integration limits are taken from the function binding

Definition at line 90 of file RooIntegrator1D.cxx.

◆ RooIntegrator1D() [3/5]

RooIntegrator1D::RooIntegrator1D ( const RooAbsFunc function,
Double_t  xmin,
Double_t  xmax,
SummationRule  rule = Trapezoid,
Int_t  maxSteps = 0,
Double_t  eps = 0 
)

Construct integrator on given function binding for given range, using specified summation rule, maximum number of steps and conversion tolerance.

The integration limits are taken from the function binding

Definition at line 105 of file RooIntegrator1D.cxx.

◆ RooIntegrator1D() [4/5]

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

Construct integrator on given function binding, using specified configuration object.

The integration limits are taken from the function binding

Definition at line 128 of file RooIntegrator1D.cxx.

◆ RooIntegrator1D() [5/5]

RooIntegrator1D::RooIntegrator1D ( const RooAbsFunc function,
Double_t  xmin,
Double_t  xmax,
const RooNumIntConfig config 
)

Construct integrator on given function binding, using specified configuration object and integration range.

Definition at line 156 of file RooIntegrator1D.cxx.

◆ ~RooIntegrator1D()

RooIntegrator1D::~RooIntegrator1D ( )
virtual

Destructor.

Definition at line 224 of file RooIntegrator1D.cxx.

Member Function Documentation

◆ addMidpoints()

Double_t RooIntegrator1D::addMidpoints ( Int_t  n)
protected

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.

This rule can be used with a suitable change of variables to estimate improper integrals.

Definition at line 356 of file RooIntegrator1D.cxx.

◆ addTrapezoids()

Double_t RooIntegrator1D::addTrapezoids ( Int_t  n)
protected

Calculate the n-th stage of refinement of the extended trapezoidal summation rule.

This is the most efficient rule for a well behaved integrands that can be evaluated over its entire range, including the endpoints.

Definition at line 388 of file RooIntegrator1D.cxx.

◆ canIntegrate1D()

virtual Bool_t RooIntegrator1D::canIntegrate1D ( ) const
inlinevirtual

Implements RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 48 of file RooIntegrator1D.h.

◆ canIntegrate2D()

virtual Bool_t RooIntegrator1D::canIntegrate2D ( ) const
inlinevirtual

Implements RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 49 of file RooIntegrator1D.h.

◆ canIntegrateND()

virtual Bool_t RooIntegrator1D::canIntegrateND ( ) const
inlinevirtual

Implements RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 50 of file RooIntegrator1D.h.

◆ canIntegrateOpenEnded()

virtual Bool_t RooIntegrator1D::canIntegrateOpenEnded ( ) const
inlinevirtual

Implements RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 51 of file RooIntegrator1D.h.

◆ checkLimits()

Bool_t RooIntegrator1D::checkLimits ( ) const
virtual

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

Update the limits from the integrand if requested.

Reimplemented from RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 256 of file RooIntegrator1D.cxx.

◆ clone()

RooAbsIntegrator * RooIntegrator1D::clone ( const RooAbsFunc function,
const RooNumIntConfig config 
) const
virtual

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

Implements RooAbsIntegrator.

Reimplemented in RooIntegrator2D.

Definition at line 181 of file RooIntegrator1D.cxx.

◆ extrapolate()

void RooIntegrator1D::extrapolate ( Int_t  n)
protected

Extrapolate result to final value.

Definition at line 417 of file RooIntegrator1D.cxx.

◆ initialize()

Bool_t RooIntegrator1D::initialize ( )
protected

Initialize the integrator.

Definition at line 191 of file RooIntegrator1D.cxx.

◆ integral()

Double_t RooIntegrator1D::integral ( const Double_t yvec = 0)
virtual

Calculate numeric integral at given set of function binding parameters.

Implements RooAbsIntegrator.

Definition at line 275 of file RooIntegrator1D.cxx.

◆ registerIntegrator()

void RooIntegrator1D::registerIntegrator ( RooNumIntFactory fact)
staticprotected

Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.

Definition at line 54 of file RooIntegrator1D.cxx.

◆ setLimits() [1/3]

virtual Bool_t RooAbsIntegrator::setLimits ( Double_t ,
Double_t  
)
inlinevirtual

Reimplemented from RooAbsIntegrator.

Definition at line 61 of file RooAbsIntegrator.h.

◆ setLimits() [2/3]

Bool_t RooIntegrator1D::setLimits ( Double_t xmin,
Double_t xmax 
)
virtual

Change our integration limits.

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

Reimplemented from RooAbsIntegrator.

Definition at line 240 of file RooIntegrator1D.cxx.

◆ setLimits() [3/3]

Bool_t RooAbsIntegrator::setLimits ( Double_t  xmin,
Double_t  xmax 
)
virtual

Interface to set limits on integration.

Reimplemented from RooAbsIntegrator.

Definition at line 62 of file RooAbsIntegrator.cxx.

◆ setUseIntegrandLimits()

virtual Bool_t RooIntegrator1D::setUseIntegrandLimits ( Bool_t  flag)
inlinevirtual

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

Reimplemented from RooAbsIntegrator.

Definition at line 46 of file RooIntegrator1D.h.

◆ xvec()

Double_t * RooIntegrator1D::xvec ( Double_t xx)
inlineprotected

Integrator workspace.

Definition at line 89 of file RooIntegrator1D.h.

Friends And Related Symbol Documentation

◆ RooNumIntFactory

friend class RooNumIntFactory
friend

Definition at line 55 of file RooIntegrator1D.h.

Member Data Documentation

◆ _c

Double_t* RooIntegrator1D::_c
protected

Integrator workspace.

Definition at line 85 of file RooIntegrator1D.h.

◆ _d

Double_t* RooIntegrator1D::_d
protected

Integrator workspace.

Definition at line 86 of file RooIntegrator1D.h.

◆ _doExtrap

Bool_t RooIntegrator1D::_doExtrap
protected

Definition at line 69 of file RooIntegrator1D.h.

◆ _epsAbs

Double_t RooIntegrator1D::_epsAbs
protected

Definition at line 67 of file RooIntegrator1D.h.

◆ _epsRel

Double_t RooIntegrator1D::_epsRel
protected

Definition at line 68 of file RooIntegrator1D.h.

◆ _extrapError

Double_t RooIntegrator1D::_extrapError
protected

Extrapolated value.

Definition at line 82 of file RooIntegrator1D.h.

◆ _extrapValue

Double_t RooIntegrator1D::_extrapValue
protected

Size of integration range.

Definition at line 81 of file RooIntegrator1D.h.

◆ _fixSteps

Int_t RooIntegrator1D::_fixSteps
protected

Definition at line 66 of file RooIntegrator1D.h.

◆ _h

Double_t* RooIntegrator1D::_h
protected

Error on extrapolated value.

Definition at line 83 of file RooIntegrator1D.h.

◆ _maxSteps

Int_t RooIntegrator1D::_maxSteps
protected

Definition at line 64 of file RooIntegrator1D.h.

◆ _minStepsZero

Int_t RooIntegrator1D::_minStepsZero
protected

Definition at line 65 of file RooIntegrator1D.h.

◆ _range

Double_t RooIntegrator1D::_range
protected

Upper integration bound.

Definition at line 80 of file RooIntegrator1D.h.

◆ _rule

SummationRule RooIntegrator1D::_rule
protected

Definition at line 63 of file RooIntegrator1D.h.

◆ _s

Double_t* RooIntegrator1D::_s
protected

Integrator workspace.

Definition at line 84 of file RooIntegrator1D.h.

◆ _savedResult

Double_t RooIntegrator1D::_savedResult
protected

Integrator workspace.

Definition at line 87 of file RooIntegrator1D.h.

◆ _useIntegrandLimits

Bool_t RooIntegrator1D::_useIntegrandLimits
protected

Definition at line 60 of file RooIntegrator1D.h.

◆ _x

Double_t* RooIntegrator1D::_x
protected

Definition at line 91 of file RooIntegrator1D.h.

◆ _xmax

Double_t RooIntegrator1D::_xmax
protected

Lower integration bound.

Definition at line 79 of file RooIntegrator1D.h.

◆ _xmin

Double_t RooIntegrator1D::_xmin
protected

Definition at line 78 of file RooIntegrator1D.h.

Libraries for RooIntegrator1D:

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