Logo ROOT  
Reference Guide
No Matches
Go to the documentation of this file.
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
19#include "RooAbsPdf.h"
20#include "RooListProxy.h"
21#include "RooLinkedList.h"
22#include "RooAICRegistry.h"
23#include "RooObjCacheManager.h"
24#include "RooCmdArg.h"
26#include <vector>
27#include <list>
28#include <string>
33class RooProdPdf : public RooAbsPdf {
36 RooProdPdf() ;
37 RooProdPdf(const char *name, const char *title, Double_t cutOff=0);
38 RooProdPdf(const char *name, const char *title,
39 RooAbsPdf& pdf1, RooAbsPdf& pdf2, Double_t cutOff=0) ;
40 RooProdPdf(const char* name, const char* title, const RooArgList& pdfList, Double_t cutOff=0) ;
41 RooProdPdf(const char* name, const char* title, const RooArgSet& fullPdfSet, const RooLinkedList& cmdArgList) ;
43 RooProdPdf(const char* name, const char* title, const RooArgSet& fullPdfSet,
44 const RooCmdArg& arg1 , const RooCmdArg& arg2=RooCmdArg(),
45 const RooCmdArg& arg3=RooCmdArg(), const RooCmdArg& arg4=RooCmdArg(),
46 const RooCmdArg& arg5=RooCmdArg(), const RooCmdArg& arg6=RooCmdArg(),
47 const RooCmdArg& arg7=RooCmdArg(), const RooCmdArg& arg8=RooCmdArg()) ;
49 RooProdPdf(const char* name, const char* title,
50 const RooCmdArg& arg1, const RooCmdArg& arg2=RooCmdArg(),
51 const RooCmdArg& arg3=RooCmdArg(), const RooCmdArg& arg4=RooCmdArg(),
52 const RooCmdArg& arg5=RooCmdArg(), const RooCmdArg& arg6=RooCmdArg(),
53 const RooCmdArg& arg7=RooCmdArg(), const RooCmdArg& arg8=RooCmdArg()) ;
55 RooProdPdf(const RooProdPdf& other, const char* name=0) ;
56 virtual TObject* clone(const char* newname) const { return new RooProdPdf(*this,newname) ; }
57 virtual ~RooProdPdf() ;
59 virtual Bool_t checkObservables(const RooArgSet* nset) const ;
61 virtual Bool_t forceAnalyticalInt(const RooAbsArg& dep) const ;
62 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=0) const ;
63 Double_t analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=0) const ;
64 virtual Bool_t selfNormalized() const { return _selfNorm ; }
66 virtual ExtendMode extendMode() const ;
67 virtual Double_t expectedEvents(const RooArgSet* nset) const ;
69 const RooArgList& pdfList() const { return _pdfList ; }
71 virtual Int_t getGenerator(const RooArgSet& directVars, RooArgSet &generateVars, Bool_t staticInitOK=kTRUE) const;
72 virtual void initGenerator(Int_t code) ;
73 virtual void generateEvent(Int_t code);
74 virtual Bool_t isDirectGenSafe(const RooAbsArg& arg) const ;
76 // Constraint management
77 virtual RooArgSet* getConstraints(const RooArgSet& observables, RooArgSet& constrainedParams, Bool_t stripDisconnected) const ;
79 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& obs, Double_t xlo, Double_t xhi) const ;
80 virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
81 Bool_t isBinnedDistribution(const RooArgSet& obs) const ;
83 void printMetaArgs(std::ostream& os) const ;
85 virtual void selectNormalizationRange(const char* rangeName=0, Bool_t force=kFALSE) ;
86 void fixRefRange(const char* rangeName) ;
88 void setSelfNormalized(Bool_t flag) { _selfNorm = flag ; }
92 Bool_t redirectServersHook(const RooAbsCollection& /*newServerList*/, Bool_t /*mustReplaceAll*/, Bool_t /*nameChange*/, Bool_t /*isRecursive*/) ;
94 RooArgSet* getConnectedParameters(const RooArgSet& observables) const ;
96 RooArgSet* findPdfNSet(RooAbsPdf const& pdf) const ;
98 void writeCacheToStream(std::ostream& os, RooArgSet const* nset) const;
100 std::unique_ptr<RooArgSet> fillNormSetForServer(RooArgSet const& normSet, RooAbsArg const& server) const;
104 double evaluate() const;
105 void computeBatch(cudaStream_t*, double* output, size_t nEvents, RooFit::Detail::DataMap const&) const;
106 inline bool canComputeBatchWithCuda() const { return true; }
108 RooAbsReal* makeCondPdfRatioCorr(RooAbsReal& term, const RooArgSet& termNset, const RooArgSet& termImpSet, const char* normRange, const char* refRange) const ;
110 virtual void getParametersHook(const RooArgSet* /*nset*/, RooArgSet* /*list*/, Bool_t stripDisconnected) const ;
112 void initializeFromCmdArgList(const RooArgSet& fullPdfSet, const RooLinkedList& l) ;
114 void factorizeProduct(const RooArgSet& normSet, const RooArgSet& intSet,
115 RooLinkedList& termList, RooLinkedList& normList,
116 RooLinkedList& impDepList, RooLinkedList& crossDepList,
117 RooLinkedList& intList) const;
118 std::string makeRGPPName(const char* pfx, const RooArgSet& term, const RooArgSet& iset, const RooArgSet& nset, const char* isetRangeName) const ;
119 void groupProductTerms(std::list<std::vector<RooArgSet*>>& groupedTerms, RooArgSet& outerIntDeps,
120 const RooLinkedList& terms, const RooLinkedList& norms,
121 const RooLinkedList& imps, const RooLinkedList& ints, const RooLinkedList& cross) const ;
125 Int_t getPartIntList(const RooArgSet* nset, const RooArgSet* iset, const char* isetRangeName=0) const ;
127 std::vector<RooAbsReal*> processProductTerm(const RooArgSet* nset, const RooArgSet* iset, const char* isetRangeName,
128 const RooArgSet* term,const RooArgSet& termNSet, const RooArgSet& termISet,
129 Bool_t& isOwned, Bool_t forceWrap=kFALSE) const ;
132 virtual CacheMode canNodeBeCached() const { return RooAbsArg::NotAdvised ; } ;
133 virtual void setCacheAndTrackHints(RooArgSet&) ;
135 // The cache object
136 class CacheElem final : public RooAbsCacheElement {
137 public:
139 ~CacheElem() override = default;
140 // Payload
145 std::vector<std::unique_ptr<RooArgSet>> _normList;
147 std::unique_ptr<RooAbsReal> _rearrangedNum{};
148 std::unique_ptr<RooAbsReal> _rearrangedDen{};
149 // Cache management functions
151 void printCompactTreeHook(std::ostream&, const char *, Int_t, Int_t) override ;
152 void writeToStream(std::ostream& os) const ;
153 } ;
154 mutable RooObjCacheManager _cacheMgr ; //! The cache manager
156 CacheElem* getCacheElem(RooArgSet const* nset) const ;
157 void rearrangeProduct(CacheElem&) const;
158 RooAbsReal* specializeIntegral(RooAbsReal& orig, const char* targetRangeName) const ;
159 RooAbsReal* specializeRatio(RooFormulaVar& input, const char* targetRangeName) const ;
160 Double_t calculate(const RooProdPdf::CacheElem& cache, Bool_t verbose=kFALSE) const ;
163 friend class RooProdGenContext ;
164 virtual RooAbsGenContext* genContext(const RooArgSet &vars, const RooDataSet *prototype=0,
165 const RooArgSet *auxProto=0, Bool_t verbose= kFALSE) const ;
168 mutable RooAICRegistry _genCode ; //! Registry of composite direct generator codes
170 Double_t _cutOff ; // Cutoff parameter for running product
171 RooListProxy _pdfList ; // List of PDF components
172 std::vector<std::unique_ptr<RooArgSet>> _pdfNSetList ; // List of PDF component normalization sets
173 Int_t _extendedIndex ; // Index of extended PDF (if any)
175 void useDefaultGen(Bool_t flag=kTRUE) { _useDefaultGen = flag ; }
176 Bool_t _useDefaultGen ; // Use default or distributed event generator
178 mutable TNamed* _refRangeName ; // Reference range name for interpretation of conditional products
180 Bool_t _selfNorm ; // Is self-normalized
181 RooArgSet _defNormSet ; // Default normalization set
185 ClassDef(RooProdPdf,6) // PDF representing a product of PDFs
RooArgList * pRooArgList
Definition RooProdPdf.h:30
RooLinkedList * pRooLinkedList
Definition RooProdPdf.h:31
const Bool_t kFALSE
Definition RtypesCore.h:101
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:69
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:292
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:64
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...
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
RooListProxy is the concrete proxy for RooArgList objects.
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:147
void printCompactTreeHook(std::ostream &, const char *, Int_t, Int_t) override
Hook function to print cache contents in tree printing of RooProdPdf.
std::vector< std::unique_ptr< RooArgSet > > _normList
Definition RooProdPdf.h:145
std::unique_ptr< RooAbsReal > _rearrangedDen
Definition RooProdPdf.h:148
void writeToStream(std::ostream &os) const
RooProdPdf is an efficient implementation of a product of PDFs of the form.
Definition RooProdPdf.h:33
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.
void useDefaultGen(Bool_t flag=kTRUE)
Definition RooProdPdf.h:175
Int_t _extendedIndex
Definition RooProdPdf.h:173
void computeBatch(cudaStream_t *, double *output, size_t nEvents, RooFit::Detail::DataMap const &) const
Evaluate product of PDFs in batch mode.
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...
Default constructor.
virtual Bool_t checkObservables(const RooArgSet *nset) const
std::vector< std::unique_ptr< RooArgSet > > _pdfNSetList
Definition RooProdPdf.h:172
std::unique_ptr< RooArgSet > fillNormSetForServer(RooArgSet const &normSet, RooAbsArg const &server) const
Fills a RooArgSet to be used as the normalization set for a server, given a normalization set for thi...
Double_t _cutOff
Registry of composite direct generator codes.
Definition RooProdPdf.h:170
void printMetaArgs(std::ostream &os) const
Customized printing of arguments of a RooProdPdf to more intuitively reflect the contents of the prod...
void writeCacheToStream(std::ostream &os, RooArgSet const *nset) const
double evaluate() const
Calculate current value of object.
TNamed * _refRangeName
Definition RooProdPdf.h:178
RooAICRegistry _genCode
Definition RooProdPdf.h:168
RooListProxy _pdfList
Definition RooProdPdf.h:171
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:176
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:154
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()
virtual void getParametersHook(const RooArgSet *, RooArgSet *, Bool_t stripDisconnected) const
Bool_t _selfNorm
Definition RooProdPdf.h:180
RooArgSet * findPdfNSet(RooAbsPdf const &pdf) const
Look up user specified normalization set for given input PDF component.
RooAbsReal * makeCondPdfRatioCorr(RooAbsReal &term, const RooArgSet &termNset, const RooArgSet &termImpSet, const char *normRange, const char *refRange) const
For single normalization ranges.
bool canComputeBatchWithCuda() const
Definition RooProdPdf.h:106
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.
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:88
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...
RooArgSet _defNormSet
Definition RooProdPdf.h:181
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.
Bool_t redirectServersHook(const RooAbsCollection &, Bool_t, Bool_t, Bool_t)
Implement support for node removal.
const RooArgList & pdfList() const
Definition RooProdPdf.h:69
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:56
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 '...
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:64
virtual CacheMode canNodeBeCached() const
Definition RooProdPdf.h:132
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:89
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.
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
Mother of all ROOT objects.
Definition TObject.h:41
auto * l
Definition textangle.C:4
static void output(int code)
Definition gifencode.c:226