RooIntegrator1D implements an adaptive one-dimensional numerical integration algorithm.
Definition at line 22 of file RooIntegrator1D.h.
Public Types | |
enum | SummationRule { Trapezoid , Midpoint } |
![]() | |
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 )) } |
Public Member Functions | |
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. | |
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. | |
RooAbsIntegrator * | clone (const RooAbsFunc &function, const RooNumIntConfig &config) const override |
Clone integrator with new function binding and configuration. Needed by RooNumIntFactory. | |
double | integral (const double *yvec=nullptr) override |
Calculate numeric integral at given set of function binding parameters. | |
TClass * | IsA () 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) |
![]() | |
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. | |
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. | |
virtual RooAbsIntegrator * | clone (const RooAbsFunc &function, const RooNumIntConfig &config) const =0 |
virtual double | integral (const double *yvec=nullptr)=0 |
const RooAbsFunc * | integrand () const |
Return integrand function binding. | |
double | integrand (const double x[]) const |
Return value of integrand at given observable values. | |
TClass * | IsA () const override |
bool | isValid () const |
Is integrator in valid state. | |
bool | printEvalCounter () const |
virtual bool | setLimits (double *, double *) |
virtual bool | setLimits (double xmin, double xmax) |
Interface to set limits on integration. | |
void | setPrintEvalCounter (bool value) |
virtual bool | setUseIntegrandLimits (bool flag) |
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) |
![]() | |
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) |
virtual TClass * | IsA () const |
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. | |
virtual void | Streamer (TBuffer &) |
Stream an object of class TObject. | |
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 () |
do not persist | |
static const char * | DeclFileName () |
![]() | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
![]() | |
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. | |
Protected Types | |
enum | { _nPoints = 5 } |
![]() | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
Protected Member Functions | |
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) |
![]() | |
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 | |
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 | |
![]() | |
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 |
#include <RooIntegrator1D.h>
|
protected |
Enumerator | |
---|---|
_nPoints |
Definition at line 69 of file RooIntegrator1D.h.
Enumerator | |
---|---|
Trapezoid | |
Midpoint |
Definition at line 26 of file RooIntegrator1D.h.
|
inline |
Definition at line 27 of file RooIntegrator1D.h.
RooIntegrator1D::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.
The integration limits are taken from the function binding
Definition at line 78 of file RooIntegrator1D.cxx.
RooIntegrator1D::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.
The integration limits are taken from the function binding
Definition at line 93 of file RooIntegrator1D.cxx.
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 116 of file RooIntegrator1D.cxx.
RooIntegrator1D::RooIntegrator1D | ( | const RooAbsFunc & | function, |
double | xmin, | ||
double | xmax, | ||
const RooNumIntConfig & | config | ||
) |
Construct integrator on given function binding, using specified configuration object and integration range.
Definition at line 144 of file RooIntegrator1D.cxx.
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 330 of file RooIntegrator1D.cxx.
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 362 of file RooIntegrator1D.cxx.
|
inlineoverridevirtual |
Implements RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 47 of file RooIntegrator1D.h.
|
inlineoverridevirtual |
Implements RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 48 of file RooIntegrator1D.h.
|
inlineoverridevirtual |
Implements RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 49 of file RooIntegrator1D.h.
|
inlineoverridevirtual |
Implements RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 50 of file RooIntegrator1D.h.
|
overridevirtual |
Check that our integration range is finite and otherwise return false.
Update the limits from the integrand if requested.
Reimplemented from RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 230 of file RooIntegrator1D.cxx.
|
static |
|
inlinestaticconstexpr |
|
overridevirtual |
Clone integrator with new function binding and configuration. Needed by RooNumIntFactory.
Implements RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 169 of file RooIntegrator1D.cxx.
|
inlinestatic |
Definition at line 92 of file RooIntegrator1D.h.
|
protected |
Extrapolate result to final value.
Definition at line 391 of file RooIntegrator1D.cxx.
|
protected |
Initialize the integrator.
Definition at line 179 of file RooIntegrator1D.cxx.
Calculate numeric integral at given set of function binding parameters.
Implements RooAbsIntegrator.
Definition at line 249 of file RooIntegrator1D.cxx.
|
inlineoverridevirtual |
Reimplemented from RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
Definition at line 92 of file RooIntegrator1D.h.
|
staticprotected |
Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.
Definition at line 53 of file RooIntegrator1D.cxx.
Reimplemented from RooAbsIntegrator.
Definition at line 62 of file RooAbsIntegrator.h.
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 214 of file RooIntegrator1D.cxx.
Interface to set limits on integration.
Reimplemented from RooAbsIntegrator.
Definition at line 63 of file RooAbsIntegrator.cxx.
Interface function that allows to defer limit definition to integrand definition.
Reimplemented from RooAbsIntegrator.
Definition at line 45 of file RooIntegrator1D.h.
|
overridevirtual |
Stream an object of class TObject.
Reimplemented from RooAbsIntegrator.
Reimplemented in RooIntegrator2D.
|
inline |
Definition at line 92 of file RooIntegrator1D.h.
Definition at line 88 of file RooIntegrator1D.h.
|
friend |
Definition at line 54 of file RooIntegrator1D.h.
|
protected |
! Integrator workspace
Definition at line 84 of file RooIntegrator1D.h.
|
protected |
! Integrator workspace
Definition at line 85 of file RooIntegrator1D.h.
|
protected |
Apply conversion step?
Definition at line 68 of file RooIntegrator1D.h.
|
protected |
Absolute convergence tolerance.
Definition at line 66 of file RooIntegrator1D.h.
|
protected |
Relative convergence tolerance.
Definition at line 67 of file RooIntegrator1D.h.
|
protected |
! Error on extrapolated value
Definition at line 81 of file RooIntegrator1D.h.
|
protected |
! Extrapolated value
Definition at line 80 of file RooIntegrator1D.h.
|
protected |
Fixed number of steps.
Definition at line 65 of file RooIntegrator1D.h.
|
protected |
! Integrator workspace
Definition at line 82 of file RooIntegrator1D.h.
|
protected |
Maximum number of steps.
Definition at line 63 of file RooIntegrator1D.h.
|
protected |
Minimum number of steps to declare convergence to zero.
Definition at line 64 of file RooIntegrator1D.h.
|
protected |
! Size of integration range
Definition at line 79 of file RooIntegrator1D.h.
|
protected |
Definition at line 62 of file RooIntegrator1D.h.
|
protected |
! Integrator workspace
Definition at line 83 of file RooIntegrator1D.h.
|
protected |
! Integrator workspace
Definition at line 86 of file RooIntegrator1D.h.
|
protected |
If true limits of function binding are used.
Definition at line 59 of file RooIntegrator1D.h.
|
protected |
Definition at line 90 of file RooIntegrator1D.h.
|
protected |
! Upper integration bound
Definition at line 78 of file RooIntegrator1D.h.
|
protected |
! Lower integration bound
Definition at line 77 of file RooIntegrator1D.h.