Logo ROOT   master
Reference Guide
RooAbsCategory Class Referenceabstract

RooAbsCategory is the base class for objects that represent a discrete value with a finite number of states.

Each state is denoted by an integer and a name. Both can be used to retrieve and set states, but referring to states by index is more efficient. Conversion between index and name can be done using lookupName() or lookupIndex(). It is possible to iterate through all defined states using begin() and end().

For category classes deriving from RooAbsCategory, states can only be evaluated, i.e., queried. Refer to RooAbsCategoryLValue and its derived classes for categories where states can also be set. The simplest category class whose states can be set, queried and saved in a dataset, refer to RooCategory.

Interface change in ROOT-6.22

Category data were based in the class RooCatType, holding an index state and a category name truncated to 256 characters. This wastes 64 bytes of storage space per entry, and prevents fast retrieval of category data. Since ROOT-6.22, categories are only represented by an integer. RooAbsCategory::lookupName() can be used to retrieve the corresponding state name. There is no limit for the length of the state name.

To not break old code, the old RooCatType interfaces are still available. Whenever possible, the following replacements should be used:

Definition at line 37 of file RooAbsCategory.h.

Public Types

using value_type = int
 The type used to denote a specific category state. More...
 
- Public Types inherited from RooAbsArg
enum  CacheMode { Always =0, NotAdvised =1, Never =2 }
 
enum  ConstOpCode { Activate =0, DeActivate =1, ConfigChange =2, ValueChange =3 }
 
enum  OperMode { Auto =0, AClean =1, ADirty =2 }
 
using RefCountList_t = RooSTLRefCountList< RooAbsArg >
 
using RefCountListLegacyIterator_t = TIteratorToSTLInterface< RefCountList_t::Container_t >
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Public Types inherited from RooPrintable
enum  ContentsOption {
  kName =1, kClassName =2, kValue =4, kArgs =8,
  kExtras =16, kAddress =32, kTitle =64, kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1, kSingleLine =2, kStandard =3, kVerbose =4,
  kTreeStructure =5
}
 

Public Member Functions

 RooAbsCategory ()
 
 RooAbsCategory (const char *name, const char *title)
 Constructor. More...
 
 RooAbsCategory (const RooAbsCategory &other, const char *name=0)
 Copy constructor, copies the registered category states from the original. More...
 
virtual ~RooAbsCategory ()
 Destructor. More...
 
std::map< std::string, value_type >::const_iterator begin () const
 Iterator for category state names. Points to pairs of index and name. More...
 
RooAbsArgcreateFundamental (const char *newname=0) const
 Create a RooCategory fundamental object with our properties. More...
 
Roo1DTablecreateTable (const char *label) const
 Create a table matching the shape of this category. More...
 
std::map< std::string, value_type >::const_iterator end () const
 Iterator for category state names. Points to pairs of index and name. More...
 
virtual value_type getCurrentIndex () const
 Return index number of current state. More...
 
virtual const char * getCurrentLabel () const
 Return label string of current state. More...
 
unsigned int getCurrentOrdinalNumber () const
 Return ordinal number of the current state. More...
 
const std::map< std::string, value_type >::value_typegetOrdinal (unsigned int n) const
 Return name and index of the nth defined state. More...
 
virtual RooSpan< const value_typegetValBatch (std::size_t, std::size_t) const
 Retrieve a batch of category values for events in the range [begin, begin+batchSize). More...
 
bool hasIndex (value_type index) const
 Check if a state with index index exists. More...
 
bool hasLabel (const std::string &label) const
 Check if a state with name label exists. More...
 
virtual Bool_t isIdentical (const RooAbsArg &other, Bool_t assumeSameType=kFALSE) const
 
virtual Bool_t isIntegrationSafeLValue (const RooArgSet *) const
 
Bool_t isSignType (Bool_t mustHaveZero=kFALSE) const
 Determine if category has 2 or 3 states with index values -1,0,1. More...
 
value_type lookupIndex (const std::string &stateName) const
 Find the index number corresponding to the state name. More...
 
const std::string & lookupName (value_type index) const
 Get the name corresponding to the given index. More...
 
Bool_t operator!= (value_type index)
 
Bool_t operator!= (const char *label)
 
Bool_t operator!= (const RooAbsArg &other)
 
Bool_t operator== (value_type index) const
 Equality operator with a integer (compares with state index number) More...
 
Bool_t operator== (const char *label) const
 Equality operator with a string (compares with state label string) More...
 
virtual Bool_t operator== (const RooAbsArg &other) const
 Equality operator with another RooAbsArg. More...
 
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. More...
 
virtual void printValue (std::ostream &os) const
 Print value (label name) More...
 
virtual Bool_t readFromStream (std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
 Read object contents from stream (dummy for now) More...
 
std::size_t size () const
 Number of states defined. More...
 
virtual void writeToStream (std::ostream &os, Bool_t compact) const
 Write object contents to ostream. More...
 
- Public Member Functions inherited from RooAbsArg
 RooAbsArg ()
 Default constructor. More...
 
 RooAbsArg (const char *name, const char *title)
 Create an object with the specified name and descriptive title. More...
 
 RooAbsArg (const RooAbsArg &other, const char *name=0)
 Copy constructor transfers all boolean and string properties of the original object. More...
 
virtual ~RooAbsArg ()
 Destructor. More...
 
Bool_t addOwnedComponents (const RooArgSet &comps)
 Take ownership of the contents of 'comps'. More...
 
const char * aggregateCacheUniqueSuffix () const
 
void attachDataSet (const RooAbsData &set)
 Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset. More...
 
void attachDataStore (const RooAbsDataStore &set)
 Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset. More...
 
const std::set< std::string > & attributes () const
 
virtual const char * cacheUniqueSuffix () const
 
virtual CacheMode canNodeBeCached () const
 
virtual Bool_t checkObservables (const RooArgSet *nset) const
 Overloadable function in which derived classes can implement consistency checks of the variables. More...
 
virtual TObjectclone (const char *newname=0) const =0
 
virtual TObjectClone (const char *newname=0) const
 Make a clone of an object using the Streamer facility. More...
 
virtual RooAbsArgcloneTree (const char *newname=0) const
 Clone tree expression of objects. More...
 
Int_t Compare (const TObject *other) const
 Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name. More...
 
virtual void constOptimizeTestStatistic (ConstOpCode opcode, Bool_t doAlsoTrackingOpt=kTRUE)
 Interface function signaling a request to perform constant term optimization. More...
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Define default contents to print. More...
 
Bool_t dependsOn (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=0, Bool_t valueOnly=kFALSE) const
 Test whether we depend on (ie, are served by) any object in the specified collection. More...
 
Bool_t dependsOn (const RooAbsArg &server, const RooAbsArg *ignoreArg=0, Bool_t valueOnly=kFALSE) const
 Test whether we depend on (ie, are served by) the specified object. More...
 
Bool_t dependsOnValue (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=0) const
 Check whether this object depends on values from an element in the serverList. More...
 
Bool_t dependsOnValue (const RooAbsArg &server, const RooAbsArg *ignoreArg=0) const
 Check whether this object depends on values served from the object passed as server. More...
 
RooExpensiveObjectCacheexpensiveObjectCache () const
 
Bool_t findConstantNodes (const RooArgSet &observables, RooArgSet &cacheList)
 Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached with a dataset in a test statistic calculation. More...
 
Bool_t findConstantNodes (const RooArgSet &observables, RooArgSet &cacheList, RooLinkedList &processedNodes)
 Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached with a dataset in a test statistic calculation. More...
 
Bool_t getAttribute (const Text_t *name) const
 Check if a named attribute is set. By default, all attributes are unset. More...
 
RooAbsCachegetCache (Int_t index) const
 Return registered cache object by index. More...
 
RooLinkedList getCloningAncestors () const
 Return ancestors in cloning chain of this RooAbsArg. More...
 
RooArgSetgetComponents () const
 Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object. More...
 
RooArgSetgetObservables (const RooArgSet &set, Bool_t valueOnly=kTRUE) const
 Return the observables of this pdf given a set of observables. More...
 
RooArgSetgetObservables (const RooAbsData *data) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names of the variable list of the supplied data set (the dependents). More...
 
RooArgSetgetObservables (const RooAbsData &data) const
 Return the observables of this pdf given the observables defined by data. More...
 
RooArgSetgetObservables (const RooArgSet *depList, Bool_t valueOnly=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names the args in the supplied argset. More...
 
RooArgSetgetParameters (const RooAbsData *data, Bool_t stripDisconnected=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that don't match any of the names of the variable list of the supplied data set (the dependents). More...
 
RooArgSetgetParameters (const RooAbsData &data, Bool_t stripDisconnected=kTRUE) const
 Return the parameters of this p.d.f when used in conjuction with dataset 'data'. More...
 
RooArgSetgetParameters (const RooArgSet &observables, Bool_t stripDisconnected=kTRUE) const
 Return the parameters of the p.d.f given the provided set of observables. More...
 
virtual RooArgSetgetParameters (const RooArgSet *depList, Bool_t stripDisconnected=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that don't match any of the names the args in the supplied argset. More...
 
const Text_tgetStringAttribute (const Text_t *key) const
 Get string attribute mapped under key 'key'. More...
 
Bool_t getTransientAttribute (const Text_t *name) const
 Check if a named attribute is set. More...
 
RooArgSetgetVariables (Bool_t stripDisconnected=kTRUE) const
 Return RooArgSet with all variables (tree leaf nodes of expresssion tree) More...
 
void graphVizTree (const char *fileName, const char *delimiter="\, bool useTitle=false, bool useLatex=false)
 Create a GraphViz .dot file visualizing the expression tree headed by this RooAbsArg object. More...
 
void graphVizTree (std::ostream &os, const char *delimiter="\, bool useTitle=false, bool useLatex=false)
 Write the GraphViz representation of the expression tree headed by this RooAbsArg object to the given ostream. More...
 
Bool_t hasClients () const
 
virtual Bool_t hasRange (const char *) const
 
virtual Bool_t importWorkspaceHook (RooWorkspace &ws)
 
virtual Bool_t inRange (const char *) const
 
Bool_t isCloneOf (const RooAbsArg &other) const
 Check if this object was created as a clone of 'other'. More...
 
Bool_t isConstant () const
 Check if the "Constant" attribute is set. More...
 
virtual Bool_t isDerived () const
 Does value or shape of this arg depend on any other arg? More...
 
Bool_t isShapeDirty () const
 
virtual Bool_t IsSortable () const
 
Bool_t isValueDirty () const
 
Bool_t isValueDirtyAndClear () const
 
Bool_t isValueOrShapeDirtyAndClear () const
 
Bool_t localNoDirtyInhibit () const
 
const TNamednamePtr () const
 
Int_t numCaches () const
 Return number of registered caches. More...
 
Bool_t observableOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
 Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg. More...
 
Bool_t observableOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
 Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg. More...
 
RooAbsArgoperator= (const RooAbsArg &other)
 Assign all boolean and string properties of the original object. More...
 
OperMode operMode () const
 
virtual void optimizeCacheMode (const RooArgSet &observables)
 Activate cache mode optimization with given definition of observables. More...
 
virtual void optimizeCacheMode (const RooArgSet &observables, RooArgSet &optNodes, RooLinkedList &processedNodes)
 Activate cache mode optimization with given definition of observables. More...
 
Bool_t overlaps (const RooAbsArg &testArg, Bool_t valueOnly=kFALSE) const
 Test if any of the nodes of tree are shared with that of the given tree. More...
 
const RooArgSetownedComponents () const
 
virtual void Print (Option_t *options=0) const
 Print the object to the defaultPrintStream(). More...
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printArgs (std::ostream &os) const
 Print object arguments, ie its proxies. More...
 
virtual void printClassName (std::ostream &os) const
 Print object class name. More...
 
void printCompactTree (const char *indent="", const char *fileName=0, const char *namePat=0, RooAbsArg *client=0)
 Print tree structure of expression tree on stdout, or to file if filename is specified. More...
 
void printCompactTree (std::ostream &os, const char *indent="", const char *namePat=0, RooAbsArg *client=0)
 Print tree structure of expression tree on given ostream. More...
 
virtual void printCompactTreeHook (std::ostream &os, const char *ind="")
 Hook function interface for object to insert additional information when printed in the context of a tree structure. More...
 
void printComponentTree (const char *indent="", const char *namePat=0, Int_t nLevel=999)
 Print tree structure of expression tree on given ostream, only branch nodes are printed. More...
 
void printDirty (Bool_t depth=kTRUE) const
 Print information about current value dirty state information. More...
 
virtual void printMetaArgs (std::ostream &) const
 
virtual void printName (std::ostream &os) const
 Print object name. More...
 
virtual void printTitle (std::ostream &os) const
 Print object title. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Print object tree structure. More...
 
Bool_t recursiveCheckObservables (const RooArgSet *nset) const
 Recursively call checkObservables on all nodes in the expression tree. More...
 
void registerCache (RooAbsCache &cache)
 Register RooAbsCache with this object. More...
 
void setAttribute (const Text_t *name, Bool_t value=kTRUE)
 Set (default) or clear a named boolean attribute of this object. More...
 
virtual void setCacheAndTrackHints (RooArgSet &)
 
virtual void setExpensiveObjectCache (RooExpensiveObjectCache &cache)
 
void setLocalNoDirtyInhibit (Bool_t flag) const
 
void SetName (const char *name)
 Set the name of the TNamed. More...
 
void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
void setOperMode (OperMode mode, Bool_t recurseADirty=kTRUE)
 Change cache operation mode to given mode. More...
 
void setProhibitServerRedirect (Bool_t flag)
 
void setShapeDirty ()
 Notify that a shape-like property (e.g. binning) has changed. More...
 
void setStringAttribute (const Text_t *key, const Text_t *value)
 Associate string 'value' to this object under key 'key'. More...
 
void setTransientAttribute (const Text_t *name, Bool_t value=kTRUE)
 Set (default) or clear a named boolean attribute of this object. More...
 
void setValueDirty ()
 Mark the element dirty. This forces a re-evaluation when a value is requested. More...
 
void setWorkspace (RooWorkspace &ws)
 
const std::map< std::string, std::string > & stringAttributes () const
 
const std::set< std::string > & transientAttributes () const
 
void unRegisterCache (RooAbsCache &cache)
 Unregister a RooAbsCache. Called from the RooAbsCache destructor. More...
 
void wireAllCaches ()
 
TIteratorclientIterator () const
 Retrieve a client iterator. More...
 
TIteratorvalueClientIterator () const
 
TIteratorshapeClientIterator () const
 
TIteratorserverIterator () const
 
RooFIter valueClientMIterator () const
 
RooFIter shapeClientMIterator () const
 
RooFIter serverMIterator () const
 
RooArgSetgetDependents (const RooArgSet &set) const
 
RooArgSetgetDependents (const RooAbsData *set) const
 
RooArgSetgetDependents (const RooArgSet *depList) const
 
Bool_t dependentOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
 
Bool_t dependentOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
 
Bool_t checkDependents (const RooArgSet *nset) const
 
Bool_t recursiveCheckDependents (const RooArgSet *nset) const
 
const RefCountList_tclients () const
 List of all clients of this object. More...
 
const RefCountList_tvalueClients () const
 List of all value clients of this object. Value clients receive value updates. More...
 
const RefCountList_tshapeClients () const
 List of all shape clients of this object. More...
 
const RefCountList_tservers () const
 List of all servers of this object. More...
 
RooAbsArgfindServer (const char *name) const
 Return server of this with name name. Returns nullptr if not found. More...
 
RooAbsArgfindServer (const RooAbsArg &arg) const
 Return server of this that has the same name as arg. Returns nullptr if not found. More...
 
RooAbsArgfindServer (Int_t index) const
 Return i-th server from server list. More...
 
Bool_t isValueServer (const RooAbsArg &arg) const
 Check if this is serving values to arg. More...
 
Bool_t isValueServer (const char *name) const
 Check if this is serving values to an object with name name. More...
 
Bool_t isShapeServer (const RooAbsArg &arg) const
 Check if this is serving shape to arg. More...
 
Bool_t isShapeServer (const char *name) const
 Check if this is serving shape to an object with name name. More...
 
void leafNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with all leaf nodes of the arg tree, starting with ourself as top node. More...
 
void branchNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with all branch nodes of the arg tree starting with ourself as top node. More...
 
void treeNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t doBranch=kTRUE, Bool_t doLeaf=kTRUE, Bool_t valueOnly=kFALSE, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node. More...
 
virtual Bool_t isFundamental () const
 Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return kTRUE. More...
 
virtual Bool_t isLValue () const
 Is this argument an l-value, i.e., can it appear on the left-hand side of an assignment expression? LValues are also special since they can potentially be analytically integrated and generated. More...
 
Bool_t redirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t isRecursionStep=kFALSE)
 Substitute our servers with those listed in newSet. More...
 
Bool_t recursiveRedirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t recurseInNewSet=kTRUE)
 
virtual Bool_t redirectServersHook (const RooAbsCollection &, Bool_t, Bool_t, Bool_t)
 
virtual void serverNameChangeHook (const RooAbsArg *, const RooAbsArg *)
 
void addServer (RooAbsArg &server, Bool_t valueProp=kTRUE, Bool_t shapeProp=kFALSE, std::size_t refCount=1)
 Register another RooAbsArg as a server to us, ie, declare that we depend on it. More...
 
void addServerList (RooAbsCollection &serverList, Bool_t valueProp=kTRUE, Bool_t shapeProp=kFALSE)
 Register a list of RooAbsArg as servers to us by calling addServer() for each arg in the list. More...
 
void replaceServer (RooAbsArg &oldServer, RooAbsArg &newServer, Bool_t valueProp, Bool_t shapeProp)
 Replace 'oldServer' with 'newServer'. More...
 
void changeServer (RooAbsArg &server, Bool_t valueProp, Bool_t shapeProp)
 Change dirty flag propagation mask for specified server. More...
 
void removeServer (RooAbsArg &server, Bool_t force=kFALSE)
 Unregister another RooAbsArg as a server to us, ie, declare that we no longer depend on its value and shape. More...
 
RooAbsArgfindNewServer (const RooAbsCollection &newSet, Bool_t nameChange) const
 Find the new server in the specified set that matches the old server. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. More...
 

Static Public Attributes

static const std::map< std::string, RooAbsCategory::value_type >::value_type _invalidCategory {"", std::numeric_limits<RooAbsCategory::value_type>::min()}
 A category state to signify an invalid category. The first member is std::numeric_limits<int>::min(), the name is empty. More...
 

Protected Member Functions

virtual void attachToTree (TTree &t, Int_t bufSize=32000)
 Attach the category index and label as branches to the given TTree. More...
 
virtual void attachToVStore (RooVectorDataStore &vstore)
 Attach the category index and label to as branches to the given vector store. More...
 
void clearTypes ()
 Delete all currently defined states. More...
 
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. More...
 
virtual const std::map< std::string, RooAbsCategory::value_type >::value_typedefineState (const std::string &label)
 Define a new state with given label. More...
 
virtual const std::map< std::string, RooAbsCategory::value_type >::value_typedefineState (const std::string &label, value_type index)
 Define new state with given name and index number. More...
 
void defineStateUnchecked (const std::string &label, value_type index)
 Internal version of defineState() that does not check if type already exists. More...
 
virtual value_type evaluate () const =0
 Evaluate the category state and return. More...
 
virtual void fillTreeBranch (TTree &t)
 Fill tree branches associated with current object with current value. More...
 
virtual bool isValid () const
 WVE (08/21/01) Probably obsolete now. More...
 
value_type nextAvailableStateIndex () const
 
virtual void recomputeShape ()=0
 If a category depends on the shape of others, *i.e. More...
 
RooCatTyperetrieveLegacyState (value_type index) const
 Return the legacy RooCatType corresponding to index. If it doesn't exist, create one. More...
 
virtual void setTreeBranchStatus (TTree &t, Bool_t active)
 (De)activate associate tree branch More...
 
const std::map< std::string, value_type > & stateNames () const
 Access the map of state names to index numbers. More...
 
std::map< std::string, value_type > & stateNames ()
 Access the map of state names to index numbers. More...
 
virtual void syncCache (const RooArgSet *set=0)
 Explicitly synchronize RooAbsCategory internal cache. More...
 
- Protected Member Functions inherited from RooAbsArg
void attachToStore (RooAbsDataStore &store)
 Attach this argument to the data store such that it reads data from there. More...
 
TString cleanBranchName () const
 Construct a mangled name from the actual name that is free of any math symbols that might be interpreted by TTree. More...
 
void clearShapeDirty () const
 
void clearValueAndShapeDirty () const
 
void clearValueDirty () const
 
virtual void getObservablesHook (const RooArgSet *, RooArgSet *) const
 
virtual void getParametersHook (const RooArgSet *, RooArgSet *, Bool_t) const
 
RooAbsProxygetProxy (Int_t index) const
 Return the nth proxy from the proxy list. More...
 
void graphVizAddConnections (std::set< std::pair< RooAbsArg *, RooAbsArg *> > &)
 Utility function that inserts all point-to-point client-server connections between any two RooAbsArgs in the expression tree headed by this object in the linkSet argument. More...
 
Bool_t inhibitDirty () const
 Delete watch flag. More...
 
virtual void ioStreamerPass2 ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass. More...
 
Int_t numProxies () const
 Return the number of registered proxies. More...
 
virtual void operModeHook ()
 
virtual void optimizeDirtyHook (const RooArgSet *)
 
void printAttribList (std::ostream &os) const
 Transient boolean attributes (not copied in ctor) More...
 
void registerProxy (RooArgProxy &proxy)
 Register an RooArgProxy in the proxy list. More...
 
void registerProxy (RooSetProxy &proxy)
 Register an RooSetProxy in the proxy list. More...
 
void registerProxy (RooListProxy &proxy)
 Register an RooListProxy in the proxy list. More...
 
void setProxyNormSet (const RooArgSet *nset)
 Forward a change in the cached normalization argset to all the registered proxies. More...
 
void setShapeDirty (const RooAbsArg *source)
 Notify that a shape-like property (e.g. binning) has changed. More...
 
void setValueDirty (const RooAbsArg *source)
 Force element to re-evaluate itself when a value is requested. More...
 
void unRegisterProxy (RooArgProxy &proxy)
 Remove proxy from proxy list. More...
 
void unRegisterProxy (RooSetProxy &proxy)
 Remove proxy from proxy list. More...
 
void unRegisterProxy (RooListProxy &proxy)
 Remove proxy from proxy list. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

UChar_t _byteValue {0}
 Keeps track in which order state numbers have been inserted. Make sure this is updated in recomputeShape(). More...
 
value_type _currentIndex {std::numeric_limits<int>::min()}
 
std::vector< std::string > _insertionOrder
 Map state names to index numbers. Make sure state names are updated in recomputeShape(). More...
 
std::map< value_type, std::unique_ptr< RooCatType, std::function< void(RooCatType *)> > > _legacyStates
 Transient cache for byte values from tree branches. More...
 
std::map< std::string, value_type_stateNames
 Current category state. More...
 
bool _treeVar {false}
 Map holding pointers to RooCatType instances. Only for legacy interface. Don't use if possible. More...
 
- Protected Attributes inherited from RooAbsArg
bool _allBatchesDirty {true}
 
std::set< std::string > _boolAttrib
 
std::set< std::string > _boolAttribTransient
 
std::deque< RooAbsCache * > _cacheList
 
RefCountList_t _clientList
 
RefCountList_t _clientListShape
 
RefCountList_t _clientListValue
 
Bool_t _deleteWatch
 
RooExpensiveObjectCache_eocache
 Prohibit server redirects – Debugging tool. More...
 
Bool_t _fast
 
Bool_t _isConstant
 Do not persist. Pointer to global instance of string that matches object named. More...
 
Bool_t _localNoInhibitDirty
 Cached isConstant status. More...
 
RooWorkspace_myws
 Prevent 'AlwaysDirty' mode for this node. More...
 
TNamed_namePtr
 
OperMode _operMode
 Mark batches as dirty (only meaningful for RooAbsReal). More...
 
RooArgSet_ownedComponents
 
Bool_t _prohibitServerRedirect
 Set of owned component. More...
 
RooRefArray _proxyList
 
RefCountList_t _serverList
 
Bool_t _shapeDirty
 
std::map< std::string, std::string > _stringAttrib
 
Bool_t _valueDirty
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Friends

class RooVectorDataStore
 

Legacy interface

Previous versions of RooAbsCategory were based on RooCatType, a class containing a state and a label.

It has been replaced by integers, which use less space and allow for faster access. The following part of the interface should not be used if possible. Since RooCatType in essence is only an index and a state name, equivalent functionality can be achieved using begin() and end() to iterate through pairs of <index, stateName> and by using using lookupName() and lookupIndex().

const RooCatTypelookupType (value_type index, Bool_t printError=kFALSE) const
 Find our type corresponding to the specified index, or return nullptr for no match. More...
 
const RooCatTypelookupType (const char *label, Bool_t printError=kFALSE) const
 Find our type corresponding to the specified label, or return 0 for no match. More...
 
const RooCatTypelookupType (const RooCatType &type, Bool_t printError=kFALSE) const
 Find our type that matches the specified type, or return 0 for no match. More...
 
TIteratortypeIterator () const
 
Int_t numTypes (const char *=0) const
 Return number of types defined (in range named rangeName if rangeName!=0) More...
 
Int_t getIndex () const
 Retrieve the current index. Use getCurrentIndex() for more clarity. More...
 
const char * getLabel () const
 Retrieve current label. Use getCurrentLabel() for more clarity. More...
 
virtual Bool_t isValid (const RooCatType &value) const
 Check if given state is defined for this object. More...
 
const RooCatTypedefineType (const char *label)
 
const RooCatTypedefineType (const char *label, int index)
 
const RooCatTypedefineTypeUnchecked (const char *label, value_type index)
 

Additional Inherited Members

- Static Public Member Functions inherited from RooAbsArg
static void setDirtyInhibit (Bool_t flag)
 Control global dirty inhibit mode. More...
 
static void verboseDirty (Bool_t flag)
 Activate verbose messaging related to dirty flag propagation. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from RooPrintable
static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 
- Static Protected Member Functions inherited from RooAbsArg
static void ioStreamerPass2Finalize ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass. More...
 
- Static Protected Attributes inherited from RooAbsArg
static Bool_t _inhibitDirty
 
static Bool_t _verboseDirty
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooAbsCategory.h>

Inheritance diagram for RooAbsCategory:
[legend]

Member Typedef Documentation

◆ value_type

The type used to denote a specific category state.

Definition at line 40 of file RooAbsCategory.h.

Constructor & Destructor Documentation

◆ RooAbsCategory() [1/3]

RooAbsCategory::RooAbsCategory ( )
inline

Definition at line 45 of file RooAbsCategory.h.

◆ RooAbsCategory() [2/3]

RooAbsCategory::RooAbsCategory ( const char *  name,
const char *  title 
)

Constructor.

Definition at line 74 of file RooAbsCategory.cxx.

◆ RooAbsCategory() [3/3]

RooAbsCategory::RooAbsCategory ( const RooAbsCategory other,
const char *  name = 0 
)

Copy constructor, copies the registered category states from the original.

Definition at line 86 of file RooAbsCategory.cxx.

◆ ~RooAbsCategory()

RooAbsCategory::~RooAbsCategory ( )
virtual

Destructor.

Definition at line 101 of file RooAbsCategory.cxx.

Member Function Documentation

◆ attachToTree()

void RooAbsCategory::attachToTree ( TTree t,
Int_t  bufSize = 32000 
)
protectedvirtual

Attach the category index and label as branches to the given TTree.

The index field will be attached as integer with name <name>_idx. If a branch <name> exists, it attaches to this branch.

Implements RooAbsArg.

Definition at line 437 of file RooAbsCategory.cxx.

◆ attachToVStore()

void RooAbsCategory::attachToVStore ( RooVectorDataStore vstore)
protectedvirtual

Attach the category index and label to as branches to the given vector store.

Implements RooAbsArg.

Definition at line 424 of file RooAbsCategory.cxx.

◆ begin()

std::map<std::string, value_type>::const_iterator RooAbsCategory::begin ( ) const
inline

Iterator for category state names. Points to pairs of index and name.

Definition at line 101 of file RooAbsCategory.h.

◆ clearTypes()

void RooAbsCategory::clearTypes ( )
protected

Delete all currently defined states.

Definition at line 266 of file RooAbsCategory.cxx.

◆ copyCache()

void RooAbsCategory::copyCache ( const RooAbsArg source,
Bool_t  valueOnly = kFALSE,
Bool_t  setValDirty = kTRUE 
)
protectedvirtual

Copy the cached value from given source and raise dirty flag.

It is the callers responsibility to ensure that the sources cache is clean(valid) before this function is called, e.g. by calling syncCache() on the source.

Implements RooAbsArg.

Reimplemented in RooAbsCategoryLValue.

Definition at line 526 of file RooAbsCategory.cxx.

◆ createFundamental()

RooAbsArg * RooAbsCategory::createFundamental ( const char *  newname = 0) const
virtual

Create a RooCategory fundamental object with our properties.

Implements RooAbsArg.

Definition at line 614 of file RooAbsCategory.cxx.

◆ createTable()

Roo1DTable * RooAbsCategory::createTable ( const char *  label) const

Create a table matching the shape of this category.

Definition at line 359 of file RooAbsCategory.cxx.

◆ defineState() [1/2]

const std::map< std::string, RooAbsCategory::value_type >::value_type & RooAbsCategory::defineState ( const std::string &  label)
protectedvirtual

Define a new state with given label.

The next available integer is assigned as index value.

Definition at line 209 of file RooAbsCategory.cxx.

◆ defineState() [2/2]

const std::map< std::string, RooAbsCategory::value_type >::value_type & RooAbsCategory::defineState ( const std::string &  label,
RooAbsCategory::value_type  index 
)
protectedvirtual

Define new state with given name and index number.

Definition at line 234 of file RooAbsCategory.cxx.

◆ defineStateUnchecked()

void RooAbsCategory::defineStateUnchecked ( const std::string &  label,
RooAbsCategory::value_type  index 
)
protected

Internal version of defineState() that does not check if type already exists.

Definition at line 218 of file RooAbsCategory.cxx.

◆ defineType() [1/2]

const RooCatType * RooAbsCategory::defineType ( const char *  label)
protected

◆ defineType() [2/2]

const RooCatType * RooAbsCategory::defineType ( const char *  label,
int  index 
)
protected

◆ defineTypeUnchecked()

const RooCatType * RooAbsCategory::defineTypeUnchecked ( const char *  label,
value_type  index 
)
protected

◆ end()

std::map<std::string, value_type>::const_iterator RooAbsCategory::end ( ) const
inline

Iterator for category state names. Points to pairs of index and name.

Definition at line 105 of file RooAbsCategory.h.

◆ evaluate()

virtual value_type RooAbsCategory::evaluate ( ) const
protectedpure virtual

Evaluate the category state and return.

The returned state index should correspond to a state name that has been defined via e.g. defineType().

Implemented in RooCategory, RooMappedCategory, RooSuperCategory, RooThresholdCategory, RooMultiCategory, and RooBinningCategory.

◆ fillTreeBranch()

void RooAbsCategory::fillTreeBranch ( TTree t)
protectedvirtual

Fill tree branches associated with current object with current value.

Implements RooAbsArg.

Definition at line 480 of file RooAbsCategory.cxx.

◆ getCurrentIndex()

RooAbsCategory::value_type RooAbsCategory::getCurrentIndex ( ) const
virtual

Return index number of current state.

Reimplemented in RooCategory.

Definition at line 111 of file RooAbsCategory.cxx.

◆ getCurrentLabel()

const char * RooAbsCategory::getCurrentLabel ( ) const
virtual

Return label string of current state.

Reimplemented in RooMultiCategory.

Definition at line 127 of file RooAbsCategory.cxx.

◆ getCurrentOrdinalNumber()

unsigned int RooAbsCategory::getCurrentOrdinalNumber ( ) const

Return ordinal number of the current state.

Definition at line 589 of file RooAbsCategory.cxx.

◆ getIndex()

Int_t RooAbsCategory::getIndex ( ) const
inline

Retrieve the current index. Use getCurrentIndex() for more clarity.

Definition at line 138 of file RooAbsCategory.h.

◆ getLabel()

const char* RooAbsCategory::getLabel ( ) const
inline

Retrieve current label. Use getCurrentLabel() for more clarity.

Definition at line 140 of file RooAbsCategory.h.

◆ getOrdinal()

const std::map< std::string, RooAbsCategory::value_type >::value_type & RooAbsCategory::getOrdinal ( unsigned int  n) const

Return name and index of the nth defined state.

When states are defined using defineType() or operator[], the order of insertion is tracked, to mimic the behaviour before modernising the category classes. When directly manipulating the map with state names using states(), the order of insertion is not known, so alphabetical ordering as usual for std::map is used. The latter is faster.

Parameters
[in]nNumber of state to be retrieved.
Returns
A pair with name and index.

Definition at line 569 of file RooAbsCategory.cxx.

◆ getValBatch()

virtual RooSpan<const value_type> RooAbsCategory::getValBatch ( std::size_t  ,
std::size_t   
) const
inlinevirtual

Retrieve a batch of category values for events in the range [begin, begin+batchSize).

Reimplemented in RooCategory.

Definition at line 53 of file RooAbsCategory.h.

◆ hasIndex()

Bool_t RooAbsCategory::hasIndex ( RooAbsCategory::value_type  index) const

Check if a state with index index exists.

Definition at line 184 of file RooAbsCategory.cxx.

◆ hasLabel()

bool RooAbsCategory::hasLabel ( const std::string &  label) const
inline

Check if a state with name label exists.

Definition at line 70 of file RooAbsCategory.h.

◆ isIdentical()

Bool_t RooAbsCategory::isIdentical ( const RooAbsArg other,
Bool_t  assumeSameType = kFALSE 
) const
virtual

Implements RooAbsArg.

Definition at line 171 of file RooAbsCategory.cxx.

◆ isIntegrationSafeLValue()

virtual Bool_t RooAbsCategory::isIntegrationSafeLValue ( const RooArgSet ) const
inlinevirtual

Definition at line 93 of file RooAbsCategory.h.

◆ isSignType()

Bool_t RooAbsCategory::isSignType ( Bool_t  mustHaveZero = kFALSE) const

Determine if category has 2 or 3 states with index values -1,0,1.

Definition at line 632 of file RooAbsCategory.cxx.

◆ isValid() [1/2]

Bool_t RooAbsCategory::isValid ( const RooCatType value) const
protectedvirtual

Check if given state is defined for this object.

Definition at line 349 of file RooAbsCategory.cxx.

◆ isValid() [2/2]

virtual bool RooAbsCategory::isValid ( ) const
inlineprotectedvirtual

WVE (08/21/01) Probably obsolete now.

Reimplemented from RooAbsArg.

Definition at line 197 of file RooAbsCategory.h.

◆ lookupIndex()

RooAbsCategory::value_type RooAbsCategory::lookupIndex ( const std::string &  stateName) const

Find the index number corresponding to the state name.

See also
hasLabel() for checking if a given label has been defined.
Returns
Index of the category or std::numeric_limits<int>::min() on failure.

Definition at line 279 of file RooAbsCategory.cxx.

◆ lookupName()

const std::string & RooAbsCategory::lookupName ( value_type  index) const

Get the name corresponding to the given index.

Look up the name corresponding to the given index.

Returns
Name or empty string if index is invalid.

Definition at line 197 of file RooAbsCategory.cxx.

◆ lookupType() [1/3]

const RooCatType * RooAbsCategory::lookupType ( RooAbsCategory::value_type  index,
Bool_t  printError = kFALSE 
) const

Find our type corresponding to the specified index, or return nullptr for no match.

Deprecated:
RooCatType is not used, any more. This function will create one and let it leak. Use lookupIndex() (preferred) or lookupName() instead.

Definition at line 303 of file RooAbsCategory.cxx.

◆ lookupType() [2/3]

const RooCatType * RooAbsCategory::lookupType ( const char *  label,
Bool_t  printError = kFALSE 
) const

Find our type corresponding to the specified label, or return 0 for no match.

Deprecated:
RooCatType is not used, any more. This function will create one and let it leak. Use lookupIndex() (preferred) or lookupName() instead.

Definition at line 324 of file RooAbsCategory.cxx.

◆ lookupType() [3/3]

const RooCatType * RooAbsCategory::lookupType ( const RooCatType other,
Bool_t  printError = kFALSE 
) const

Find our type that matches the specified type, or return 0 for no match.

Deprecated:
RooCatType is not used, any more. This function will create one and let it leak. Use lookupIndex() (preferred) or lookupName() instead.

Definition at line 292 of file RooAbsCategory.cxx.

◆ nextAvailableStateIndex()

RooAbsCategory::value_type RooAbsCategory::nextAvailableStateIndex ( ) const
protected

Definition at line 681 of file RooAbsCategory.cxx.

◆ numTypes()

Int_t RooAbsCategory::numTypes ( const char *  = 0) const
inline

Return number of types defined (in range named rangeName if rangeName!=0)

Definition at line 134 of file RooAbsCategory.h.

◆ operator!=() [1/3]

Definition at line 62 of file RooAbsCategory.h.

◆ operator!=() [2/3]

Bool_t RooAbsCategory::operator!= ( const char *  label)
inline

Definition at line 64 of file RooAbsCategory.h.

◆ operator!=() [3/3]

Bool_t RooAbsCategory::operator!= ( const RooAbsArg other)
inline

Definition at line 66 of file RooAbsCategory.h.

◆ operator==() [1/3]

Bool_t RooAbsCategory::operator== ( RooAbsCategory::value_type  index) const

Equality operator with a integer (compares with state index number)

Definition at line 141 of file RooAbsCategory.cxx.

◆ operator==() [2/3]

Bool_t RooAbsCategory::operator== ( const char *  label) const

Equality operator with a string (compares with state label string)

Definition at line 151 of file RooAbsCategory.cxx.

◆ operator==() [3/3]

Bool_t RooAbsCategory::operator== ( const RooAbsArg other) const
virtual

Equality operator with another RooAbsArg.

Only functional is also a RooAbsCategory, will return true if index is the same

Implements RooAbsArg.

Definition at line 162 of file RooAbsCategory.cxx.

◆ printMultiline()

void RooAbsCategory::printMultiline ( std::ostream &  os,
Int_t  contents,
Bool_t  verbose = kFALSE,
TString  indent = "" 
) const
virtual

Print info about this object to the specified stream.

In addition to the info from RooAbsArg::printStream() we add:

Shape : label, index, defined types  

Reimplemented from RooAbsArg.

Reimplemented in RooMappedCategory, RooSuperCategory, RooThresholdCategory, RooMultiCategory, and RooBinningCategory.

Definition at line 402 of file RooAbsCategory.cxx.

◆ printValue()

void RooAbsCategory::printValue ( std::ostream &  os) const
virtual

Print value (label name)

Reimplemented from RooPrintable.

Definition at line 389 of file RooAbsCategory.cxx.

◆ readFromStream()

Bool_t RooAbsCategory::readFromStream ( std::istream &  is,
Bool_t  compact,
Bool_t  verbose = kFALSE 
)
virtual

Read object contents from stream (dummy for now)

Implements RooAbsArg.

Reimplemented in RooMappedCategory, RooCategory, and RooMultiCategory.

Definition at line 369 of file RooAbsCategory.cxx.

◆ recomputeShape()

virtual void RooAbsCategory::recomputeShape ( )
protectedpure virtual

If a category depends on the shape of others, *i.e.

*, its state numbers or names depend on the states of other categories, this function has to be implemented to recompute _stateNames and _insertionOrder. If one of these two changes, setShapeDirty() has to be called to propagate this information to possible users of this category.

Implemented in RooCategory, RooMappedCategory, RooSuperCategory, RooThresholdCategory, RooMultiCategory, and RooBinningCategory.

◆ retrieveLegacyState()

RooCatType * RooAbsCategory::retrieveLegacyState ( value_type  index) const
protected

Return the legacy RooCatType corresponding to index. If it doesn't exist, create one.

Definition at line 670 of file RooAbsCategory.cxx.

◆ setTreeBranchStatus()

void RooAbsCategory::setTreeBranchStatus ( TTree t,
Bool_t  active 
)
protectedvirtual

(De)activate associate tree branch

Implements RooAbsArg.

Definition at line 500 of file RooAbsCategory.cxx.

◆ size()

std::size_t RooAbsCategory::size ( ) const
inline

Number of states defined.

Definition at line 109 of file RooAbsCategory.h.

◆ stateNames() [1/2]

const std::map<std::string, value_type>& RooAbsCategory::stateNames ( ) const
inlineprotected

Access the map of state names to index numbers.

Triggers a recomputation if the shape is dirty.

Definition at line 163 of file RooAbsCategory.h.

◆ stateNames() [2/2]

std::map<std::string, value_type>& RooAbsCategory::stateNames ( )
inlineprotected

Access the map of state names to index numbers.

Triggers a recomputation if the shape is dirty.

Definition at line 173 of file RooAbsCategory.h.

◆ syncCache()

void RooAbsCategory::syncCache ( const RooArgSet set = 0)
protectedvirtual

Explicitly synchronize RooAbsCategory internal cache.

Implements RooAbsArg.

Definition at line 513 of file RooAbsCategory.cxx.

◆ typeIterator()

TIterator * RooAbsCategory::typeIterator ( ) const
Deprecated:
Use begin() and end() instead.
Note
Using this iterator creates useless RooCatType instances, which will leak unless deleted by the user.

Definition at line 650 of file RooAbsCategory.cxx.

◆ writeToStream()

void RooAbsCategory::writeToStream ( std::ostream &  os,
Bool_t  compact 
) const
virtual

Write object contents to ostream.

Implements RooAbsArg.

Reimplemented in RooMappedCategory, RooCategory, RooThresholdCategory, and RooMultiCategory.

Definition at line 379 of file RooAbsCategory.cxx.

Friends And Related Function Documentation

◆ RooVectorDataStore

friend class RooVectorDataStore
friend

Definition at line 208 of file RooAbsCategory.h.

Member Data Documentation

◆ _byteValue

UChar_t RooAbsCategory::_byteValue {0}
mutableprotected

Keeps track in which order state numbers have been inserted. Make sure this is updated in recomputeShape().

Definition at line 223 of file RooAbsCategory.h.

◆ _currentIndex

value_type RooAbsCategory::_currentIndex {std::numeric_limits<int>::min()}
mutableprotected

Definition at line 220 of file RooAbsCategory.h.

◆ _insertionOrder

std::vector<std::string> RooAbsCategory::_insertionOrder
protected

Map state names to index numbers. Make sure state names are updated in recomputeShape().

Definition at line 222 of file RooAbsCategory.h.

◆ _invalidCategory

const std::map< std::string, RooAbsCategory::value_type >::value_type RooAbsCategory::_invalidCategory {"", std::numeric_limits<RooAbsCategory::value_type>::min()}
static

A category state to signify an invalid category. The first member is std::numeric_limits<int>::min(), the name is empty.

Definition at line 42 of file RooAbsCategory.h.

◆ _legacyStates

std::map<value_type, std::unique_ptr<RooCatType, std::function<void(RooCatType*)> > > RooAbsCategory::_legacyStates
mutableprotected

Transient cache for byte values from tree branches.

Definition at line 224 of file RooAbsCategory.h.

◆ _stateNames

std::map<std::string, value_type> RooAbsCategory::_stateNames
protected

Current category state.

Definition at line 221 of file RooAbsCategory.h.

◆ _treeVar

bool RooAbsCategory::_treeVar {false}
protected

Map holding pointers to RooCatType instances. Only for legacy interface. Don't use if possible.

Definition at line 225 of file RooAbsCategory.h.

Libraries for RooAbsCategory:
[legend]

The documentation for this class was generated from the following files: