Logo ROOT   6.19/01
Reference Guide
RooRealVar.h
Go to the documentation of this file.
1 /*****************************************************************************
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
18 
19 #include <list>
20 #include <string>
21 #include <cmath>
22 #include <float.h>
23 #include "TString.h"
24 
25 #include "RooAbsRealLValue.h"
26 #include "RooUniformBinning.h"
27 #include "RooNumber.h"
30 
31 class RooArgSet ;
32 class RooErrorVar ;
33 class RooVectorDataStore ;
35 
36 class RooRealVar : public RooAbsRealLValue {
37 public:
38  // Constructors, assignment etc.
39  RooRealVar() ;
40  RooRealVar(const char *name, const char *title,
41  Double_t value, const char *unit= "") ;
42  RooRealVar(const char *name, const char *title, Double_t minValue,
43  Double_t maxValue, const char *unit= "");
44  RooRealVar(const char *name, const char *title, Double_t value,
45  Double_t minValue, Double_t maxValue, const char *unit= "") ;
46  RooRealVar(const RooRealVar& other, const char* name=0);
47  RooRealVar& operator=(const RooRealVar& other);
48  virtual TObject* clone(const char* newname) const { return new RooRealVar(*this,newname); }
49  virtual ~RooRealVar();
50 
51  // Parameter value and error accessors
52  virtual Double_t getValV(const RooArgSet* nset=0) const ;
53  RooSpan<const double> getValBatch(std::size_t begin, std::size_t batchSize,
54  const RooArgSet* = nullptr) const;
55 
56  virtual void setVal(Double_t value);
57  inline Double_t getError() const { return _error>=0?_error:0. ; }
58  inline Bool_t hasError(Bool_t allowZero=kTRUE) const { return allowZero ? (_error>=0) : (_error>0) ; }
59  inline void setError(Double_t value) { _error= value ; }
60  inline void removeError() { _error = -1 ; }
61  inline Double_t getAsymErrorLo() const { return _asymErrLo<=0?_asymErrLo:0. ; }
62  inline Double_t getAsymErrorHi() const { return _asymErrHi>=0?_asymErrHi:0. ; }
63  inline Bool_t hasAsymError(Bool_t allowZero=kTRUE) const { return allowZero ? ((_asymErrHi>=0 && _asymErrLo<=0)) : ((_asymErrHi>0 && _asymErrLo<0)) ; }
64  inline void removeAsymError() { _asymErrLo = 1 ; _asymErrHi = -1 ; }
65  inline void setAsymError(Double_t lo, Double_t hi) { _asymErrLo = lo ; _asymErrHi = hi ; }
66  inline Double_t getErrorLo() const { return _asymErrLo<=0?_asymErrLo:-1*_error ; }
67  inline Double_t getErrorHi() const { return _asymErrHi>=0?_asymErrHi:_error ; }
68 
69  RooErrorVar* errorVar() const ;
70 
71  // Set/get finite fit range limits
72  void setMin(const char* name, Double_t value) ;
73  void setMax(const char* name, Double_t value) ;
74  void setRange(const char* name, Double_t min, Double_t max) ;
75  void setRange(const char* name, RooAbsReal& min, RooAbsReal& max) ;
76  inline void setMin(Double_t value) { setMin(0,value) ; }
77  inline void setMax(Double_t value) { setMax(0,value) ; }
78  inline void setRange(Double_t min, Double_t max) { setRange(0,min,max) ; }
79  inline void setRange(RooAbsReal& min, RooAbsReal& max) { setRange(0,min,max) ; }
80 
81  void setBins(Int_t nBins, const char* name=0) { setBinning(RooUniformBinning(getMin(name),getMax(name),nBins),name) ; }
82  void setBinning(const RooAbsBinning& binning, const char* name=0) ;
83 
84  // RooAbsRealLValue implementation
85  Bool_t hasBinning(const char* name) const ;
86  const RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const ;
87  RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) ;
88  std::list<std::string> getBinningNames() const ;
89 
90  // Set infinite fit range limits
91  inline void removeMin(const char* name=0) { getBinning(name).setMin(-RooNumber::infinity()) ; }
92  inline void removeMax(const char* name=0) { getBinning(name).setMax(RooNumber::infinity()) ; }
94 
95  // I/O streaming interface (machine readable)
96  virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
97  virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
98 
99  // We implement a fundamental type of AbsArg that can be stored in a dataset
100  inline virtual Bool_t isFundamental() const { return kTRUE; }
101 
102  // Force to be a leaf-node of any expression tree, even if we have (shape) servers
103  virtual Bool_t isDerived() const {
104  // Does value or shape of this arg depend on any other arg?
105  return !_serverList.empty() || _proxyList.GetEntries()>0;
106  }
107 
108  // Printing interface (human readable)
109  virtual void printValue(std::ostream& os) const ;
110  virtual void printExtras(std::ostream& os) const ;
111  virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
112  virtual Int_t defaultPrintContents(Option_t* opt) const ;
113 
114 
115  TString* format(const RooCmdArg& formatArg) const ;
116  TString* format(Int_t sigDigits, const char *options) const ;
117 
118  static void printScientific(Bool_t flag=kFALSE) ;
119  static void printSigDigits(Int_t ndig=5) ;
120 
121  using RooAbsRealLValue::operator= ;
122 
123  void deleteSharedProperties() ;
124 
125  void copyCacheFast(const RooRealVar& other, Bool_t setValDirty=kTRUE) { _value = other._value ; if (setValDirty) setValueDirty() ; }
126 
127  protected:
128 
131 
132  virtual void setVal(Double_t value, const char* rangeName) ;
133 
134  friend class RooAbsRealLValue ;
135  virtual void setValFast(Double_t value) { _value = value ; setValueDirty() ; }
136 
137 
138  virtual Double_t evaluate() const { return _value ; } // dummy because we overloaded getVal()
139  virtual void copyCache(const RooAbsArg* source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE) ;
140  virtual void attachToTree(TTree& t, Int_t bufSize=32000) ;
141  virtual void attachToVStore(RooVectorDataStore& vstore) ;
142  virtual void fillTreeBranch(TTree& t) ;
143 
144  Double_t chopAt(Double_t what, Int_t where) const ;
145 
146  Double_t _error; // Symmetric error associated with current value
147  Double_t _asymErrLo ; // Low side of asymmetric error associated with current value
148  Double_t _asymErrHi ; // High side of asymmetric error associated with current value
150  RooLinkedList _altNonSharedBinning ; // Non-shareable alternative binnings
151 
153  if (!_sharedProp) {
155  }
156  return _sharedProp ;
157  }
158 
159  virtual void setExpensiveObjectCache(RooExpensiveObjectCache&) { ; } // variables don't need caches
160 
161  static RooSharedPropertiesList _sharedPropList; // List of properties shared among clone sets
162  static RooRealVarSharedProperties _nullProp ; // Null property
163  mutable RooRealVarSharedProperties* _sharedProp ; //! Shared properties associated with this instance
164 
165  ClassDef(RooRealVar,5) // Real-valued variable
166 };
167 
168 
169 
170 
171 #endif
virtual Double_t getMin(const char *name=0) const
Get miniminum of currently defined range.
static RooRealVarSharedProperties _nullProp
Definition: RooRealVar.h:162
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:100
Bool_t hasBinning(const char *name) const
Returns true if variable has a binning with &#39;name&#39;.
Definition: RooRealVar.cxx:301
RooRealVar()
Default constructor.
Definition: RooRealVar.cxx:60
A simple container to hold a batch of data values.
Definition: RooSpan.h:32
virtual void setMin(Double_t xlo)
Definition: RooAbsBinning.h:51
virtual Double_t getMax(const char *name=0) const
Get maximum of currently defined range.
virtual TObject * clone(const char *newname) const
Definition: RooRealVar.h:48
virtual void attachToTree(TTree &t, Int_t bufSize=32000)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
const char Option_t
Definition: RtypesCore.h:62
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
RooExpensiveObjectCache is a singleton class that serves as repository for objects that are expensive...
virtual Bool_t isDerived() const
Does value or shape of this arg depend on any other arg?
Definition: RooRealVar.h:103
const RooAbsBinning & getBinning(const char *name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const
Return binning definition with name.
Definition: RooRealVar.cxx:314
void setRange(RooAbsReal &min, RooAbsReal &max)
Definition: RooRealVar.h:79
Basic string class.
Definition: TString.h:131
virtual void setValFast(Double_t value)
Definition: RooRealVar.h:135
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual void printExtras(std::ostream &os) const
Print extras of variable: (asymmetric) error, constant flag, limits and binning.
Definition: RooRealVar.cxx:758
virtual Int_t defaultPrintContents(Option_t *opt) const
Mapping of Print() option string to RooPrintable contents specifications.
Definition: RooRealVar.cxx:798
virtual Double_t getValV(const RooArgSet *nset=0) const
Return value of variable.
Definition: RooRealVar.cxx:222
void setMax(const char *name, Double_t value)
Set maximum of name range to given value.
Definition: RooRealVar.cxx:465
void copyCacheFast(const RooRealVar &other, Bool_t setValDirty=kTRUE)
Definition: RooRealVar.h:125
static Int_t _printSigDigits
Definition: RooRealVar.h:130
RooRealVar & operator=(const RooRealVar &other)
Assign the values of another RooRealVar to this instance.
Definition: RooRealVar.cxx:173
virtual void setExpensiveObjectCache(RooExpensiveObjectCache &)
Definition: RooRealVar.h:159
void setBinning(const RooAbsBinning &binning, const char *name=0)
Add given binning under name &#39;name&#39; with this variable.
Definition: RooRealVar.cxx:393
Double_t getErrorLo() const
Definition: RooRealVar.h:66
static void printScientific(Bool_t flag=kFALSE)
If true, contents of RooRealVars will be printed in scientific notation.
static RooSharedPropertiesList _sharedPropList
Definition: RooRealVar.h:161
Bool_t hasAsymError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:63
#define ClassDef(name, id)
Definition: Rtypes.h:326
virtual void setRange(Double_t xlo, Double_t xhi)=0
void removeRange(const char *name=0)
Definition: RooRealVar.h:93
RooRealVarSharedProperties * _sharedProp
Definition: RooRealVar.h:163
RooVectorDataStore is the abstract base class for data collection that use a TTree as internal storag...
void deleteSharedProperties()
No longer used?
void removeMin(const char *name=0)
Definition: RooRealVar.h:91
RooErrorVar is an auxilary class that represents the error of a RooRealVar as a seperate object...
Definition: RooErrorVar.h:28
Double_t _error
Definition: RooRealVar.h:146
void setAsymError(Double_t lo, Double_t hi)
Definition: RooRealVar.h:65
void setBins(Int_t nBins, const char *name=0)
Definition: RooRealVar.h:81
Bool_t hasError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:58
RooSharedProperties * registerProperties(RooSharedProperties *, Bool_t canDeleteIncoming=kTRUE)
Register property into list and take ownership.
Double_t _asymErrLo
Definition: RooRealVar.h:147
RooRealVar represents a fundamental (non-derived) real-valued object.
Definition: RooRealVar.h:36
virtual void setVal(Double_t value)
Set value of variable to &#39;value&#39;.
Definition: RooRealVar.cxx:252
bool empty() const
Check if empty.
Double_t getAsymErrorHi() const
Definition: RooRealVar.h:62
virtual void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Detailed printing interface.
Definition: RooRealVar.cxx:810
Class RooRealVarSharedProperties is an implementation of RooSharedProperties that stores the properti...
void setMin(const char *name, Double_t value)
Set minimum of name range to given value.
Definition: RooRealVar.cxx:435
virtual Double_t evaluate() const
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
Definition: RooRealVar.h:138
TString * format(const RooCmdArg &formatArg) const
Format contents of RooRealVar for pretty printing on RooPlot parameter boxes.
Definition: RooRealVar.cxx:827
static Double_t infinity()
Return internal infinity representation.
Definition: RooNumber.cxx:49
RooAbsBinning * _binning
Definition: RooRealVar.h:149
static void indent(ostringstream &buf, int indent_level)
static void printSigDigits(Int_t ndig=5)
Set number of digits to show when printing RooRealVars.
const Bool_t kFALSE
Definition: RtypesCore.h:88
std::list< std::string > getBinningNames() const
Get a list of all binning names.
Definition: RooRealVar.cxx:367
virtual void fillTreeBranch(TTree &t)
Overload RooAbsReal::fillTreeBranch to also fill tree branches with (asymmetric) errors if requested...
RooRefArray _proxyList
Definition: RooAbsArg.h:564
static Bool_t _printScientific
Definition: RooRealVar.h:129
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:235
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
Definition: RooLinkedList.h:36
RooAbsBinning is the abstract base class for RooRealVar binning definitions This class defines the in...
Definition: RooAbsBinning.h:26
RooUniformBinning is an implementation of RooAbsBinning that provides a uniform binning in &#39;n&#39; bins b...
double Double_t
Definition: RtypesCore.h:55
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:59
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
Definition: RooRealVar.cxx:677
RooRealVarSharedProperties * sharedProp() const
Definition: RooRealVar.h:152
Class RooSharedPropertiesList maintains the properties of RooRealVars and RooCategories that are clon...
void setMax(Double_t value)
Definition: RooRealVar.h:77
Double_t _value
Definition: RooAbsReal.h:446
void setRange(const char *name, Double_t min, Double_t max)
Set range named &#39;name to [min,max].
Definition: RooRealVar.cxx:496
void removeAsymError()
Definition: RooRealVar.h:64
Mother of all ROOT objects.
Definition: TObject.h:37
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition: RooAbsArg.h:466
RooErrorVar * errorVar() const
Return a RooAbsRealLValue representing the error associated with this variable.
Definition: RooRealVar.cxx:287
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
Double_t chopAt(Double_t what, Int_t where) const
Utility to calculate number of decimals to show based on magnitude of error.
RooLinkedList _altNonSharedBinning
Definition: RooRealVar.h:150
virtual ~RooRealVar()
Destructor.
Definition: RooRealVar.cxx:206
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...
Int_t GetEntries() const
Return the number of objects in array (i.e.
Definition: TObjArray.cxx:522
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
Definition: RooRealVar.cxx:538
virtual void attachToVStore(RooVectorDataStore &vstore)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
A TTree represents a columnar dataset.
Definition: TTree.h:72
float type_of_call hi(const int &, const int &)
virtual void printValue(std::ostream &os) const
Print value of variable.
Definition: RooRealVar.cxx:742
void setMin(Double_t value)
Definition: RooRealVar.h:76
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:71
Double_t getError() const
Definition: RooRealVar.h:57
Double_t _asymErrHi
Definition: RooRealVar.h:148
const Bool_t kTRUE
Definition: RtypesCore.h:87
Double_t getAsymErrorLo() const
Definition: RooRealVar.h:61
void removeError()
Definition: RooRealVar.h:60
void removeMax(const char *name=0)
Definition: RooRealVar.h:92
Double_t getErrorHi() const
Definition: RooRealVar.h:67
void setRange(Double_t min, Double_t max)
Definition: RooRealVar.h:78
char name[80]
Definition: TGX11.cxx:109
virtual void setMax(Double_t xhi)
Definition: RooAbsBinning.h:55
RefCountList_t _serverList
Definition: RooAbsArg.h:559
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:28
void setError(Double_t value)
Definition: RooRealVar.h:59