Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAddPdf.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooAddPdf.h,v 1.46 2007/07/12 20:30: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_ADD_PDF
17#define ROO_ADD_PDF
18
19#include "RooAbsPdf.h"
20#include "RooListProxy.h"
21#include "RooSetProxy.h"
22#include "RooAICRegistry.h"
23#include "RooObjCacheManager.h"
24#include "RooNameReg.h"
25#include "RooTrace.h"
26
27#include <vector>
28#include <list>
29#include <utility>
30
31class AddCacheElem;
32
33class RooAddPdf : public RooAbsPdf {
34public:
35
37 RooAddPdf(const char *name, const char *title=nullptr);
38 RooAddPdf(const char *name, const char *title,
39 RooAbsPdf& pdf1, RooAbsPdf& pdf2, RooAbsReal& coef1) ;
40 RooAddPdf(const char *name, const char *title, const RooArgList& pdfList) ;
41 RooAddPdf(const char *name, const char *title, const RooArgList& pdfList, const RooArgList& coefList, bool recursiveFraction=false) ;
42
43 RooAddPdf(const RooAddPdf& other, const char* name=nullptr) ;
44 TObject* clone(const char* newname) const override { return new RooAddPdf(*this,newname) ; }
46
47 bool checkObservables(const RooArgSet* nset) const override;
48
49 /// Force RooRealIntegral to offer all observables for internal integration.
50 bool forceAnalyticalInt(const RooAbsArg& /*dep*/) const override {
51 return true ;
52 }
53 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=nullptr) const override;
54 double analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=nullptr) const override;
55 bool selfNormalized() const override {
56 // P.d.f is self normalized
57 return true ;
58 }
59
60 ExtendMode extendMode() const override {
61 // Return extended mode capabilities
63 }
64 /// Return expected number of events for extended likelihood calculation, which
65 /// is the sum of all coefficients.
66 double expectedEvents(const RooArgSet* nset) const override;
67
68 const RooArgList& pdfList() const {
69 // Return list of component p.d.fs
70 return _pdfList ;
71 }
72 const RooArgList& coefList() const {
73 // Return list of coefficients of component p.d.f.s
74 return _coefList ;
75 }
76
77 void fixCoefNormalization(const RooArgSet& refCoefNorm) ;
78 void fixCoefRange(const char* rangeName) ;
79
80 const RooArgSet& getCoefNormalization() const { return _refCoefNorm ; }
82
83 void resetErrorCounters(Int_t resetValue=10) override;
84
85 std::list<double>* plotSamplingHint(RooAbsRealLValue& obs, double xlo, double xhi) const override;
86 std::list<double>* binBoundaries(RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/) const override;
87 bool isBinnedDistribution(const RooArgSet& obs) const override;
88
89 void printMetaArgs(std::ostream& os) const override;
90
91 CacheMode canNodeBeCached() const override { return RooAbsArg::NotAdvised ; };
92 void setCacheAndTrackHints(RooArgSet&) override;
93
94 void translate(RooFit::Detail::CodeSquashContext &ctx) const override;
95
96 protected:
97 void selectNormalization(const RooArgSet* depSet=nullptr, bool force=false) override;
98 void selectNormalizationRange(const char* rangeName=nullptr, bool force=false) override;
99
100 mutable RooSetProxy _refCoefNorm ; ///< Reference observable set for coefficient interpretation
101 mutable TNamed* _refCoefRangeName = nullptr ; ///< Reference range name for coefficient interpreation
102
103 mutable std::vector<double> _coefCache; ///<! Transient cache with transformed values of coefficients
104
105
106 mutable RooObjCacheManager _projCacheMgr ; //! Manager of cache with coefficient projections and transformations
107 AddCacheElem* getProjCache(const RooArgSet* nset, const RooArgSet* iset=nullptr) const ;
108 void updateCoefficients(AddCacheElem& cache, const RooArgSet* nset, bool syncCoefValues=true) const ;
109
110
111 friend class RooAddGenContext ;
112 friend class RooAddModel ;
113 RooAbsGenContext* genContext(const RooArgSet &vars, const RooDataSet *prototype=nullptr,
114 const RooArgSet* auxProto=nullptr, bool verbose= false) const override;
115
116
117 double evaluate() const override {
118 return getValV(nullptr);
119 }
120 double getValV(const RooArgSet* set=nullptr) const override ;
121 void computeBatch(cudaStream_t*, double* output, size_t nEvents, RooFit::Detail::DataMap const&) const override;
122 inline bool canComputeBatchWithCuda() const override { return true; }
123
124
125 mutable RooAICRegistry _codeReg; ///<! Registry of component analytical integration codes
126
127 RooListProxy _pdfList ; ///< List of component PDFs
128 RooListProxy _coefList ; ///< List of coefficients
129 mutable RooArgList* _snormList{nullptr}; ///<! List of supplemental normalization factors
130
131 bool _haveLastCoef = false; ///< Flag indicating if last PDFs coefficient was supplied in the ctor
132 bool _allExtendable = false; ///< Flag indicating if all PDF components are extendable
133 bool _recursive = false; ///< Flag indicating is fractions are treated recursively
134
135 mutable Int_t _coefErrCount ; ///<! Coefficient error counter
136
137 bool redirectServersHook(const RooAbsCollection&, bool, bool, bool) override;
138
139private:
140 std::pair<const RooArgSet*, AddCacheElem*> getNormAndCache(const RooArgSet* nset) const;
142 mutable std::unique_ptr<const RooArgSet> _copyOfLastNormSet = nullptr; ///<!
143
145
146 ClassDefOverride(RooAddPdf,5) // PDF representing a sum of PDFs
147};
148
149#endif
#define TRACE_DESTROY
Definition RooTrace.h:24
#define TRACE_CREATE
Definition RooTrace.h:23
#define ClassDefOverride(name, id)
Definition Rtypes.h:339
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:78
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
RooAbsGenContext is the abstract base class for generator contexts of RooAbsPdf objects.
@ MustBeExtended
Definition RooAbsPdf.h:265
@ CanNotBeExtended
Definition RooAbsPdf.h:265
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
RooAddGenContext is an efficient implementation of the generator context specific for RooAddPdf PDFs.
RooAddModel is an efficient implementation of a sum of PDFs of the form.
Definition RooAddModel.h:27
RooAddPdf is an efficient implementation of a sum of PDFs of the form.
Definition RooAddPdf.h:33
RooListProxy _coefList
List of coefficients.
Definition RooAddPdf.h:128
RooArgList * _snormList
! List of supplemental normalization factors
Definition RooAddPdf.h:129
bool _allExtendable
Flag indicating if all PDF components are extendable.
Definition RooAddPdf.h:132
RooAICRegistry _codeReg
! Registry of component analytical integration codes
Definition RooAddPdf.h:125
RooFit::UniqueId< RooArgSet >::Value_t _idOfLastUsedNormSet
!
Definition RooAddPdf.h:141
double analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Return analytical integral defined by given scenario code.
const char * getCoefRange() const
Definition RooAddPdf.h:81
std::unique_ptr< const RooArgSet > _copyOfLastNormSet
!
Definition RooAddPdf.h:142
TObject * clone(const char *newname) const override
Definition RooAddPdf.h:44
void updateCoefficients(AddCacheElem &cache, const RooArgSet *nset, bool syncCoefValues=true) const
Update the coefficient values in the given cache element: calculate new remainder fraction,...
void translate(RooFit::Detail::CodeSquashContext &ctx) const override
This function defines a translation for each RooAbsReal based object that can be used to express the ...
Int_t _coefErrCount
! Coefficient error counter
Definition RooAddPdf.h:135
bool canComputeBatchWithCuda() const override
Definition RooAddPdf.h:122
bool _haveLastCoef
Flag indicating if last PDFs coefficient was supplied in the ctor.
Definition RooAddPdf.h:131
void selectNormalization(const RooArgSet *depSet=nullptr, bool force=false) override
Interface function used by test statistics to freeze choice of observables for interpretation of frac...
void printMetaArgs(std::ostream &os) const override
Customized printing of arguments of a RooAddPdf to more intuitively reflect the contents of the produ...
void finalizeConstruction()
void setCacheAndTrackHints(RooArgSet &) override
Label OK'ed components of a RooAddPdf with cache-and-track.
const RooArgList & coefList() const
Definition RooAddPdf.h:72
bool _recursive
Flag indicating is fractions are treated recursively.
Definition RooAddPdf.h:133
RooObjCacheManager _projCacheMgr
Definition RooAddPdf.h:106
RooAbsGenContext * genContext(const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false) const override
Return specialized context to efficiently generate toy events from RooAddPdfs return RooAbsPdf::genCo...
bool checkObservables(const RooArgSet *nset) const override
Check if PDF is valid for given normalization set.
bool selfNormalized() const override
Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.
Definition RooAddPdf.h:55
void fixCoefNormalization(const RooArgSet &refCoefNorm)
By default the interpretation of the fraction coefficients is performed in the contextual choice of o...
std::pair< const RooArgSet *, AddCacheElem * > getNormAndCache(const RooArgSet *nset) const
Look up projection cache and per-PDF norm sets.
RooSetProxy _refCoefNorm
Reference observable set for coefficient interpretation.
Definition RooAddPdf.h:100
void selectNormalizationRange(const char *rangeName=nullptr, bool force=false) override
Interface function used by test statistics to freeze choice of range for interpretation of fraction c...
Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &numVars, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Determine which part (if any) of given integral can be performed analytically.
void resetErrorCounters(Int_t resetValue=10) override
Reset error counter to given value, limiting the number of future error messages for this pdf to 'res...
ExtendMode extendMode() const override
Returns ability of PDF to provide extended likelihood terms.
Definition RooAddPdf.h:60
bool forceAnalyticalInt(const RooAbsArg &) const override
Force RooRealIntegral to offer all observables for internal integration.
Definition RooAddPdf.h:50
double expectedEvents(const RooArgSet *nset) const override
Return expected number of events for extended likelihood calculation, which is the sum of all coeffic...
double getValV(const RooArgSet *set=nullptr) const override
Calculate and return the current value.
double evaluate() const override
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
Definition RooAddPdf.h:117
void fixCoefRange(const char *rangeName)
By default, fraction coefficients are assumed to refer to the default fit range.
CacheMode canNodeBeCached() const override
Definition RooAddPdf.h:91
AddCacheElem * getProjCache(const RooArgSet *nset, const RooArgSet *iset=nullptr) const
Manager of cache with coefficient projections and transformations.
std::list< double > * plotSamplingHint(RooAbsRealLValue &obs, double xlo, double xhi) const override
Loop over components for plot sampling hints and merge them if there are multiple.
RooListProxy _pdfList
List of component PDFs.
Definition RooAddPdf.h:127
TNamed * _refCoefRangeName
Reference range name for coefficient interpreation.
Definition RooAddPdf.h:101
const RooArgList & pdfList() const
Definition RooAddPdf.h:68
void computeBatch(cudaStream_t *, double *output, size_t nEvents, RooFit::Detail::DataMap const &) const override
Compute addition of PDFs in batches.
bool isBinnedDistribution(const RooArgSet &obs) const override
If all components that depend on obs are binned, so is their sum.
bool redirectServersHook(const RooAbsCollection &, bool, bool, bool) override
The cache manager.
~RooAddPdf() override
Definition RooAddPdf.h:45
std::vector< double > _coefCache
! Transient cache with transformed values of coefficients
Definition RooAddPdf.h:103
const RooArgSet & getCoefNormalization() const
Definition RooAddPdf.h:80
std::list< double > * binBoundaries(RooAbsRealLValue &, double, double) const override
Loop over components for plot sampling hints and merge them if there are multiple.
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:55
RooDataSet is a container class to hold unbinned data.
Definition RooDataSet.h:57
A class to maintain the context for squashing of RooFit models into code.
static const char * str(const TNamed *ptr)
Return C++ string corresponding to given TNamed pointer.
Definition RooNameReg.h:37
Class RooObjCacheManager is an implementation of class RooCacheManager<RooAbsCacheElement> and specia...
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
A UniqueId can be added as a class member to enhance any class with a unique identifier for each inst...
Definition UniqueId.h:39
unsigned long Value_t
Definition UniqueId.h:41
static void output()