Logo ROOT  
Reference Guide
Go to the documentation of this file.
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooRealVar.h,v 1.54 2007/05/11 09:11:30 verkerke 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_REAL_VAR
17#define ROO_REAL_VAR
19#include "RooAbsRealLValue.h"
21#include "TString.h"
23#include <list>
24#include <string>
25#include <map>
26#include <memory>
29class RooArgSet ;
30class RooErrorVar ;
37 // Constructors, assignment etc.
38 RooRealVar() ;
39 RooRealVar(const char *name, const char *title,
40 Double_t value, const char *unit= "") ;
41 RooRealVar(const char *name, const char *title, Double_t minValue,
42 Double_t maxValue, const char *unit= "");
43 RooRealVar(const char *name, const char *title, Double_t value,
44 Double_t minValue, Double_t maxValue, const char *unit= "") ;
45 RooRealVar(const RooRealVar& other, const char* name=0);
46 RooRealVar& operator=(const RooRealVar& other);
47 virtual TObject* clone(const char* newname) const { return new RooRealVar(*this,newname); }
48 virtual ~RooRealVar();
50 // Parameter value and error accessors
51 virtual Double_t getValV(const RooArgSet* nset=0) const ;
52 RooSpan<const double> getValBatch(std::size_t begin, std::size_t batchSize,
53 const RooArgSet* = nullptr) const;
55 virtual void setVal(Double_t value);
56 inline Double_t getError() const { return _error>=0?_error:0. ; }
57 inline Bool_t hasError(Bool_t allowZero=kTRUE) const { return allowZero ? (_error>=0) : (_error>0) ; }
58 inline void setError(Double_t value) { _error= value ; }
59 inline void removeError() { _error = -1 ; }
60 inline Double_t getAsymErrorLo() const { return _asymErrLo<=0?_asymErrLo:0. ; }
61 inline Double_t getAsymErrorHi() const { return _asymErrHi>=0?_asymErrHi:0. ; }
62 inline Bool_t hasAsymError(Bool_t allowZero=kTRUE) const { return allowZero ? ((_asymErrHi>=0 && _asymErrLo<=0)) : ((_asymErrHi>0 && _asymErrLo<0)) ; }
63 inline void removeAsymError() { _asymErrLo = 1 ; _asymErrHi = -1 ; }
64 inline void setAsymError(Double_t lo, Double_t hi) { _asymErrLo = lo ; _asymErrHi = hi ; }
65 inline Double_t getErrorLo() const { return _asymErrLo<=0?_asymErrLo:-1*_error ; }
66 inline Double_t getErrorHi() const { return _asymErrHi>=0?_asymErrHi:_error ; }
68 RooErrorVar* errorVar() const ;
70 // Set/get finite fit range limits
71 void setMin(const char* name, Double_t value) ;
72 void setMax(const char* name, Double_t value) ;
73 void setRange(const char* name, Double_t min, Double_t max) ;
74 void setRange(const char* name, RooAbsReal& min, RooAbsReal& max) ;
75 inline void setMin(Double_t value) { setMin(0,value) ; }
76 inline void setMax(Double_t value) { setMax(0,value) ; }
77 inline void setRange(Double_t min, Double_t max) { setRange(0,min,max) ; }
78 inline void setRange(RooAbsReal& min, RooAbsReal& max) { setRange(0,min,max) ; }
80 void setBins(Int_t nBins, const char* name=0);
81 void setBinning(const RooAbsBinning& binning, const char* name=0) ;
83 // RooAbsRealLValue implementation
84 Bool_t hasBinning(const char* name) const ;
85 const RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const ;
86 RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) ;
87 std::list<std::string> getBinningNames() const ;
89 // Set infinite fit range limits
90 /// Remove lower range limit for binning with given name. Empty name means default range.
91 void removeMin(const char* name=0);
92 /// Remove upper range limit for binning with given name. Empty name means default range.
93 void removeMax(const char* name=0);
94 /// Remove range limits for binning with given name. Empty name means default range.
95 void removeRange(const char* name=0);
97 // I/O streaming interface (machine readable)
98 virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
99 virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
101 // We implement a fundamental type of AbsArg that can be stored in a dataset
102 inline virtual Bool_t isFundamental() const { return kTRUE; }
104 // Force to be a leaf-node of any expression tree, even if we have (shape) servers
105 virtual Bool_t isDerived() const {
106 // Does value or shape of this arg depend on any other arg?
107 return !_serverList.empty() || _proxyList.GetEntries()>0;
108 }
110 // Printing interface (human readable)
111 virtual void printValue(std::ostream& os) const ;
112 virtual void printExtras(std::ostream& os) const ;
113 virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
114 virtual Int_t defaultPrintContents(Option_t* opt) const ;
117 TString* format(const RooCmdArg& formatArg) const ;
118 TString* format(Int_t sigDigits, const char *options) const ;
120 static void printScientific(Bool_t flag=kFALSE) ;
121 static void printSigDigits(Int_t ndig=5) ;
123 using RooAbsRealLValue::operator= ;
127 void copyCacheFast(const RooRealVar& other, Bool_t setValDirty=kTRUE) { _value = other._value ; if (setValDirty) setValueDirty() ; }
129 static void cleanup() ;
131 protected:
136 virtual void setVal(Double_t value, const char* rangeName) ;
138 friend class RooAbsRealLValue ;
139 virtual void setValFast(Double_t value) { _value = value ; setValueDirty() ; }
142 virtual Double_t evaluate() const { return _value ; } // dummy because we overloaded getVal()
143 virtual void copyCache(const RooAbsArg* source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE) ;
144 virtual void attachToTree(TTree& t, Int_t bufSize=32000) ;
145 virtual void attachToVStore(RooVectorDataStore& vstore) ;
146 virtual void fillTreeBranch(TTree& t) ;
148 Double_t chopAt(Double_t what, Int_t where) const ;
150 Double_t _error; // Symmetric error associated with current value
151 Double_t _asymErrLo ; // Low side of asymmetric error associated with current value
152 Double_t _asymErrHi ; // High side of asymmetric error associated with current value
153 std::unique_ptr<RooAbsBinning> _binning;
154 RooLinkedList _altNonSharedBinning ; // Non-shareable alternative binnings
156 std::shared_ptr<RooRealVarSharedProperties> sharedProp() const;
157 void installSharedProp(std::shared_ptr<RooRealVarSharedProperties>&& prop);
159 virtual void setExpensiveObjectCache(RooExpensiveObjectCache&) { ; } // variables don't need caches
160 static RooRealVarSharedProperties& _nullProp(); // Null property
161 static std::map<std::string,std::weak_ptr<RooRealVarSharedProperties>>* sharedPropList(); // List of properties shared among clones of a variable
163 std::shared_ptr<RooRealVarSharedProperties> _sharedProp; //! Shared binnings associated with this instance
165 ClassDef(RooRealVar,6) // Real-valued variable
int Int_t
Definition: RtypesCore.h:41
const Bool_t kFALSE
Definition: RtypesCore.h:88
bool Bool_t
Definition: RtypesCore.h:59
double Double_t
Definition: RtypesCore.h:55
const Bool_t kTRUE
Definition: RtypesCore.h:87
const char Option_t
Definition: RtypesCore.h:62
#define ClassDef(name, id)
Definition: Rtypes.h:326
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition: TGX11.cxx:109
float type_of_call hi(const int &, const int &)
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:71
RooRefArray _proxyList
Definition: RooAbsArg.h:564
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition: RooAbsArg.h:466
RefCountList_t _serverList
Definition: RooAbsArg.h:559
RooAbsBinning is the abstract base class for RooRealVar binning definitions This class defines the in...
Definition: RooAbsBinning.h:26
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:59
Double_t _value
Definition: RooAbsReal.h:446
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:28
RooErrorVar is an auxilary class that represents the error of a RooRealVar as a seperate object.
Definition: RooErrorVar.h:24
RooExpensiveObjectCache is a singleton class that serves as repository for objects that are expensive...
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
Definition: RooLinkedList.h:36
Class RooRealVarSharedProperties is an implementation of RooSharedProperties that stores the properti...
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:35
void setMin(Double_t value)
Definition: RooRealVar.h:75
Double_t getAsymErrorLo() const
Definition: RooRealVar.h:60
static std::map< std::string, std::weak_ptr< RooRealVarSharedProperties > > * sharedPropList()
Return a reference to a map of weak pointers to RooRealVarSharedProperties.
Definition: RooRealVar.cxx:56
static void printSigDigits(Int_t ndig=5)
Set number of digits to show when printing RooRealVars.
Double_t _error
Definition: RooRealVar.h:150
void setRange(Double_t min, Double_t max)
Definition: RooRealVar.h:77
Bool_t hasBinning(const char *name) const
Returns true if variable has a binning with 'name'.
Definition: RooRealVar.cxx:327
static RooRealVarSharedProperties & _nullProp()
Return a dummy object to use when properties are not initialised.
Definition: RooRealVar.cxx:80
Double_t getErrorHi() const
Definition: RooRealVar.h:66
Bool_t hasAsymError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:62
std::shared_ptr< RooRealVarSharedProperties > sharedProp() const
Hand out our shared property, create on the fly and register in shared map if necessary.
virtual void printValue(std::ostream &os) const
Print value of variable.
Definition: RooRealVar.cxx:785
static void printScientific(Bool_t flag=kFALSE)
If true, contents of RooRealVars will be printed in scientific notation.
virtual void setValFast(Double_t value)
Definition: RooRealVar.h:139
Double_t _asymErrHi
Definition: RooRealVar.h:152
virtual Int_t defaultPrintContents(Option_t *opt) const
Mapping of Print() option string to RooPrintable contents specifications.
Definition: RooRealVar.cxx:841
Double_t getErrorLo() const
Definition: RooRealVar.h:65
void setMin(const char *name, Double_t value)
Set minimum of name range to given value.
Definition: RooRealVar.cxx:478
void setBins(Int_t nBins, const char *name=0)
Create a uniform binning under name 'name' for this variable.
Definition: RooRealVar.cxx:430
std::unique_ptr< RooAbsBinning > _binning
Definition: RooRealVar.h:153
void installSharedProp(std::shared_ptr< RooRealVarSharedProperties > &&prop)
Install the shared property into the member _sharedProp.
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
Definition: RooRealVar.cxx:720
std::shared_ptr< RooRealVarSharedProperties > _sharedProp
Definition: RooRealVar.h:163
void removeAsymError()
Definition: RooRealVar.h:63
RooLinkedList _altNonSharedBinning
Definition: RooRealVar.h:154
void setError(Double_t value)
Definition: RooRealVar.h:58
virtual void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Detailed printing interface.
Definition: RooRealVar.cxx:853
virtual void printExtras(std::ostream &os) const
Print extras of variable: (asymmetric) error, constant flag, limits and binning.
Definition: RooRealVar.cxx:801
void setMax(Double_t value)
Definition: RooRealVar.h:76
RooSpan< const double > getValBatch(std::size_t begin, std::size_t batchSize, const RooArgSet *=nullptr) const
Return batch of data between begin and end.
Definition: RooRealVar.cxx:261
Double_t chopAt(Double_t what, Int_t where) const
Utility to calculate number of decimals to show based on magnitude of error.
static Int_t _printSigDigits
Definition: RooRealVar.h:134
void setRange(const char *name, Double_t min, Double_t max)
Set range named 'name to [min,max].
Definition: RooRealVar.cxx:539
static void cleanup()
Explicitely deletes the shared properties list on exit to avoid problems with the initialization orde...
Definition: RooRealVar.cxx:71
std::list< std::string > getBinningNames() const
Get a list of all binning names.
Definition: RooRealVar.cxx:393
virtual Bool_t isFundamental() const
Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses overrid...
Definition: RooRealVar.h:102
virtual void attachToVStore(RooVectorDataStore &vstore)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
void removeRange(const char *name=0)
Remove range limits for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:421
Double_t getAsymErrorHi() const
Definition: RooRealVar.h:61
void setMax(const char *name, Double_t value)
Set maximum of name range to given value.
Definition: RooRealVar.cxx:508
void setRange(RooAbsReal &min, RooAbsReal &max)
Definition: RooRealVar.h:78
virtual Double_t getValV(const RooArgSet *nset=0) const
Return value of variable.
Definition: RooRealVar.cxx:248
void setAsymError(Double_t lo, Double_t hi)
Definition: RooRealVar.h:64
void deleteSharedProperties()
Stop sharing properties.
virtual void fillTreeBranch(TTree &t)
Overload RooAbsReal::fillTreeBranch to also fill tree branches with (asymmetric) errors if requested.
Bool_t hasError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:57
virtual ~RooRealVar()
Definition: RooRealVar.cxx:232
Double_t _asymErrLo
Definition: RooRealVar.h:151
RooErrorVar * errorVar() const
Return a RooAbsRealLValue representing the error associated with this variable.
Definition: RooRealVar.cxx:313
Double_t getError() const
Definition: RooRealVar.h:56
void removeMax(const char *name=0)
Remove upper range limit for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:418
virtual void copyCache(const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE)
Copy the cached value of another RooAbsArg to our cache Warning: This function copies the cached valu...
virtual Bool_t isDerived() const
Does value or shape of this arg depend on any other arg?
Definition: RooRealVar.h:105
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
Definition: RooRealVar.cxx:581
void removeMin(const char *name=0)
Remove lower range limit for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:415
static Bool_t _printScientific
Definition: RooRealVar.h:133
TString * format(const RooCmdArg &formatArg) const
Format contents of RooRealVar for pretty printing on RooPlot parameter boxes.
Definition: RooRealVar.cxx:870
const RooAbsBinning & getBinning(const char *name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const
Return binning definition with name.
Definition: RooRealVar.cxx:340
void copyCacheFast(const RooRealVar &other, Bool_t setValDirty=kTRUE)
Definition: RooRealVar.h:127
Default constructor.
Definition: RooRealVar.cxx:89
virtual void attachToTree(TTree &t, Int_t bufSize=32000)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
void removeError()
Definition: RooRealVar.h:59
void setBinning(const RooAbsBinning &binning, const char *name=0)
Add given binning under name 'name' with this variable.
Definition: RooRealVar.cxx:437
virtual TObject * clone(const char *newname) const
Definition: RooRealVar.h:47
virtual void setVal(Double_t value)
Set value of variable to 'value'.
Definition: RooRealVar.cxx:278
RooRealVar & operator=(const RooRealVar &other)
Assign the values of another RooRealVar to this instance.
Definition: RooRealVar.cxx:200
virtual void setExpensiveObjectCache(RooExpensiveObjectCache &)
Definition: RooRealVar.h:159
virtual Double_t evaluate() const
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
Definition: RooRealVar.h:142
bool empty() const
Check if empty.
A simple container to hold a batch of data values.
Definition: RooSpan.h:32
RooVectorDataStore is the abstract base class for data collection that use a TTree as internal storag...
Int_t GetEntries() const
Return the number of objects in array (i.e.
Definition: TObjArray.cxx:522
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:131
A TTree represents a columnar dataset.
Definition: TTree.h:72