Logo ROOT  
Reference Guide
RooAbsCategory.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooAbsCategory.h,v 1.38 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_ABS_CATEGORY
17#define ROO_ABS_CATEGORY
18
19#include "RooAbsArg.h"
20
21#include <string>
22#include <map>
23#include <functional>
24#include <vector>
25
26#ifdef R__LESS_INCLUDES
27class RooCatType;
28#else
29#include "RooCatType.h"
30#endif
31
32class TTree;
34class Roo1DTable;
35class TIterator;
36
37class RooAbsCategory : public RooAbsArg {
38public:
39 /// The type used to denote a specific category state.
40 using value_type = int;
41
42 // Constructors, assignment etc.
44 RooAbsCategory(const char *name, const char *title);
45 RooAbsCategory(const RooAbsCategory& other, const char* name=0) ;
46 virtual ~RooAbsCategory();
47
48 // Value accessors
49 virtual value_type getCurrentIndex() const ;
50 virtual const char* getCurrentLabel() const ;
51
52 const std::map<std::string, value_type>::value_type& getOrdinal(unsigned int n) const;
53 unsigned int getCurrentOrdinalNumber() const;
54
55 Bool_t operator==(value_type index) const ;
56 Bool_t operator!=(value_type index) { return !operator==(index);}
57 Bool_t operator==(const char* label) const ;
58 Bool_t operator!=(const char* label) { return !operator==(label);}
59 virtual Bool_t operator==(const RooAbsArg& other) const ;
60 Bool_t operator!=(const RooAbsArg& other) { return !operator==(other);}
61 virtual Bool_t isIdentical(const RooAbsArg& other, Bool_t assumeSameType=kFALSE) const;
62
63 /// Check if a state with name `label` exists.
64 bool hasLabel(const std::string& label) const {
65 return stateNames().find(label) != stateNames().end();
66 }
67 /// Check if a state with index `index` exists.
68 bool hasIndex(value_type index) const;
69
70 /// Get the name corresponding to the given index.
71 /// \return Name or empty string if index is invalid.
72 const std::string& lookupName(value_type index) const;
73 value_type lookupIndex(const std::string& stateName) const;
74
75
76 Bool_t isSignType(Bool_t mustHaveZero=kFALSE) const ;
77
78 Roo1DTable *createTable(const char *label) const ;
79
80 // I/O streaming interface
81 virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
82 virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
83
84 virtual void printValue(std::ostream& os) const ;
85 virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
86
87 virtual Bool_t isIntegrationSafeLValue(const RooArgSet* /*set*/) const {
88 // Is this l-value object safe for use as integration observable
89 return kTRUE ;
90 }
91
92 RooAbsArg *createFundamental(const char* newname=0) const;
93
94 /// Iterator for category state names. Points to pairs of index and name.
95 std::map<std::string, value_type>::const_iterator begin() const {
96 return stateNames().cbegin();
97 }
98 /// Iterator for category state names. Points to pairs of index and name.
99 std::map<std::string, value_type>::const_iterator end() const {
100 return stateNames().cend();
101 }
102 /// Number of states defined.
103 std::size_t size() const {
104 return stateNames().size();
105 }
106
107
108 /// \name Legacy interface
109 /// Previous versions of RooAbsCategory were based on RooCatType, a class containing a state and a label.
110 /// It has been replaced by integers, which use less space and allow for faster access. The following part of the interface
111 /// should not be used if possible.
112 /// Since RooCatType in essence is only an index and a state name, equivalent functionality can be achieved using begin()
113 /// and end() to iterate through pairs of <index, stateName> and by using using lookupName() and lookupIndex().
114 /// @{
115 const RooCatType*
116 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use lookupName()")
117 lookupType(value_type index, Bool_t printError=kFALSE) const;
118 const RooCatType*
119 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use lookupIndex()")
120 lookupType(const char* label, Bool_t printError=kFALSE) const;
121 const RooCatType*
122 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use lookupName() / lookupIndex()")
123 lookupType(const RooCatType& type, Bool_t printError=kFALSE) const;
124 TIterator*
125 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use begin(), end() or range-based for loops.")
126 typeIterator() const;
127 /// Return number of types defined (in range named rangeName if rangeName!=0)
128 Int_t numTypes(const char* /*rangeName*/=0) const {
129 return stateNames().size();
130 }
131 /// Retrieve the current index. Use getCurrentIndex() for more clarity.
132 Int_t getIndex() const { return getCurrentIndex(); }
133 /// Retrieve current label. Use getCurrentLabel() for more clarity.
134 const char* getLabel() const { return getCurrentLabel(); }
135protected:
136 virtual Bool_t
137 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use hasIndex() or hasLabel().")
138 isValid(const RooCatType& value) const ;
139 /// \deprecated Use defineState(const std::string& label)
140 const RooCatType*
141 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use defineState().")
142 defineType(const char* label);
143 /// \deprecated Use defineState(const std::string& label, value_type index)
144 const RooCatType*
145 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use defineState().")
146 defineType(const char* label, int index);
147 /// \deprecated Use defineStateUnchecked(const std::string& label, value_type index)
148 const RooCatType*
149 R__SUGGEST_ALTERNATIVE("This interface is inefficient. Use defineTypeUnchecked().")
150 defineTypeUnchecked(const char* label, value_type index);
151 /// @}
152
153
154protected:
155 /// Access the map of state names to index numbers. Triggers a recomputation
156 /// if the shape is dirty.
157 const std::map<std::string, value_type>& stateNames() const {
158 if (isShapeDirty()) {
159 _legacyStates.clear();
160 const_cast<RooAbsCategory*>(this)->recomputeShape();
162 }
163
164 return _stateNames;
165 }
166 /// \copydoc stateNames() const
167 std::map<std::string, value_type>& stateNames() {
168 if (isShapeDirty()) {
169 _legacyStates.clear();
172 }
173
174 //Somebody might modify the states
176
177 return _stateNames;
178 }
179
180 /// Evaluate the category state and return.
181 /// The returned state index should correspond to a state name that has been defined via e.g. defineType().
182 virtual value_type evaluate() const = 0;
183
184 // Type definition management
185 virtual const std::map<std::string, RooAbsCategory::value_type>::value_type& defineState(const std::string& label);
186 virtual const std::map<std::string, RooAbsCategory::value_type>::value_type& defineState(const std::string& label, value_type index);
187
188 void defineStateUnchecked(const std::string& label, value_type index);
189 void clearTypes() ;
190
191 virtual bool isValid() const {
192 return hasIndex(_currentIndex);
193 }
194
195 /// If a category depends on the shape of others, i.e.\ its state numbers or names depend
196 /// on the states of other categories, this function has to be implemented to recompute
197 /// _stateNames and _insertionOrder.
198 /// If one of these two changes, setShapeDirty() has to be called to propagate this information
199 /// to possible users of this category.
200 virtual void recomputeShape() = 0;
201
202 friend class RooVectorDataStore ;
203 virtual void syncCache(const RooArgSet* set=0) ;
204 virtual void copyCache(const RooAbsArg* source, Bool_t valueOnly=kFALSE, Bool_t setValueDirty=kTRUE) ;
205 void setCachedValue(double value, bool notifyClients = true) final;
206 virtual void attachToTree(TTree& t, Int_t bufSize=32000) ;
207 virtual void attachToVStore(RooVectorDataStore& vstore) ;
208 virtual void setTreeBranchStatus(TTree& t, Bool_t active) ;
209 virtual void fillTreeBranch(TTree& t) ;
210
213
214
215 mutable value_type _currentIndex{std::numeric_limits<int>::min()}; /// Current category state
216 std::map<std::string, value_type> _stateNames; /// Map state names to index numbers. Make sure state names are updated in recomputeShape().
217 std::vector<std::string> _insertionOrder; /// Keeps track in which order state numbers have been inserted. Make sure this is updated in recomputeShape().
218 mutable UChar_t _byteValue{0}; //! Transient cache for byte values from tree branches
219 mutable std::map<value_type, std::unique_ptr<RooCatType, std::function<void(RooCatType*)>> > _legacyStates; //! Map holding pointers to RooCatType instances. Only for legacy interface. Don't use if possible.
220 bool _treeVar{false}; /// Is this category attached to a tree?
221
222 static const decltype(_stateNames)::value_type& invalidCategory();
223
224 ClassDef(RooAbsCategory, 3) // Abstract discrete variable
225};
226
227#endif
typedef void(GLAPIENTRYP _GLUfuncptr)(void)
#define R__SUGGEST_ALTERNATIVE(ALTERNATIVE)
Definition: RConfig.hxx:521
int Int_t
Definition: RtypesCore.h:45
unsigned char UChar_t
Definition: RtypesCore.h:38
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
const Bool_t kTRUE
Definition: RtypesCore.h:100
#define ClassDef(name, id)
Definition: Rtypes.h:325
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition: TGX11.cxx:110
int type
Definition: TGX11.cxx:121
Roo1DTable implements a one-dimensional table.
Definition: Roo1DTable.h:23
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:72
void setShapeDirty()
Notify that a shape-like property (e.g. binning) has changed.
Definition: RooAbsArg.h:496
Bool_t isShapeDirty() const
Definition: RooAbsArg.h:417
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition: RooAbsArg.h:491
void clearShapeDirty() const
Definition: RooAbsArg.h:578
RooAbsCategory is the base class for objects that represent a discrete value with a finite number of ...
virtual void recomputeShape()=0
If a category depends on the shape of others, i.e. its state numbers or names depend on the states of...
std::map< std::string, value_type > & stateNames()
Access the map of state names to index numbers.
virtual value_type getCurrentIndex() const
Return index number of current state.
void setCachedValue(double value, bool notifyClients=true) final
Overwrite the value stored in this object's cache.
virtual void copyCache(const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValueDirty=kTRUE)
Copy the cached value from given source and raise dirty flag.
virtual bool isValid() const
WVE (08/21/01) Probably obsolete now.
unsigned int getCurrentOrdinalNumber() const
Return ordinal number of the current state.
bool hasLabel(const std::string &label) const
Check if a state with name label exists.
virtual const char * getCurrentLabel() const
Return label string of current state.
const std::string & lookupName(value_type index) const
Get the name corresponding to the given index.
TIterator * typeIterator() const
virtual void fillTreeBranch(TTree &t)
Fill tree branches associated with current object with current value.
RooCatType * retrieveLegacyState(value_type index) const
Return the legacy RooCatType corresponding to index. If it doesn't exist, create one.
value_type _currentIndex
Bool_t operator==(value_type index) const
Equality operator with a integer (compares with state index number)
virtual void attachToVStore(RooVectorDataStore &vstore)
Attach the category index and label to as branches to the given vector store.
Roo1DTable * createTable(const char *label) const
Create a table matching the shape of this category.
void defineStateUnchecked(const std::string &label, value_type index)
Internal version of defineState() that does not check if type already exists.
virtual ~RooAbsCategory()
Destructor.
const RooCatType * defineTypeUnchecked(const char *label, value_type index)
Int_t getIndex() const
Retrieve the current index. Use getCurrentIndex() for more clarity.
virtual void attachToTree(TTree &t, Int_t bufSize=32000)
Attach the category index and label as branches to the given TTree.
value_type nextAvailableStateIndex() const
const char * getLabel() const
Retrieve current label. Use getCurrentLabel() for more clarity.
virtual Bool_t isIdentical(const RooAbsArg &other, Bool_t assumeSameType=kFALSE) const
virtual Bool_t isIntegrationSafeLValue(const RooArgSet *) const
RooAbsArg * createFundamental(const char *newname=0) const
Create a RooCategory fundamental object with our properties.
Bool_t operator!=(const char *label)
std::map< std::string, value_type >::const_iterator end() const
Iterator for category state names. Points to pairs of index and name.
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to ostream.
std::map< std::string, value_type >::const_iterator begin() const
Iterator for category state names. Points to pairs of index and name.
virtual const std::map< std::string, RooAbsCategory::value_type >::value_type & defineState(const std::string &label)
Define a new state with given label.
virtual void setTreeBranchStatus(TTree &t, Bool_t active)
(De)activate associate tree branch
virtual value_type evaluate() const =0
Evaluate the category state and return.
int value_type
The type used to denote a specific category state.
static const decltype(_stateNames) ::value_type & invalidCategory()
Is this category attached to a tree?
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 std::map< std::string, value_type >::value_type & getOrdinal(unsigned int n) const
Return name and index of the nth defined state.
std::size_t size() const
Number of states defined.
Bool_t operator!=(value_type index)
const RooCatType * lookupType(value_type index, Bool_t printError=kFALSE) const
Find our type corresponding to the specified index, or return nullptr for no match.
Bool_t operator!=(const RooAbsArg &other)
UChar_t _byteValue
Keeps track in which order state numbers have been inserted. Make sure this is updated in recomputeSh...
Int_t numTypes(const char *=0) const
Return number of types defined (in range named rangeName if rangeName!=0)
std::map< value_type, std::unique_ptr< RooCatType, std::function< void(RooCatType *)> > > _legacyStates
Transient cache for byte values from tree branches.
bool hasIndex(value_type index) const
Check if a state with index index exists.
virtual void syncCache(const RooArgSet *set=0)
Explicitly synchronize RooAbsCategory internal cache.
std::vector< std::string > _insertionOrder
Map state names to index numbers. Make sure state names are updated in recomputeShape().
std::map< std::string, value_type > _stateNames
Current category state.
const RooCatType * defineType(const char *label)
Bool_t isSignType(Bool_t mustHaveZero=kFALSE) const
Determine if category has 2 or 3 states with index values -1,0,1.
const std::map< std::string, value_type > & stateNames() const
Access the map of state names to index numbers.
virtual void printValue(std::ostream &os) const
Print value (label name)
value_type lookupIndex(const std::string &stateName) const
Find the index number corresponding to the state name.
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from stream (dummy for now)
bool _treeVar
Map holding pointers to RooCatType instances. Only for legacy interface. Don't use if possible.
void clearTypes()
Delete all currently defined states.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:35
RooCatType is an auxilary class for RooAbsCategory and defines a a single category state.
RooVectorDataStore uses std::vectors to store data columns.
Iterator abstract base class.
Definition: TIterator.h:30
Basic string class.
Definition: TString.h:136
A TTree represents a columnar dataset.
Definition: TTree.h:79
const Int_t n
Definition: legend1.C:16
for(Int_t i=0;i< n;i++)
Definition: legend1.C:18
void function(const Char_t *name_, T fun, const Char_t *docstring=0)
Definition: RExports.h:150