RooRealSumPdf.h

Go to the documentation of this file.

/*****************************************************************************
 * Project: RooFit                                                           *
 * Package: RooFitCore                                                       *
 *    File: $Id: RooRealSumPdf.h,v 1.10 2007/05/11 09:11:30 verkerke Exp $
 * Authors:                                                                  *
 *   WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu       *
 *   DK, David Kirkby,    UC Irvine,         dkirkby@uci.edu                 *
 *                                                                           *
 * Copyright (c) 2000-2005, Regents of the University of California          *
 *                          and Stanford University. All rights reserved.    *
 *                                                                           *
 * Redistribution and use in source and binary forms,                        *
 * with or without modification, are permitted according to the terms        *
 * listed in LICENSE (http://roofit.sourceforge.net/license.txt)             *
 *****************************************************************************/
#ifndef ROO_REAL_SUM_PDF
#define ROO_REAL_SUM_PDF
 
#include "RooAbsPdf.h"
#include "RooListProxy.h"
#include "RooAICRegistry.h"
#include "RooObjCacheManager.h"
 
class RooRealSumPdf : public RooAbsPdf {
public:
 
  RooRealSumPdf() ;
  RooRealSumPdf(const char *name, const char *title);
  RooRealSumPdf(const char *name, const char *title, const RooArgList& funcList, const RooArgList& coefList, bool extended=false) ;
  RooRealSumPdf(const char *name, const char *title,
         RooAbsReal& func1, RooAbsReal& func2, RooAbsReal& coef1) ;
  RooRealSumPdf(const RooRealSumPdf& other, const char* name=nullptr) ;
  TObject* clone(const char* newname) const override { return new RooRealSumPdf(*this,newname) ; }
 
  double evaluate() const override ;
  bool checkObservables(const RooArgSet* nset) const override ;
 
  void doEval(RooFit::EvalContext &) const override;
 
  bool forceAnalyticalInt(const RooAbsArg& arg) const override { return arg.isFundamental() ; }
  Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=nullptr) const override ;
  double analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=nullptr) const override ;
 
  const RooArgList& funcList() const { return _funcList ; }
  const RooArgList& coefList() const { return _coefList ; }
 
  ExtendMode extendMode() const override ;
 
  /// Return expected number of events for extended likelihood calculation, which
  /// is the sum of all coefficients.
  double expectedEvents(const RooArgSet* nset) const override ;
 
  bool selfNormalized() const override { return getAttribute("BinnedLikelihoodActive") ; }
 
  void printMetaArgs(std::ostream& os) const override ;
 
 
  std::list<double>* binBoundaries(RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/) const override ;
  std::list<double>* plotSamplingHint(RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/) const override ;
  bool isBinnedDistribution(const RooArgSet& obs) const override  ;
 
  void setFloor(bool flag) { _doFloor = flag ; }
  bool getFloor() const { return _doFloor ; }
  static void setFloorGlobal(bool flag) { _doFloorGlobal = flag ; }
  static bool getFloorGlobal() { return _doFloorGlobal ; }
 
  CacheMode canNodeBeCached() const override { return RooAbsArg::NotAdvised ; } ;
  void setCacheAndTrackHints(RooArgSet&) override ;
 
  std::unique_ptr<RooAbsArg> compileForNormSet(RooArgSet const &normSet, RooFit::Detail::CompileContext & ctx) const override;
 
  std::unique_ptr<RooAbsReal> createExpectedEventsFunc(const RooArgSet* nset) const override;
 
  void translate(RooFit::Detail::CodeSquashContext &ctx) const override;
 
protected:
 
  class CacheElem : public RooAbsCacheElement {
  public:
    CacheElem()  {} ;
    RooArgList containedArgs(Action) override { RooArgList ret(_funcIntList) ; ret.add(_funcNormList) ; return ret ; }
    RooArgList _funcIntList ;
    RooArgList _funcNormList ;
  } ;
  mutable RooObjCacheManager _normIntMgr ; ///<! The integration cache manager
 
 
  RooListProxy _funcList ;  ///<  List of component FUNCs
  RooListProxy _coefList ;  ///<  List of coefficients
  bool _extended ;        ///< Allow use as extended p.d.f.
 
  bool _doFloor = false; ///< Introduce floor at zero in pdf
  mutable bool _haveWarned{false}; ///<!
  static bool _doFloorGlobal ; ///< Global flag for introducing floor at zero in pdf
 
private:
 
  friend class RooAddPdf;
  friend class RooAddition;
  friend class RooRealSumFunc;
 
  static void initializeFuncsAndCoefs(RooAbsReal const& caller,
                                      const RooArgList& inFuncList, const RooArgList& inCoefList,
                                      RooArgList& funcList, RooArgList& coefList);
 
  static double evaluate(RooAbsReal const& caller,
                         RooArgList const& funcList,
                         RooArgList const& coefList,
                         bool doFloor,
                         bool & hasWarnedBefore);
 
  static std::string translateImpl(RooFit::Detail::CodeSquashContext &ctx, RooAbsArg const *klass,
                                   RooArgList const &funcList, RooArgList const &coefList, bool normalize=false);
 
  static bool checkObservables(RooAbsReal const &caller, RooArgSet const *nset, RooArgList const &funcList,
                               RooArgList const &coefList);
 
  static Int_t getAnalyticalIntegralWN(RooAbsReal const& caller, RooObjCacheManager & normIntMgr,
                                       RooArgList const& funcList, RooArgList const& coefList,
                                       RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName);
  static double analyticalIntegralWN(RooAbsReal const& caller, RooObjCacheManager & normIntMgr,
                                     RooArgList const& funcList, RooArgList const& coefList,
                                     Int_t code, const RooArgSet* normSet, const char* rangeName,
                                     bool hasWarnedBefore);
 
  static std::list<double>* binBoundaries(
          RooArgList const& funcList, RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/);
  static std::list<double>* plotSamplingHint(
          RooArgList const& funcList, RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/);
  static bool isBinnedDistribution(RooArgList const& funcList, const RooArgSet& obs);
 
  static void printMetaArgs(RooArgList const& funcList, RooArgList const& coefList, std::ostream& os);
 
  static void setCacheAndTrackHints(RooArgList const& funcList, RooArgSet& trackNodes);
 
  inline void setExtended(bool extended) { _extended = extended; }
 
  ClassDefOverride(RooRealSumPdf, 5) // PDF constructed from a sum of (non-pdf) functions
};
 
#endif