Logo ROOT  
Reference Guide
RooRealIntegral.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooRealIntegral.h,v 1.44 2007/05/11 09:11:30 verkerke Exp $
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_REAL_INTEGRAL
17#define ROO_REAL_INTEGRAL
18
19#include "RooAbsReal.h"
20#include "RooArgSet.h"
21#include "RooAbsPdf.h"
22#include "RooRealProxy.h"
23#include "RooSetProxy.h"
24#include "RooListProxy.h"
25
26class RooArgSet ;
27class TH1F ;
28class RooAbsCategory ;
29class RooRealVar ;
30class RooAbsIntegrator ;
31class RooNumIntConfig ;
32
34public:
35
36 // Constructors, assignment etc
38 RooRealIntegral(const char *name, const char *title, const RooAbsReal& function, const RooArgSet& depList,
39 const RooArgSet* funcNormSet=0, const RooNumIntConfig* config=0, const char* rangeName=0) ;
40 RooRealIntegral(const RooRealIntegral& other, const char* name=0);
41 virtual TObject* clone(const char* newname) const { return new RooRealIntegral(*this,newname); }
42 virtual ~RooRealIntegral();
43
44 virtual Double_t getValV(const RooArgSet* set=0) const ;
45
46 Bool_t isValid() const { return _valid; }
47
48 void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
49 void printMetaArgs(std::ostream& os) const ;
50
51 const RooArgSet& numIntCatVars() const { return _sumList ; }
52 const RooArgSet& numIntRealVars() const { return _intList ; }
53 const RooArgSet& anaIntVars() const { return _anaList ; }
54
55 RooArgSet intVars() const { RooArgSet tmp(_sumList) ; tmp.add(_intList) ; tmp.add(_anaList) ; tmp.add(_facList) ; return tmp ; }
56 const char* intRange() { return _rangeName ? _rangeName->GetName() : 0 ; }
57 const RooAbsReal& integrand() const { return _function.arg() ; }
58
59 void setCacheNumeric(Bool_t flag) {
60 // If true, value of this interal is cached if it is (partially numeric)
61 _cacheNum = flag ;
62 }
63
65 // If true, value of this interal is cached if it is (partially numeric)
66 return _cacheNum ;
67 }
68
69 static void setCacheAllNumeric(Int_t ndim) ;
70
71 static Int_t getCacheAllNumeric() ;
72
73 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& obs, Double_t xlo, Double_t xhi) const {
74 // Forward plot sampling hint of integrand
75 return _function.arg().plotSamplingHint(obs,xlo,xhi) ;
76 }
77
78 virtual RooAbsReal* createIntegral(const RooArgSet& iset, const RooArgSet* nset=0, const RooNumIntConfig* cfg=0, const char* rangeName=0) const ;
79
82
83protected:
84
85 mutable Bool_t _valid;
87
88 const RooArgSet& parameters() const ;
89
91 //friend class RooAbsPdf ;
92
94 void autoSelectDirtyMode() ;
95
96 virtual Double_t sum() const ;
97 virtual Double_t integrate() const ;
98 virtual Double_t jacobianProduct() const ;
99
100 // Evaluation and validation implementation
101 Double_t evaluate() const ;
102 virtual Bool_t isValidReal(Double_t value, Bool_t printError=kFALSE) const ;
103 Bool_t servesExclusively(const RooAbsArg* server,const RooArgSet& exclLVBranches, const RooArgSet& allBranches) const ;
104
105
106 virtual Bool_t redirectServersHook(const RooAbsCollection& newServerList,
107 Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive) ;
108
109 // Function pointer and integrands list
110 mutable RooSetProxy _sumList ; // Set of discrete observable over which is summed numerically
111 mutable RooSetProxy _intList ; // Set of continuous observables over which is integrated numerically
112 mutable RooSetProxy _anaList ; // Set of observables over which is integrated/summed analytically
113 mutable RooSetProxy _jacList ; // Set of lvalue observables over which is analytically integration that have a non-unit Jacobian
114 mutable RooSetProxy _facList ; // Set of observables on which function does not depends, which are integrated nevertheless
115
116 mutable RooArgSet _facListOwned ; // Owned components in _facList
117 RooRealProxy _function ; // Function being integration
118 RooArgSet* _funcNormSet ; // Optional normalization set passed to function
119
120 mutable RooArgSet _saveInt ; //! do not persist
121 mutable RooArgSet _saveSum ; //! do not persist
122
124
125 mutable RooListProxy _sumCat ; //! do not persist
126
128 IntOperMode _intOperMode ; // integration operation mode
129
130 mutable Bool_t _restartNumIntEngine ; //! do not persist
131 mutable RooAbsIntegrator* _numIntEngine ; //! do not persist
132 mutable RooAbsFunc *_numIntegrand; //! do not persist
133
135
136 mutable RooArgSet* _params ; //! cache for set of parameters
137
138 Bool_t _cacheNum ; // Cache integral if numeric
139 static Int_t _cacheAllNDim ; //! Cache all integrals with given numeric dimension
140
141
142 virtual void operModeHook() ; // cache operation mode
143
144 ClassDef(RooRealIntegral,3) // Real-valued function representing an integral over a RooAbsReal object
145};
146
147#endif
int Int_t
Definition: RtypesCore.h:43
const Bool_t kFALSE
Definition: RtypesCore.h:90
bool Bool_t
Definition: RtypesCore.h:61
double Double_t
Definition: RtypesCore.h:57
#define ClassDef(name, id)
Definition: Rtypes.h:322
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition: TGX11.cxx:109
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:73
RooAbsCategory is the base class for objects that represent a discrete value with a finite number of ...
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
Abstract interface for evaluating a real-valued function of one real variable and performing numerica...
Definition: RooAbsFunc.h:23
RooAbsIntegrator is the abstract interface for integrators of real-valued functions that implement th...
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:60
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &, Double_t, Double_t) const
Definition: RooAbsReal.h:314
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
virtual Bool_t add(const RooAbsCollection &col, Bool_t silent=kFALSE)
Add a collection of arguments to this collection by calling add() for each element in the source coll...
Definition: RooArgSet.h:88
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:25
RooNumIntConfig holds the configuration parameters of the various numeric integrators used by RooReal...
RooRealIntegral performs hybrid numerical/analytical integrals of RooAbsReal objects.
RooNumIntConfig * _iconfig
do not persist
const RooArgSet & numIntRealVars() const
virtual void operModeHook()
Cache all integrals with given numeric dimension.
Bool_t getCacheNumeric()
RooArgSet * _params
Bool_t getAllowComponentSelection() const
Check if component selection is allowed.
Bool_t servesExclusively(const RooAbsArg *server, const RooArgSet &exclLVBranches, const RooArgSet &allBranches) const
Utility function that returns true if 'object server' is a server to exactly one of the RooAbsArgs in...
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &obs, Double_t xlo, Double_t xhi) const
RooRealProxy _function
Int_t _mode
do not persist
const RooArgSet & anaIntVars() const
RooArgSet intVars() const
void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Print the state of this object to the specified output stream.
RooSetProxy _intList
const RooAbsReal & integrand() const
const RooArgSet & numIntCatVars() const
RooSetProxy _facList
RooAbsFunc * _numIntegrand
do not persist
static void setCacheAllNumeric(Int_t ndim)
Global switch to cache all integral values that integrate at least ndim dimensions numerically.
IntOperMode _intOperMode
RooArgSet * _funcNormSet
RooAbsIntegrator * _numIntEngine
do not persist
virtual ~RooRealIntegral()
void printMetaArgs(std::ostream &os) const
Customized printing of arguments of a RooRealIntegral to more intuitively reflect the contents of the...
const RooArgSet & parameters() const
virtual Bool_t isValidReal(Double_t value, Bool_t printError=kFALSE) const
Check if current value is valid.
TNamed * _rangeName
do not persist
void setCacheNumeric(Bool_t flag)
virtual RooAbsReal * createIntegral(const RooArgSet &iset, const RooArgSet *nset=0, const RooNumIntConfig *cfg=0, const char *rangeName=0) const
Create an object that represents the integral of the function over one or more observables listed in ...
RooSetProxy _jacList
virtual TObject * clone(const char *newname) const
virtual Double_t sum() const
Perform summation of list of category dependents to be integrated.
RooSetProxy _anaList
Bool_t _restartNumIntEngine
RooSetProxy _sumList
Bool_t initNumIntegrator() const
(Re)Initialize numerical integration engine if necessary.
virtual Bool_t redirectServersHook(const RooAbsCollection &newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive)
Intercept server redirects and reconfigure internal object accordingly.
virtual Double_t getValV(const RooArgSet *set=0) const
Return value of object.
virtual Double_t jacobianProduct() const
Return product of jacobian terms originating from analytical integration.
RooListProxy _sumCat
Bool_t _cacheNum
cache for set of parameters
static Int_t getCacheAllNumeric()
Return minimum dimensions of numeric integration for which values are cached.
RooArgSet _saveSum
do not persist
static Int_t _cacheAllNDim
void setAllowComponentSelection(Bool_t allow)
Set component selection to be allowed/forbidden.
Double_t evaluate() const
Perform the integration and return the result.
virtual Double_t integrate() const
Perform hybrid numerical/analytical integration over all real-valued dependents.
void autoSelectDirtyMode()
Set appropriate cache operation mode for integral depending on cache operation mode of server objects...
Bool_t _respectCompSelect
const char * intRange()
RooArgSet _facListOwned
Bool_t isValid() const
Check if current value is valid.
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:35
RooSetProxy is the concrete proxy for RooArgSet objects.
Definition: RooSetProxy.h:24
const T & arg() const
Return reference to object held in proxy.
1-D histogram with a float per channel (see TH1 documentation)}
Definition: TH1.h:571
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
virtual const char * GetName() const
Returns name of object.
Definition: TNamed.h:47
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:131
void function(const Char_t *name_, T fun, const Char_t *docstring=0)
Definition: RExports.h:151