Logo ROOT  
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 #include <list>
27 
28 class RooArgSet ;
29 
30 class RooFormulaVar : public RooAbsReal {
31 public:
32  // Constructors, assignment etc
34  RooFormulaVar(const char *name, const char *title, const char* formula, const RooArgList& dependents, bool checkVariables = true);
35  RooFormulaVar(const char *name, const char *title, const RooArgList& dependents, bool checkVariables = true);
36  RooFormulaVar(const RooFormulaVar& other, const char* name=0);
37  virtual TObject* clone(const char* newname) const { return new RooFormulaVar(*this,newname); }
38 
39  inline Bool_t ok() const { return getFormula().ok() ; }
40 
41  /// Return pointer to parameter with given name.
42  inline RooAbsArg* getParameter(const char* name) const {
43  return _actualVars.find(name) ;
44  }
45  /// Return pointer to parameter at given index.
46  inline RooAbsArg* getParameter(Int_t index) const {
47  return _actualVars.at(index) ;
48  }
49 
50  // I/O streaming interface (machine readable)
51  virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
52  virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
53 
54  // Printing interface (human readable)
55  virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent= "") const ;
56  void printMetaArgs(std::ostream& os) const ;
57 
58  // Debugging
59  /// Dump the formula to stdout.
60  void dumpFormula() { getFormula().dump() ; }
61  /// Get reference to the internal formula object.
62  const RooFormula& formula() const {
63  return getFormula();
64  }
65 
66  virtual Double_t defaultErrorLevel() const ;
67 
68  virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
69  virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
70 
71  // Function evaluation
72  virtual Double_t evaluate() const ;
73  RooSpan<double> evaluateSpan(BatchHelpers::RunContext& evalData, const RooArgSet* normSet) const;
74 
75  protected:
76  // Post-processing of server redirection
77  virtual Bool_t redirectServersHook(const RooAbsCollection& newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive) ;
78 
79  virtual Bool_t isValidReal(Double_t /*value*/, Bool_t /*printError*/) const {return true;}
80 
81  private:
82  RooFormula& getFormula() const;
83 
84  RooListProxy _actualVars ; // Actual parameters used by formula engine
85  std::unique_ptr<RooFormula> _formula{nullptr}; //! Formula engine
86  mutable RooArgSet* _nset{nullptr}; //! Normalization set to be passed along to contents
87  TString _formExpr ; // Formula expression string
88 
89  ClassDef(RooFormulaVar,1) // Real-valued function of other RooAbsArgs calculated by a TFormula expression
90 };
91 
92 #endif
RooFormulaVar::_actualVars
RooListProxy _actualVars
Definition: RooFormulaVar.h:84
RooFormulaVar::defaultErrorLevel
virtual Double_t defaultErrorLevel() const
Return the default error level for MINUIT error analysis If the formula contains one or more RooNLLVa...
Definition: RooFormulaVar.cxx:284
RooFormula
RooFormula internally uses ROOT's TFormula to compute user-defined expressions of RooAbsArgs.
Definition: RooFormula.h:34
RooFormulaVar::evaluate
virtual Double_t evaluate() const
Calculate current value of object from internal formula.
Definition: RooFormulaVar.cxx:149
RooAbsReal.h
RooFormulaVar::plotSamplingHint
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
Definition: RooFormulaVar.cxx:259
RooFormulaVar::binBoundaries
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
Definition: RooFormulaVar.cxx:240
RooFormulaVar::printMultiline
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.
Definition: RooFormulaVar.cxx:189
RooArgList
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:21
RooFormulaVar::readFromStream
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
Definition: RooFormulaVar.cxx:215
RooAbsCollection::find
RooAbsArg * find(const char *name) const
Find object with given name in list.
Definition: RooAbsCollection.cxx:813
RooFormula::dump
void dump() const
DEBUG: Dump state information.
Definition: RooFormula.cxx:297
indent
static void indent(ostringstream &buf, int indent_level)
Definition: TClingCallFunc.cxx:87
RooFormula.h
RooAbsReal
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:61
RooFormulaVar::getFormula
RooFormula & getFormula() const
Return reference to internal RooFormula object.
Definition: RooFormulaVar.cxx:132
RooArgList::at
RooAbsArg * at(Int_t idx) const
Return object at given index, or nullptr if index is out of range.
Definition: RooArgList.h:70
RooFormulaVar::ok
Bool_t ok() const
Definition: RooFormulaVar.h:39
RooFormulaVar::writeToStream
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
Definition: RooFormulaVar.cxx:226
TString
Basic string class.
Definition: TString.h:136
RooFormulaVar::_formExpr
TString _formExpr
Normalization set to be passed along to contents.
Definition: RooFormulaVar.h:87
RooFormulaVar::_formula
std::unique_ptr< RooFormula > _formula
Definition: RooFormulaVar.h:85
bool
RooFormulaVar::_nset
RooArgSet * _nset
Formula engine.
Definition: RooFormulaVar.h:86
BatchHelpers::RunContext
Data that has to be passed around when evaluating functions / PDFs.
Definition: RunContext.h:32
RooFormulaVar::getParameter
RooAbsArg * getParameter(Int_t index) const
Return pointer to parameter at given index.
Definition: RooFormulaVar.h:46
RooTrace.h
RooFormulaVar
A RooFormulaVar is a generic implementation of a real-valued object, which takes a RooArgList of serv...
Definition: RooFormulaVar.h:30
RooFormula::ok
Bool_t ok() const
Definition: RooFormula.h:59
RooFormulaVar::getParameter
RooAbsArg * getParameter(const char *name) const
Return pointer to parameter with given name.
Definition: RooFormulaVar.h:42
RooFormulaVar::isValidReal
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:79
kFALSE
const Bool_t kFALSE
Definition: RtypesCore.h:92
RooFormulaVar::clone
virtual TObject * clone(const char *newname) const
Definition: RooFormulaVar.h:37
RooAbsCollection
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
Definition: RooAbsCollection.h:31
RooFormulaVar::printMetaArgs
void printMetaArgs(std::ostream &os) const
Add formula expression as meta argument in printing interface.
Definition: RooFormulaVar.cxx:204
RooListProxy
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:24
RooListProxy.h
Double_t
double Double_t
Definition: RtypesCore.h:59
RooFormulaVar::formula
const RooFormula & formula() const
Get reference to the internal formula object.
Definition: RooFormulaVar.h:62
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:325
name
char name[80]
Definition: TGX11.cxx:110
genreflex::verbose
bool verbose
Definition: rootcling_impl.cxx:133
RooFormulaVar::dumpFormula
void dumpFormula()
Dump the formula to stdout.
Definition: RooFormulaVar.h:60
RooAbsArg
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:72
RooFormulaVar::evaluateSpan
RooSpan< double > evaluateSpan(BatchHelpers::RunContext &evalData, const RooArgSet *normSet) const
Evaluate the formula for all entries of our servers found in inputData.
Definition: RooFormulaVar.cxx:157
RooAbsRealLValue
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
Definition: RooAbsRealLValue.h:31
RooArgList.h
RooFormulaVar::redirectServersHook
virtual Bool_t redirectServersHook(const RooAbsCollection &newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive)
Propagate server change information to embedded RooFormula object.
Definition: RooFormulaVar.cxx:176
RooFormulaVar::RooFormulaVar
RooFormulaVar()
Definition: RooFormulaVar.h:33
RooSpan
A simple container to hold a batch of data values.
Definition: RooSpan.h:34
RooArgSet
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:29
int