RooRealIntegral.h

Go to the documentation of this file.

/*****************************************************************************
 * Project: RooFit                                                           *
 * Package: RooFitCore                                                       *
 *    File: $Id: RooRealIntegral.h,v 1.44 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_INTEGRAL
#define ROO_REAL_INTEGRAL
 
#include "RooAbsReal.h"
#include "RooArgSet.h"
#include "RooAbsPdf.h"
#include "RooRealProxy.h"
#include "RooSetProxy.h"
#include "RooListProxy.h"
#include <list>
 
class RooArgSet ;
class TH1F ;
class RooAbsCategory ;
class RooRealVar ;
class RooAbsIntegrator ;
class RooNumIntConfig ;
 
class RooRealIntegral : public RooAbsReal {
public:
 
  // Constructors, assignment etc
  RooRealIntegral() ;
  RooRealIntegral(const char *name, const char *title, const RooAbsReal& function, const RooArgSet& depList,
        const RooArgSet* funcNormSet=nullptr, const RooNumIntConfig* config=nullptr, const char* rangeName=nullptr) ;
  RooRealIntegral(const RooRealIntegral& other, const char* name=nullptr);
  TObject* clone(const char* newname) const override { return new RooRealIntegral(*this,newname); }
  ~RooRealIntegral() override;
 
  double getValV(const RooArgSet* set=nullptr) const override ;
 
  bool isValid() const override { return _valid; }
 
  void printMultiline(std::ostream& os, Int_t contents, bool verbose=false, TString indent="") const override ;
  void printMetaArgs(std::ostream& os) const override ;
 
  const RooArgSet& numIntCatVars() const { return _sumList ; }
  const RooArgSet& numIntRealVars() const { return _intList ; }
  const RooArgSet& anaIntVars() const { return _anaList ; }
 
  RooArgSet intVars() const { RooArgSet tmp(_sumList) ; tmp.add(_intList) ; tmp.add(_anaList) ; tmp.add(_facList) ; return tmp ; }
  const char* intRange() const { return _rangeName ? _rangeName->GetName() : nullptr ; }
  const RooAbsReal& integrand() const { return *_function; }
 
  void setCacheNumeric(bool flag) {
    // If true, value of this integral is cached if it is (partially numeric)
    _cacheNum = flag ;
  }
 
  bool getCacheNumeric() {
    // If true, value of this integral is cached if it is (partially numeric)
    return _cacheNum ;
  }
 
  static void setCacheAllNumeric(Int_t ndim) ;
 
  static Int_t getCacheAllNumeric() ;
 
  std::list<double>* plotSamplingHint(RooAbsRealLValue& obs, double xlo, double xhi) const override {
    // Forward plot sampling hint of integrand
    return _function->plotSamplingHint(obs,xlo,xhi) ;
  }
 
  RooAbsReal* createIntegral(const RooArgSet& iset, const RooArgSet* nset=nullptr, const RooNumIntConfig* cfg=nullptr, const char* rangeName=nullptr) const override ;
 
  void setAllowComponentSelection(bool allow);
  bool getAllowComponentSelection() const;
 
  void translate(RooFit::Detail::CodeSquashContext &ctx) const override;
protected:
 
  mutable bool _valid = false;
  bool _respectCompSelect = true;
 
  const RooArgSet& parameters() const ;
 
  enum IntOperMode { Hybrid, Analytic, PassThrough } ;
  //friend class RooAbsPdf ;
 
  bool initNumIntegrator() const;
  void autoSelectDirtyMode() ;
 
  virtual double sum() const ;
  virtual double integrate() const ;
  virtual double jacobianProduct() const ;
 
  // Evaluation and validation implementation
  double evaluate() const override ;
  bool isValidReal(double value, bool printError=false) const override ;
  bool servesExclusively(const RooAbsArg* server,const RooArgSet& exclLVBranches, const RooArgSet& allBranches) const ;
 
 
  bool redirectServersHook(const RooAbsCollection& newServerList,
                 bool mustReplaceAll, bool nameChange, bool isRecursive) override ;
 
  // Internal function to get the normalization set for the integrated
  // function. By default, we will take the normalization set from the function
  // proxy, but _funcNormSet will be used if it is set.
  inline RooArgSet const* funcNormSet() const {
    return _funcNormSet ? _funcNormSet.get() : _function.nset();
  }
 
  // Function pointer and integrands list
  mutable RooSetProxy _sumList ; ///< Set of discrete observable over which is summed numerically
  mutable RooSetProxy _intList ; ///< Set of continuous observables over which is integrated numerically
  mutable RooSetProxy _anaList ; ///< Set of observables over which is integrated/summed analytically
  mutable RooSetProxy _jacList ; ///< Set of lvalue observables over which is analytically integration that have a non-unit Jacobian
  mutable RooSetProxy _facList ; ///< Set of observables on which function does not depends, which are integrated nevertheless
 
  mutable RooArgSet   _facListOwned ;  ///< Owned components in _facList
  RooRealProxy       _function ;     ///<Function being integration
  std::unique_ptr<RooArgSet> _funcNormSet; ///< Optional normalization set passed to function
 
  mutable RooArgSet       _saveInt ; ///<! do not persist
  mutable RooArgSet       _saveSum ; ///<! do not persist
 
  RooNumIntConfig* _iconfig = nullptr;
 
  mutable RooListProxy _sumCat ; ///<! do not persist
 
  Int_t _mode = 0;
  IntOperMode _intOperMode = Hybrid;   ///< integration operation mode
 
  mutable bool _restartNumIntEngine = false; ///<! do not persist
  mutable std::unique_ptr<RooAbsIntegrator> _numIntEngine;  ///<! do not persist
  mutable std::unique_ptr<RooAbsFunc> _numIntegrand;        ///<! do not persist
 
  TNamed* _rangeName = nullptr;
 
  mutable std::unique_ptr<RooArgSet> _params; ///<! cache for set of parameters
 
  bool _cacheNum = false;           ///< Cache integral if numeric
  static Int_t _cacheAllNDim ; ///<! Cache all integrals with given numeric dimension
 
  ClassDefOverride(RooRealIntegral,4) // Real-valued function representing an integral over a RooAbsReal object
};
 
#endif