Logo ROOT  
Reference Guide
RooRealSumPdf.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooRealSumPdf.h,v 1.10 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_SUM_PDF
17#define ROO_REAL_SUM_PDF
18
19#include "RooAbsPdf.h"
20#include "RooListProxy.h"
21#include "RooAICRegistry.h"
22#include "RooObjCacheManager.h"
23
24class RooRealSumPdf : public RooAbsPdf {
25public:
26
28 RooRealSumPdf(const char *name, const char *title);
29 RooRealSumPdf(const char *name, const char *title, const RooArgList& funcList, const RooArgList& coefList, Bool_t extended=kFALSE) ;
30 RooRealSumPdf(const char *name, const char *title,
31 RooAbsReal& func1, RooAbsReal& func2, RooAbsReal& coef1) ;
32 RooRealSumPdf(const RooRealSumPdf& other, const char* name=0) ;
33 virtual TObject* clone(const char* newname) const { return new RooRealSumPdf(*this,newname) ; }
34 virtual ~RooRealSumPdf() ;
35
36 Double_t evaluate() const ;
37 virtual Bool_t checkObservables(const RooArgSet* nset) const ;
38
39 void computeBatch(cudaStream_t*, double* output, size_t size, RooBatchCompute::DataMap&) const;
40
41 virtual Bool_t forceAnalyticalInt(const RooAbsArg& arg) const { return arg.isFundamental() ; }
42 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=0) const ;
43 Double_t analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=0) const ;
44
45 const RooArgList& funcList() const { return _funcList ; }
46 const RooArgList& coefList() const { return _coefList ; }
47
48 virtual ExtendMode extendMode() const ;
49
50 /// Return expected number of events for extended likelihood calculation, which
51 /// is the sum of all coefficients.
52 virtual Double_t expectedEvents(const RooArgSet* nset) const ;
53
54 virtual Bool_t selfNormalized() const { return getAttribute("BinnedLikelihoodActive") ; }
55
56 void printMetaArgs(std::ostream& os) const ;
57
58
59 virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
60 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
61 Bool_t isBinnedDistribution(const RooArgSet& obs) const ;
62
63 void setFloor(Bool_t flag) { _doFloor = flag ; }
64 Bool_t getFloor() const { return _doFloor ; }
65 static void setFloorGlobal(Bool_t flag) { _doFloorGlobal = flag ; }
66 static Bool_t getFloorGlobal() { return _doFloorGlobal ; }
67
68 virtual CacheMode canNodeBeCached() const { return RooAbsArg::NotAdvised ; } ;
69 virtual void setCacheAndTrackHints(RooArgSet&) ;
70
71protected:
73
75 public:
76 CacheElem() {} ;
77 virtual ~CacheElem() {} ;
78 virtual RooArgList containedArgs(Action) { RooArgList ret(_funcIntList) ; ret.add(_funcNormList) ; return ret ; }
81 } ;
82 mutable RooObjCacheManager _normIntMgr ; //! The integration cache manager
83
84
85 RooListProxy _funcList ; // List of component FUNCs
86 RooListProxy _coefList ; // List of coefficients
87 Bool_t _extended ; // Allow use as extended p.d.f.
88
89 Bool_t _doFloor = false; // Introduce floor at zero in pdf
90 mutable bool _haveWarned{false}; //!
91 static Bool_t _doFloorGlobal ; // Global flag for introducing floor at zero in pdf
92
93private:
94
95 bool haveLastCoef() const {
96 return _funcList.size() == _coefList.size();
97 }
98
99 ClassDef(RooRealSumPdf, 5) // PDF constructed from a sum of (non-pdf) functions
100};
101
102#endif
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
const Bool_t kFALSE
Definition: RtypesCore.h:101
double Double_t
Definition: RtypesCore.h:59
#define ClassDef(name, id)
Definition: Rtypes.h:325
char name[80]
Definition: TGX11.cxx:110
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:75
virtual Bool_t isFundamental() const
Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses overrid...
Definition: RooAbsArg.h:245
@ NotAdvised
Definition: RooAbsArg.h:410
Bool_t getAttribute(const Text_t *name) const
Check if a named attribute is set. By default, all attributes are unset.
Definition: RooAbsArg.cxx:307
RooAbsCacheElement is the abstract base class for objects to be stored in RooAbsCache cache manager o...
virtual Bool_t add(const RooAbsArg &var, Bool_t silent=kFALSE)
Add the specified argument to list.
Storage_t::size_type size() const
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:63
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
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:24
Class RooObjCacheManager is an implementation of class RooCacheManager<RooAbsCacheElement> and specia...
virtual RooArgList containedArgs(Action)
Definition: RooRealSumPdf.h:78
The class RooRealSumPdf implements a PDF constructed from a sum of functions:
Definition: RooRealSumPdf.h:24
virtual ExtendMode extendMode() const
Returns ability of PDF to provide extended likelihood terms.
const RooArgList & funcList() const
Definition: RooRealSumPdf.h:45
RooObjCacheManager _normIntMgr
Definition: RooRealSumPdf.h:82
static Bool_t getFloorGlobal()
Definition: RooRealSumPdf.h:66
Double_t evaluate() const
Calculate the current value.
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: RooRealSumPdf.h:54
RooListProxy _coefList
Definition: RooRealSumPdf.h:86
RooListProxy _funcList
The integration cache manager.
Definition: RooRealSumPdf.h:85
RooRealSumPdf()
Default constructor coverity[UNINIT_CTOR].
virtual Double_t expectedEvents(const RooArgSet *nset) const
Return expected number of events for extended likelihood calculation, which is the sum of all coeffic...
RooSpan< double > evaluateSpan(RooBatchCompute::RunContext &evalData, const RooArgSet *normSet) const
Calculate the value for all values of the observable in evalData.
Bool_t isBinnedDistribution(const RooArgSet &obs) const
Check if all components that depend on obs are binned.
static Bool_t _doFloorGlobal
Definition: RooRealSumPdf.h:91
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &, Double_t, Double_t) const
Interface for returning an optional hint for initial sampling points when constructing a curve projec...
virtual ~RooRealSumPdf()
Destructor.
virtual Bool_t checkObservables(const RooArgSet *nset) const
Check if FUNC is valid for given normalization set.
void setFloor(Bool_t flag)
Definition: RooRealSumPdf.h:63
void printMetaArgs(std::ostream &os) const
Customized printing of arguments of a RooRealSumPdf to more intuitively reflect the contents of the p...
virtual Bool_t forceAnalyticalInt(const RooAbsArg &arg) const
Definition: RooRealSumPdf.h:41
virtual void setCacheAndTrackHints(RooArgSet &)
Label OK'ed components of a RooRealSumPdf with cache-and-track.
Bool_t _extended
Definition: RooRealSumPdf.h:87
virtual TObject * clone(const char *newname) const
Definition: RooRealSumPdf.h:33
Bool_t getFloor() const
Definition: RooRealSumPdf.h:64
virtual std::list< Double_t > * binBoundaries(RooAbsRealLValue &, Double_t, Double_t) const
Retrieve bin boundaries if this distribution is binned in obs.
Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &numVars, const RooArgSet *normSet, const char *rangeName=0) const
Advertise that all integrals can be handled internally.
void computeBatch(cudaStream_t *, double *output, size_t size, RooBatchCompute::DataMap &) const
Base function for computing multiple values of a RooAbsPdf.
Double_t analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=0) const
Implement analytical integrations by deferring integration of component functions to integrators of c...
bool haveLastCoef() const
Definition: RooRealSumPdf.h:95
const RooArgList & coefList() const
Definition: RooRealSumPdf.h:46
virtual CacheMode canNodeBeCached() const
Definition: RooRealSumPdf.h:68
static void setFloorGlobal(Bool_t flag)
Definition: RooRealSumPdf.h:65
A simple container to hold a batch of data values.
Definition: RooSpan.h:34
Mother of all ROOT objects.
Definition: TObject.h:37
std::map< DataKey, RooSpan< const double > > DataMap
This struct enables passing computation data around between elements of a computation graph.
Definition: RunContext.h:31
static void output(int code)
Definition: gifencode.c:226