Logo ROOT  
Reference Guide
RooProdPdf.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooProdPdf.h,v 1.44 2007/07/16 21:04:28 wouter 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_PROD_PDF
17#define ROO_PROD_PDF
18
19#include "RooAbsPdf.h"
20#include "RooListProxy.h"
21#include "RooLinkedList.h"
22#include "RooAICRegistry.h"
23#include "RooObjCacheManager.h"
24#include "RooCmdArg.h"
25
26#include <vector>
27#include <list>
28#include <string>
29
30namespace RooBatchCompute {
31struct RunContext;
32}
33
36
37class RooProdPdf : public RooAbsPdf {
38public:
39
40 RooProdPdf() ;
41 RooProdPdf(const char *name, const char *title, Double_t cutOff=0);
42 RooProdPdf(const char *name, const char *title,
43 RooAbsPdf& pdf1, RooAbsPdf& pdf2, Double_t cutOff=0) ;
44 RooProdPdf(const char* name, const char* title, const RooArgList& pdfList, Double_t cutOff=0) ;
45 RooProdPdf(const char* name, const char* title, const RooArgSet& fullPdfSet, const RooLinkedList& cmdArgList) ;
46
47 RooProdPdf(const char* name, const char* title, const RooArgSet& fullPdfSet,
48 const RooCmdArg& arg1 , const RooCmdArg& arg2=RooCmdArg(),
49 const RooCmdArg& arg3=RooCmdArg(), const RooCmdArg& arg4=RooCmdArg(),
50 const RooCmdArg& arg5=RooCmdArg(), const RooCmdArg& arg6=RooCmdArg(),
51 const RooCmdArg& arg7=RooCmdArg(), const RooCmdArg& arg8=RooCmdArg()) ;
52
53 RooProdPdf(const char* name, const char* title,
54 const RooCmdArg& arg1, const RooCmdArg& arg2=RooCmdArg(),
55 const RooCmdArg& arg3=RooCmdArg(), const RooCmdArg& arg4=RooCmdArg(),
56 const RooCmdArg& arg5=RooCmdArg(), const RooCmdArg& arg6=RooCmdArg(),
57 const RooCmdArg& arg7=RooCmdArg(), const RooCmdArg& arg8=RooCmdArg()) ;
58
59 RooProdPdf(const RooProdPdf& other, const char* name=0) ;
60 virtual TObject* clone(const char* newname) const { return new RooProdPdf(*this,newname) ; }
61 virtual ~RooProdPdf() ;
62
63 virtual Bool_t checkObservables(const RooArgSet* nset) const ;
64
65 virtual Bool_t forceAnalyticalInt(const RooAbsArg& dep) const ;
66 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=0) const ;
67 Double_t analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=0) const ;
68 virtual Bool_t selfNormalized() const { return _selfNorm ; }
69
70 virtual ExtendMode extendMode() const ;
71 virtual Double_t expectedEvents(const RooArgSet* nset) const ;
72
73 const RooArgList& pdfList() const { return _pdfList ; }
74
75 virtual Int_t getGenerator(const RooArgSet& directVars, RooArgSet &generateVars, Bool_t staticInitOK=kTRUE) const;
76 virtual void initGenerator(Int_t code) ;
77 virtual void generateEvent(Int_t code);
78 virtual Bool_t isDirectGenSafe(const RooAbsArg& arg) const ;
79
80 // Constraint management
81 virtual RooArgSet* getConstraints(const RooArgSet& observables, RooArgSet& constrainedParams, Bool_t stripDisconnected) const ;
82
83 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& obs, Double_t xlo, Double_t xhi) const ;
84 virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
85 Bool_t isBinnedDistribution(const RooArgSet& obs) const ;
86
87 void printMetaArgs(std::ostream& os) const ;
88
89 virtual void selectNormalizationRange(const char* rangeName=0, Bool_t force=kFALSE) ;
90 void fixRefRange(const char* rangeName) ;
91
92 void setSelfNormalized(Bool_t flag) { _selfNorm = flag ; }
94
95
96 Bool_t redirectServersHook(const RooAbsCollection& /*newServerList*/, Bool_t /*mustReplaceAll*/, Bool_t /*nameChange*/, Bool_t /*isRecursive*/) ;
97
98 RooArgSet* getConnectedParameters(const RooArgSet& observables) const ;
99
100 RooArgSet* findPdfNSet(RooAbsPdf& pdf) const ;
101
102 void writeCacheToStream(std::ostream& os, RooArgSet const* nset) const;
103
104private:
105
106 Double_t evaluate() const ;
107 virtual RooSpan<double> evaluateSpan(RooBatchCompute::RunContext& evalData, const RooArgSet* normSet) const;
108
109 RooAbsReal* makeCondPdfRatioCorr(RooAbsReal& term, const RooArgSet& termNset, const RooArgSet& termImpSet, const char* normRange, const char* refRange) const ;
110
111 virtual void getParametersHook(const RooArgSet* /*nset*/, RooArgSet* /*list*/, Bool_t stripDisconnected) const ;
112
113 void initializeFromCmdArgList(const RooArgSet& fullPdfSet, const RooLinkedList& l) ;
114
115 void factorizeProduct(const RooArgSet& normSet, const RooArgSet& intSet,
116 RooLinkedList& termList, RooLinkedList& normList,
117 RooLinkedList& impDepList, RooLinkedList& crossDepList,
118 RooLinkedList& intList) const;
119 std::string makeRGPPName(const char* pfx, const RooArgSet& term, const RooArgSet& iset, const RooArgSet& nset, const char* isetRangeName) const ;
120 void groupProductTerms(std::list<std::vector<RooArgSet*>>& groupedTerms, RooArgSet& outerIntDeps,
121 const RooLinkedList& terms, const RooLinkedList& norms,
122 const RooLinkedList& imps, const RooLinkedList& ints, const RooLinkedList& cross) const ;
123
124
125
126 Int_t getPartIntList(const RooArgSet* nset, const RooArgSet* iset, const char* isetRangeName=0) const ;
127
128 std::vector<RooAbsReal*> processProductTerm(const RooArgSet* nset, const RooArgSet* iset, const char* isetRangeName,
129 const RooArgSet* term,const RooArgSet& termNSet, const RooArgSet& termISet,
130 Bool_t& isOwned, Bool_t forceWrap=kFALSE) const ;
131
132
133 virtual CacheMode canNodeBeCached() const { return RooAbsArg::NotAdvised ; } ;
134 virtual void setCacheAndTrackHints(RooArgSet&) ;
135
136 // The cache object
137 class CacheElem final : public RooAbsCacheElement {
138 public:
140 ~CacheElem() override = default;
141 // Payload
146 std::vector<std::unique_ptr<RooArgSet>> _normList;
148 std::unique_ptr<RooAbsReal> _rearrangedNum{};
149 std::unique_ptr<RooAbsReal> _rearrangedDen{};
150 // Cache management functions
152 void printCompactTreeHook(std::ostream&, const char *, Int_t, Int_t) override ;
153 void writeToStream(std::ostream& os) const ;
154 } ;
155 mutable RooObjCacheManager _cacheMgr ; //! The cache manager
156
157 CacheElem* getCacheElem(RooArgSet const* nset) const ;
158 void rearrangeProduct(CacheElem&) const;
159 RooAbsReal* specializeIntegral(RooAbsReal& orig, const char* targetRangeName) const ;
160 RooAbsReal* specializeRatio(RooFormulaVar& input, const char* targetRangeName) const ;
162
163
164 friend class RooProdGenContext ;
165 virtual RooAbsGenContext* genContext(const RooArgSet &vars, const RooDataSet *prototype=0,
166 const RooArgSet *auxProto=0, Bool_t verbose= kFALSE) const ;
167
168
169 mutable RooAICRegistry _genCode ; //! Registry of composite direct generator codes
170
171 Double_t _cutOff ; // Cutoff parameter for running product
172 RooListProxy _pdfList ; // List of PDF components
173 RooLinkedList _pdfNSetList ; // List of PDF component normalization sets
174 Int_t _extendedIndex ; // Index of extended PDF (if any)
175
176 void useDefaultGen(Bool_t flag=kTRUE) { _useDefaultGen = flag ; }
177 Bool_t _useDefaultGen ; // Use default or distributed event generator
178
179 mutable TNamed* _refRangeName ; // Reference range name for interpretation of conditional products
180
181 Bool_t _selfNorm ; // Is self-normalized
182 RooArgSet _defNormSet ; // Default normalization set
183
184private:
185
186 ClassDef(RooProdPdf,5) // PDF representing a product of PDFs
187};
188
189
190#endif
RooArgList * pRooArgList
Definition: RooProdPdf.h:34
RooLinkedList * pRooLinkedList
Definition: RooProdPdf.h:35
int Int_t
Definition: RtypesCore.h:45
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
const Bool_t kTRUE
Definition: RtypesCore.h:100
#define ClassDef(name, id)
Definition: Rtypes.h:325
char name[80]
Definition: TGX11.cxx:110
RooAICRegistry is a utility class for operator p.d.f classes that keeps track of analytical integrati...
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:72
@ NotAdvised
Definition: RooAbsArg.h:390
RooAbsCacheElement is the abstract base class for objects to be stored in RooAbsCache cache manager o...
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
virtual void removeAll()
Remove all arguments from our set, deleting them if we own them.
virtual RooAbsArg * addClone(const RooAbsArg &var, Bool_t silent=kFALSE)
Add a clone of the specified argument to list.
RooAbsGenContext is the abstract base class for generator contexts of RooAbsPdf objects.
const char * normRange() const
Definition: RooAbsPdf.h:291
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:61
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:22
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:35
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:27
RooDataSet is a container class to hold unbinned data.
Definition: RooDataSet.h:36
A RooFormulaVar is a generic implementation of a real-valued object, which takes a RooArgList of serv...
Definition: RooFormulaVar.h:30
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
Definition: RooLinkedList.h:38
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:24
Class RooObjCacheManager is an implementation of class RooCacheManager<RooAbsCacheElement> and specia...
RooProdGenContext is an efficient implementation of the generator context specific for RooProdPdf PDF...
RooArgList containedArgs(Action) override
Return RooAbsArg components contained in the cache.
~CacheElem() override=default
std::unique_ptr< RooAbsReal > _rearrangedNum
Definition: RooProdPdf.h:148
void printCompactTreeHook(std::ostream &, const char *, Int_t, Int_t) override
Hook function to print cache contents in tree printing of RooProdPdf.
RooArgList _ownedList
Definition: RooProdPdf.h:145
RooArgList _partList
Definition: RooProdPdf.h:142
std::vector< std::unique_ptr< RooArgSet > > _normList
Definition: RooProdPdf.h:146
std::unique_ptr< RooAbsReal > _rearrangedDen
Definition: RooProdPdf.h:149
void writeToStream(std::ostream &os) const
RooProdPdf is an efficient implementation of a product of PDFs of the form.
Definition: RooProdPdf.h:37
void rearrangeProduct(CacheElem &) const
virtual Double_t expectedEvents(const RooArgSet *nset) const
Return the expected number of events associated with the extendable input PDF in the product.
void factorizeProduct(const RooArgSet &normSet, const RooArgSet &intSet, RooLinkedList &termList, RooLinkedList &normList, RooLinkedList &impDepList, RooLinkedList &crossDepList, RooLinkedList &intList) const
Factorize product in irreducible terms for given choice of integration/normalization.
Definition: RooProdPdf.cxx:597
void useDefaultGen(Bool_t flag=kTRUE)
Definition: RooProdPdf.h:176
Int_t _extendedIndex
Definition: RooProdPdf.h:174
Int_t getPartIntList(const RooArgSet *nset, const RooArgSet *iset, const char *isetRangeName=0) const
Return list of (partial) integrals of product terms for integration of p.d.f over observables iset wh...
Definition: RooProdPdf.cxx:781
RooProdPdf()
Default constructor.
Definition: RooProdPdf.cxx:81
virtual Bool_t checkObservables(const RooArgSet *nset) const
Obsolete.
Double_t _cutOff
Registry of composite direct generator codes.
Definition: RooProdPdf.h:171
void printMetaArgs(std::ostream &os) const
Customized printing of arguments of a RooProdPdf to more intuitively reflect the contents of the prod...
virtual RooSpan< double > evaluateSpan(RooBatchCompute::RunContext &evalData, const RooArgSet *normSet) const
Evaluate product of PDFs using input data in evalData.
Definition: RooProdPdf.cxx:508
void writeCacheToStream(std::ostream &os, RooArgSet const *nset) const
Double_t evaluate() const
Calculate current value of object.
Definition: RooProdPdf.cxx:463
TNamed * _refRangeName
Definition: RooProdPdf.h:179
RooAICRegistry _genCode
Definition: RooProdPdf.h:169
RooListProxy _pdfList
Definition: RooProdPdf.h:172
Bool_t isBinnedDistribution(const RooArgSet &obs) const
If all components that depend on obs are binned that so is the product.
virtual Bool_t isDirectGenSafe(const RooAbsArg &arg) const
Forward determination of safety of internal generator code to component p.d.f that would generate the...
Bool_t _useDefaultGen
Definition: RooProdPdf.h:177
Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &numVars, const RooArgSet *normSet, const char *rangeName=0) const
Determine which part (if any) of given integral can be performed analytically.
RooAbsReal * specializeIntegral(RooAbsReal &orig, const char *targetRangeName) const
virtual ExtendMode extendMode() const
If this product contains exactly one extendable p.d.f return the extension abilities of that p....
RooObjCacheManager _cacheMgr
Definition: RooProdPdf.h:155
virtual void initGenerator(Int_t code)
Forward one-time initialization call to component generation initialization methods.
std::string makeRGPPName(const char *pfx, const RooArgSet &term, const RooArgSet &iset, const RooArgSet &nset, const char *isetRangeName) const
Make an appropriate automatic name for a RooGenProdProj object in getPartIntList()
Double_t analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=0) const
Return analytical integral defined by given scenario code.
virtual ~RooProdPdf()
Destructor.
Definition: RooProdPdf.cxx:440
virtual void getParametersHook(const RooArgSet *, RooArgSet *, Bool_t stripDisconnected) const
Bool_t _selfNorm
Definition: RooProdPdf.h:181
RooAbsReal * makeCondPdfRatioCorr(RooAbsReal &term, const RooArgSet &termNset, const RooArgSet &termImpSet, const char *normRange, const char *refRange) const
For single normalization ranges.
RooArgSet * findPdfNSet(RooAbsPdf &pdf) const
Look up user specified normalization set for given input PDF component.
virtual void setCacheAndTrackHints(RooArgSet &)
Label OK'ed components of a RooProdPdf with cache-and-track, and label all RooProdPdf descendants wit...
virtual RooArgSet * getConstraints(const RooArgSet &observables, RooArgSet &constrainedParams, Bool_t stripDisconnected) const
Return all parameter constraint p.d.f.s on parameters listed in constrainedParams.
RooLinkedList _pdfNSetList
Definition: RooProdPdf.h:173
virtual Int_t getGenerator(const RooArgSet &directVars, RooArgSet &generateVars, Bool_t staticInitOK=kTRUE) const
Query internal generation capabilities of component p.d.f.s and aggregate capabilities into master co...
virtual void selectNormalizationRange(const char *rangeName=0, Bool_t force=kFALSE)
Interface function used by test statistics to freeze choice of range for interpretation of conditiona...
void setSelfNormalized(Bool_t flag)
Definition: RooProdPdf.h:92
RooArgSet * getConnectedParameters(const RooArgSet &observables) const
Return all parameter constraint p.d.f.s on parameters listed in constrainedParams.
Double_t calculate(const RooProdPdf::CacheElem &cache, Bool_t verbose=kFALSE) const
Calculate running product of pdfs terms, using the supplied normalization set in 'normSetList' for ea...
Definition: RooProdPdf.cxx:474
RooArgSet _defNormSet
Definition: RooProdPdf.h:182
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &obs, Double_t xlo, Double_t xhi) const
Forward the plot sampling hint from the p.d.f. that defines the observable obs.
RooAbsReal * specializeRatio(RooFormulaVar &input, const char *targetRangeName) const
CacheElem * getCacheElem(RooArgSet const *nset) const
The cache manager.
Definition: RooProdPdf.cxx:447
Bool_t redirectServersHook(const RooAbsCollection &, Bool_t, Bool_t, Bool_t)
Implement support for node removal.
const RooArgList & pdfList() const
Definition: RooProdPdf.h:73
void groupProductTerms(std::list< std::vector< RooArgSet * > > &groupedTerms, RooArgSet &outerIntDeps, const RooLinkedList &terms, const RooLinkedList &norms, const RooLinkedList &imps, const RooLinkedList &ints, const RooLinkedList &cross) const
Group product into terms that can be calculated independently.
void fixRefRange(const char *rangeName)
virtual Bool_t forceAnalyticalInt(const RooAbsArg &dep) const
Force RooRealIntegral to offer all observables for internal integration.
virtual TObject * clone(const char *newname) const
Definition: RooProdPdf.h:60
virtual RooAbsGenContext * genContext(const RooArgSet &vars, const RooDataSet *prototype=0, const RooArgSet *auxProto=0, Bool_t verbose=kFALSE) const
Return generator context optimized for generating events from product p.d.f.s.
void initializeFromCmdArgList(const RooArgSet &fullPdfSet, const RooLinkedList &l)
Initialize RooProdPdf configuration from given list of RooCmdArg configuration arguments and set of '...
Definition: RooProdPdf.cxx:375
virtual Bool_t selfNormalized() const
Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.
Definition: RooProdPdf.h:68
virtual CacheMode canNodeBeCached() const
Definition: RooProdPdf.h:133
virtual void generateEvent(Int_t code)
Generate a single event with configuration specified by 'code' Defer internal generation to component...
std::vector< RooAbsReal * > processProductTerm(const RooArgSet *nset, const RooArgSet *iset, const char *isetRangeName, const RooArgSet *term, const RooArgSet &termNSet, const RooArgSet &termISet, Bool_t &isOwned, Bool_t forceWrap=kFALSE) const
Calculate integrals of factorized product terms over observables iset while normalized to observables...
void setDefNormSet(const RooArgSet &nset)
Definition: RooProdPdf.h:93
virtual std::list< Double_t > * binBoundaries(RooAbsRealLValue &, Double_t, Double_t) const
Forward the plot sampling hint from the p.d.f. that defines the observable obs.
A simple container to hold a batch of data values.
Definition: RooSpan.h:34
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:37
Namespace for dispatching RooFit computations to various backends.
This struct enables passing computation data around between elements of a computation graph.
Definition: RunContext.h:31
auto * l
Definition: textangle.C:4