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
28class RooArgSet ;
29
30class RooFormulaVar : public RooAbsReal {
31public:
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 const char* expression() const { return _formExpr.Data(); }
41 const RooArgList& dependents() const { return _actualVars; }
42
43 /// Return pointer to parameter with given name.
44 inline RooAbsArg* getParameter(const char* name) const {
45 return _actualVars.find(name) ;
46 }
47 /// Return pointer to parameter at given index.
48 inline RooAbsArg* getParameter(Int_t index) const {
49 return _actualVars.at(index) ;
50 }
51
52 // I/O streaming interface (machine readable)
53 virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
54 virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
55
56 // Printing interface (human readable)
57 virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent= "") const ;
58 void printMetaArgs(std::ostream& os) const ;
59
60 // Debugging
61 /// Dump the formula to stdout.
62 void dumpFormula() { getFormula().dump() ; }
63 /// Get reference to the internal formula object.
64 const RooFormula& formula() const {
65 return getFormula();
66 }
67
68 virtual Double_t defaultErrorLevel() const ;
69
70 virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
71 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
72
73 // Function evaluation
74 virtual Double_t evaluate() const ;
76 inline void computeBatch(cudaStream_t* stream, double* output, size_t nEvents, RooBatchCompute::DataMap& dataMap) const
77 {
78 formula().computeBatch(stream, output, nEvents, dataMap);
79 }
80
81
82 protected:
83 // Post-processing of server redirection
84 virtual Bool_t redirectServersHook(const RooAbsCollection& newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive) ;
85
86 virtual Bool_t isValidReal(Double_t /*value*/, Bool_t /*printError*/) const {return true;}
87
88 private:
89 RooFormula& getFormula() const;
90
91 RooListProxy _actualVars ; // Actual parameters used by formula engine
92 std::unique_ptr<RooFormula> _formula{nullptr}; //! Formula engine
93 mutable RooArgSet* _nset{nullptr}; //! Normalization set to be passed along to contents
94 TString _formExpr ; // Formula expression string
95
96 ClassDef(RooFormulaVar,1) // Real-valued function of other RooAbsArgs calculated by a TFormula expression
97};
98
99#endif
const Bool_t kFALSE
Definition: RtypesCore.h:101
double Double_t
Definition: RtypesCore.h:59
#define ClassDef(name, id)
Definition: Rtypes.h:325
static void indent(ostringstream &buf, int indent_level)
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
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
RooAbsArg * find(const char *name) const
Find object with given name in list.
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
RooAbsArg * at(Int_t idx) const
Return object at given index, or nullptr if index is out of range.
Definition: RooArgList.h:110
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:35
A RooFormulaVar is a generic implementation of a real-valued object, which takes a RooArgList of serv...
Definition: RooFormulaVar.h:30
RooAbsArg * getParameter(Int_t index) const
Return pointer to parameter at given index.
Definition: RooFormulaVar.h:48
RooAbsArg * getParameter(const char *name) const
Return pointer to parameter with given name.
Definition: RooFormulaVar.h:44
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
RooListProxy _actualVars
Definition: RooFormulaVar.h:91
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.
const char * expression() const
Definition: RooFormulaVar.h:40
virtual Double_t evaluate() const
Calculate current value of object from internal formula.
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
RooFormula & getFormula() const
Return reference to internal RooFormula object.
const RooFormula & formula() const
Get reference to the internal formula object.
Definition: RooFormulaVar.h:64
virtual TObject * clone(const char *newname) const
Definition: RooFormulaVar.h:37
virtual Bool_t isValidReal(Double_t, Bool_t) const
Interface function to check if given value is a valid value for this object. Returns true unless over...
Definition: RooFormulaVar.h:86
void dumpFormula()
Dump the formula to stdout.
Definition: RooFormulaVar.h:62
void computeBatch(cudaStream_t *stream, double *output, size_t nEvents, RooBatchCompute::DataMap &dataMap) const
Base function for computing multiple values of a RooAbsReal.
Definition: RooFormulaVar.h:76
Bool_t ok() const
Definition: RooFormulaVar.h:39
const RooArgList & dependents() const
Definition: RooFormulaVar.h:41
TString _formExpr
Normalization set to be passed along to contents.
Definition: RooFormulaVar.h:94
virtual Bool_t redirectServersHook(const RooAbsCollection &newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive)
Propagate server change information to embedded RooFormula object.
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
RooSpan< double > evaluateSpan(RooBatchCompute::RunContext &evalData, const RooArgSet *normSet) const
Evaluate the formula for all entries of our servers found in inputData.
std::unique_ptr< RooFormula > _formula
Definition: RooFormulaVar.h:92
RooArgSet * _nset
Formula engine.
Definition: RooFormulaVar.h:93
void printMetaArgs(std::ostream &os) const
Add formula expression as meta argument in printing interface.
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's TFormula to compute user-defined expressions of RooAbsArgs.
Definition: RooFormula.h:32
void computeBatch(cudaStream_t *, double *output, size_t nEvents, RooBatchCompute::DataMap &) const
Definition: RooFormula.cxx:412
void dump() const
DEBUG: Dump state information.
Definition: RooFormula.cxx:296
Bool_t ok() const
Definition: RooFormula.h:57
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:24
A simple container to hold a batch of data values.
Definition: RooSpan.h:34
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:136
const char * Data() const
Definition: TString.h:369
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