Logo ROOT   master
Reference Guide
RooFormulaVar.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Project: RooFit *
3  * Package: RooFitCore *
4  * File: $Id: RooFormulaVar.h,v 1.29 2007/08/09 19:55:47 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_FORMULA_VAR
17 #define ROO_FORMULA_VAR
18 
19 #include "RooAbsReal.h"
20 #include "RooFormula.h"
21 #include "RooArgList.h"
22 #include "RooListProxy.h"
23 #include "RooTrace.h"
24 
25 #include <memory>
26 
27 class RooArgSet ;
28 
29 class RooFormulaVar : public RooAbsReal {
30 public:
31  // Constructors, assignment etc
33  RooFormulaVar(const char *name, const char *title, const char* formula, const RooArgList& dependents, bool checkVariables = true);
34  RooFormulaVar(const char *name, const char *title, const RooArgList& dependents, bool checkVariables = true);
35  RooFormulaVar(const RooFormulaVar& other, const char* name=0);
36  virtual TObject* clone(const char* newname) const { return new RooFormulaVar(*this,newname); }
37 
38  inline Bool_t ok() const { return formula().ok() ; }
39 
40  inline RooAbsArg* getParameter(const char* name) const {
41  // Return pointer to parameter with given name
42  return _actualVars.find(name) ;
43  }
44  inline RooAbsArg* getParameter(Int_t index) const {
45  // Return pointer to parameter at given index
46  return _actualVars.at(index) ;
47  }
48 
49  // I/O streaming interface (machine readable)
50  virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
51  virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
52 
53  // Printing interface (human readable)
54  virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent= "") const ;
55  void printMetaArgs(std::ostream& os) const ;
56 
57  // Debugging
58  void dumpFormula() { formula().dump() ; }
59 
60  virtual Double_t defaultErrorLevel() const ;
61 
62  virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
63  virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
64 
65  // Function evaluation
66  virtual Double_t evaluate() const ;
67 
68  protected:
69  // Post-processing of server redirection
70  virtual Bool_t redirectServersHook(const RooAbsCollection& newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive) ;
71 
72  virtual Bool_t isValidReal(Double_t /*value*/, Bool_t /*printError*/) const {return true;}
73 
74  private:
75  RooFormula& formula() const;
76 
77  RooListProxy _actualVars ; // Actual parameters used by formula engine
78  std::unique_ptr<RooFormula> _formula{nullptr}; //! Formula engine
79  mutable RooArgSet* _nset{nullptr}; //! Normalization set to be passed along to contents
80  TString _formExpr ; // Formula expression string
81 
82  ClassDef(RooFormulaVar,1) // Real-valued function of other RooAbsArgs calculated by a TFormula expression
83 };
84 
85 #endif
TString _formExpr
Normalization set to be passed along to contents.
Definition: RooFormulaVar.h:80
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &, Double_t, Double_t) const
Forward the plot sampling hint from the p.d.f. that defines the observable obs.
Bool_t ok()
Definition: RooFormula.h:53
virtual Bool_t redirectServersHook(const RooAbsCollection &newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive)
Propagate server change information to embedded RooFormula object.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
void dumpFormula()
Definition: RooFormulaVar.h:58
Basic string class.
Definition: TString.h:131
void printMetaArgs(std::ostream &os) const
Add formula expression as meta argument in printing interface.
#define ClassDef(name, id)
Definition: Rtypes.h:322
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
std::unique_ptr< RooFormula > _formula
Definition: RooFormulaVar.h:78
virtual Double_t defaultErrorLevel() const
Return the default error level for MINUIT error analysis If the formula contains one or more RooNLLVa...
RooFormula internally uses ROOT&#39;s TFormula to compute user-defined expressions of RooAbsArgs...
Definition: RooFormula.h:28
RooAbsArg * getParameter(Int_t index) const
Definition: RooFormulaVar.h:44
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
RooAbsArg * at(Int_t idx) const
Return object at given index, or nullptr if index is out of range.
Definition: RooArgList.h:74
RooListProxy _actualVars
Definition: RooFormulaVar.h:77
RooFormula & formula() const
Return reference to internal RooFormula object.
static void indent(ostringstream &buf, int indent_level)
RooArgSet * _nset
Formula engine.
Definition: RooFormulaVar.h:79
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:25
const Bool_t kFALSE
Definition: RtypesCore.h:90
virtual TObject * clone(const char *newname) const
Definition: RooFormulaVar.h:36
void dump() const
DEBUG: Dump state information.
Definition: RooFormula.cxx:293
RooAbsArg * find(const char *name) const
Find object with given name in list.
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:60
A RooFormulaVar is a generic implementation of a real-valued object, which takes a RooArgList of serv...
Definition: RooFormulaVar.h:29
Bool_t ok() const
Definition: RooFormulaVar.h:38
Mother of all ROOT objects.
Definition: TObject.h:37
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects...
virtual void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Print info about this object to the specified stream.
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:21
virtual Bool_t isValidReal(Double_t, Bool_t) const
Interface function to check if given value is a valid value for this object.
Definition: RooFormulaVar.h:72
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:73
RooAbsArg * getParameter(const char *name) const
Definition: RooFormulaVar.h:40
virtual Double_t evaluate() const
Calculate current value of object from internal formula.
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.
char name[80]
Definition: TGX11.cxx:109