Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsCategory Class Referenceabstract

A space to attach TBranches.

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 33 of file RooAbsCategory.h.

Public Types

using value_type = int
 The type used to denote a specific category state.
 
- 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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 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.
 
 RooAbsCategory (const RooAbsCategory &other, const char *name=nullptr)
 Copy constructor, copies the registered category states from the original.
 
 ~RooAbsCategory () override
 Destructor.
 
std::map< std::string, value_type >::const_iterator begin () const
 Iterator for category state names. Points to pairs of index and name.
 
RooFit::OwningPtr< RooAbsArgcreateFundamental (const char *newname=nullptr) const override
 Create a RooCategory fundamental object with our properties.
 
Roo1DTablecreateTable (const char *label) const
 Create a table matching the shape of this category.
 
bool empty () const
 If there are no states defined.
 
std::map< std::string, value_type >::const_iterator end () const
 Iterator for category state names. Points to pairs of index and name.
 
virtual value_type getCurrentIndex () const
 Return index number of current state.
 
virtual const char * getCurrentLabel () const
 Return label string of current state.
 
unsigned int getCurrentOrdinalNumber () const
 Return ordinal number of the current state.
 
const std::map< std::string, value_type >::value_typegetOrdinal (unsigned int n) const
 Return name and index of the nth defined state.
 
bool hasIndex (value_type index) const
 Check if a state with index index exists.
 
bool hasLabel (const std::string &label) const
 Check if a state with name label exists.
 
TClassIsA () const override
 
bool isCategory () const override
 
bool isIdentical (const RooAbsArg &other, bool assumeSameType=false) const override
 
virtual bool isIntegrationSafeLValue (const RooArgSet *) const
 
bool isSignType (bool mustHaveZero=false) const
 Determine if category has 2 or 3 states with index values -1,0,1.
 
value_type lookupIndex (const std::string &stateName) const
 Find the index number corresponding to the state name.
 
const std::string & lookupName (value_type index) const
 Get the name corresponding to the given index.
 
bool operator!= (const char *label)
 
bool operator!= (const RooAbsArg &other)
 
bool operator!= (value_type index)
 
bool operator== (const char *label) const
 Equality operator with a string (compares with state label string)
 
bool operator== (const RooAbsArg &other) const override
 Equality operator with another RooAbsArg.
 
bool operator== (value_type index) const
 Equality operator with a integer (compares with state index number)
 
void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
 Print info about this object to the specified stream.
 
void printValue (std::ostream &os) const override
 Print value (label name)
 
bool readFromStream (std::istream &is, bool compact, bool verbose=false) override
 Read object contents from stream (dummy for now)
 
std::size_t size () const
 Number of states defined.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void writeToStream (std::ostream &os, bool compact) const override
 Write object contents to ostream.
 
- Public Member Functions inherited from RooAbsArg
 RooAbsArg ()
 Default constructor.
 
 RooAbsArg (const char *name, const char *title)
 Create an object with the specified name and descriptive title.
 
 RooAbsArg (const RooAbsArg &other, const char *name=nullptr)
 Copy constructor transfers all boolean and string properties of the original object.
 
 ~RooAbsArg () override
 Destructor.
 
bool addOwnedComponents (const RooAbsCollection &comps)
 Take ownership of the contents of 'comps'.
 
bool addOwnedComponents (RooAbsCollection &&comps)
 Take ownership of the contents of 'comps'.
 
bool addOwnedComponents (RooArgList &&comps)
 Take ownership of the contents of 'comps'.
 
template<typename... Args_t>
bool addOwnedComponents (std::unique_ptr< Args_t >... comps)
 
virtual void applyWeightSquared (bool flag)
 Disables or enables the usage of squared weights.
 
void attachArgs (const RooAbsCollection &set)
 Bind this node to objects in set.
 
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.
 
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.
 
const std::set< std::string > & attributes () const
 
virtual bool canComputeBatchWithCuda () const
 
virtual bool checkObservables (const RooArgSet *nset) const
 Overloadable function in which derived classes can implement consistency checks of the variables.
 
virtual TObjectclone (const char *newname=nullptr) const =0
 
TObjectClone (const char *newname=nullptr) const override
 Make a clone of an object using the Streamer facility.
 
virtual RooAbsArgcloneTree (const char *newname=nullptr) const
 Clone tree expression of objects.
 
Int_t Compare (const TObject *other) const override
 Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name.
 
virtual std::unique_ptr< RooAbsArgcompileForNormSet (RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const
 
std::size_t dataToken () const
 Returns the token for retrieving results in the BatchMode. For internal use only.
 
Int_t defaultPrintContents (Option_t *opt) const override
 Define default contents to print.
 
bool dependsOn (const RooAbsArg &server, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
 Test whether we depend on (ie, are served by) the specified object.
 
bool dependsOn (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
 Test whether we depend on (ie, are served by) any object in the specified collection.
 
bool dependsOn (TNamed const *namePtr, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
 Test whether we depend on (ie, are served by) an object with a specific name.
 
bool dependsOnValue (const RooAbsArg &server, const RooAbsArg *ignoreArg=nullptr) const
 Check whether this object depends on values served from the object passed as server.
 
bool dependsOnValue (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=nullptr) const
 Check whether this object depends on values from an element in the serverList.
 
bool getAttribute (const Text_t *name) const
 Check if a named attribute is set. By default, all attributes are unset.
 
RooFit::OwningPtr< RooArgSetgetComponents () const
 Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.
 
bool getObservables (const RooAbsCollection *depList, RooArgSet &outputSet, bool valueOnly=true) 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.
 
RooFit::OwningPtr< RooArgSetgetObservables (const RooAbsData &data) const
 Return the observables of this pdf given the observables defined by data.
 
RooFit::OwningPtr< 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).
 
RooFit::OwningPtr< RooArgSetgetObservables (const RooArgSet &set, bool valueOnly=true) const
 Given a set of possible observables, return the observables that this PDF depends on.
 
RooFit::OwningPtr< RooArgSetgetObservables (const RooArgSet *depList, bool valueOnly=true) 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.
 
RooFit::OwningPtr< RooArgSetgetParameters (const RooAbsData &data, bool stripDisconnected=true) const
 Return the parameters of this p.d.f when used in conjunction with dataset 'data'.
 
RooFit::OwningPtr< RooArgSetgetParameters (const RooAbsData *data, bool stripDisconnected=true) 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).
 
RooFit::OwningPtr< RooArgSetgetParameters (const RooArgSet &observables, bool stripDisconnected=true) const
 Return the parameters of the p.d.f given the provided set of observables.
 
RooFit::OwningPtr< RooArgSetgetParameters (const RooArgSet *observables, bool stripDisconnected=true) 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.
 
virtual bool getParameters (const RooArgSet *observables, RooArgSet &outputSet, bool stripDisconnected=true) const
 Fills a list with 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.
 
RooAbsProxygetProxy (Int_t index) const
 Return the nth proxy from the proxy list.
 
const Text_tgetStringAttribute (const Text_t *key) const
 Get string attribute mapped under key 'key'.
 
bool getTransientAttribute (const Text_t *name) const
 Check if a named attribute is set.
 
RooFit::OwningPtr< RooArgSetgetVariables (bool stripDisconnected=true) const
 Return RooArgSet with all variables (tree leaf nodes of expression tree)
 
void graphVizTree (const char *fileName, const char *delimiter="\n", bool useTitle=false, bool useLatex=false)
 Create a GraphViz .dot file visualizing the expression tree headed by this RooAbsArg object.
 
void graphVizTree (std::ostream &os, const char *delimiter="\n", bool useTitle=false, bool useLatex=false)
 Write the GraphViz representation of the expression tree headed by this RooAbsArg object to the given ostream.
 
bool hasClients () const
 
bool hasDataToken () const
 
virtual bool hasRange (const char *) const
 
virtual bool importWorkspaceHook (RooWorkspace &ws)
 
virtual bool inRange (const char *) const
 
bool isConstant () const
 Check if the "Constant" attribute is set.
 
virtual bool isDerived () const
 Does value or shape of this arg depend on any other arg?
 
virtual bool isReducerNode () const
 
bool IsSortable () const override
 
bool localNoDirtyInhibit () const
 
const TNamednamePtr () const
 De-duplicated pointer to this object's name.
 
Int_t numProxies () const
 Return the number of registered proxies.
 
bool 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.
 
bool 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.
 
RooAbsArgoperator= (const RooAbsArg &other)=delete
 
bool overlaps (const RooAbsArg &testArg, bool valueOnly=false) const
 Test if any of the nodes of tree are shared with that of the given tree.
 
const RooArgSetownedComponents () const
 
void Print (Option_t *options=nullptr) const override
 Print the object to the defaultPrintStream().
 
void printAddress (std::ostream &os) const override
 Print address of this RooAbsArg.
 
void printArgs (std::ostream &os) const override
 Print object arguments, ie its proxies.
 
void printClassName (std::ostream &os) const override
 Print object class name.
 
void printCompactTree (const char *indent="", const char *fileName=nullptr, const char *namePat=nullptr, RooAbsArg *client=nullptr)
 Print tree structure of expression tree on stdout, or to file if filename is specified.
 
void printCompactTree (std::ostream &os, const char *indent="", const char *namePat=nullptr, RooAbsArg *client=nullptr)
 Print tree structure of expression tree on given ostream.
 
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.
 
void printComponentTree (const char *indent="", const char *namePat=nullptr, Int_t nLevel=999)
 Print tree structure of expression tree on given ostream, only branch nodes are printed.
 
void printDirty (bool depth=true) const
 Print information about current value dirty state information.
 
virtual void printMetaArgs (std::ostream &) const
 
void printName (std::ostream &os) const override
 Print object name.
 
void printTitle (std::ostream &os) const override
 Print object title.
 
void printTree (std::ostream &os, TString indent="") const override
 Print object tree structure.
 
bool recursiveCheckObservables (const RooArgSet *nset) const
 Recursively call checkObservables on all nodes in the expression tree.
 
void removeStringAttribute (const Text_t *key)
 Delete a string attribute with a given key.
 
void resetDataToken ()
 
void setAttribute (const Text_t *name, bool value=true)
 Set (default) or clear a named boolean attribute of this object.
 
void setDataToken (std::size_t index)
 Sets the token for retrieving results in the BatchMode. For internal use only.
 
void setLocalNoDirtyInhibit (bool flag) const
 
void SetName (const char *name) override
 Set the name of the TNamed.
 
void SetNameTitle (const char *name, const char *title) override
 Set all the TNamed parameters (name and title).
 
void setProhibitServerRedirect (bool flag)
 
void setStringAttribute (const Text_t *key, const Text_t *value)
 Associate string 'value' to this object under key 'key'.
 
void setTransientAttribute (const Text_t *name, bool value=true)
 Set (default) or clear a named boolean attribute of this object.
 
void setWorkspace (RooWorkspace &ws)
 
const std::map< std::string, std::string > & stringAttributes () const
 
const std::set< std::string > & transientAttributes () const
 
virtual void translate (RooFit::Detail::CodeSquashContext &ctx) const
 This function defines a translation for each RooAbsReal based object that can be used to express the class as simple C++ code.
 
RooWorkspaceworkspace () const
 
TIteratorclientIterator () const
 Retrieve a client iterator.
 
TIteratorvalueClientIterator () const
 
TIteratorshapeClientIterator () const
 
TIteratorserverIterator () const
 
RooFIter valueClientMIterator () const
 
RooFIter shapeClientMIterator () const
 
RooFIter serverMIterator () const
 
RooFit::OwningPtr< RooArgSetgetDependents (const RooArgSet &set) const
 
RooFit::OwningPtr< RooArgSetgetDependents (const RooAbsData *set) const
 
RooFit::OwningPtr< RooArgSetgetDependents (const RooArgSet *depList) const
 
bool dependentOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
 
bool dependentOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
 
bool checkDependents (const RooArgSet *nset) const
 
bool recursiveCheckDependents (const RooArgSet *nset) const
 
const RefCountList_tclients () const
 List of all clients of this object.
 
const RefCountList_tvalueClients () const
 List of all value clients of this object. Value clients receive value updates.
 
const RefCountList_tshapeClients () const
 List of all shape clients of this object.
 
const RefCountList_tservers () const
 List of all servers of this object.
 
RooAbsArgfindServer (const char *name) const
 Return server of this with name name. Returns nullptr if not found.
 
RooAbsArgfindServer (const RooAbsArg &arg) const
 Return server of this that has the same name as arg. Returns nullptr if not found.
 
RooAbsArgfindServer (Int_t index) const
 Return i-th server from server list.
 
bool isValueServer (const RooAbsArg &arg) const
 Check if this is serving values to arg.
 
bool isValueServer (const char *name) const
 Check if this is serving values to an object with name name.
 
bool isShapeServer (const RooAbsArg &arg) const
 Check if this is serving shape to arg.
 
bool isShapeServer (const char *name) const
 Check if this is serving shape to an object with name name.
 
void leafNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool recurseNonDerived=false) const
 Fill supplied list with all leaf nodes of the arg tree, starting with ourself as top node.
 
void branchNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool recurseNonDerived=false) const
 Fill supplied list with all branch nodes of the arg tree starting with ourself as top node.
 
void treeNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool doBranch=true, bool doLeaf=true, bool valueOnly=false, bool recurseNonDerived=false) const
 Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node.
 
virtual bool isFundamental () const
 Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return true.
 
virtual bool 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.
 
bool redirectServers (const RooAbsCollection &newServerList, bool mustReplaceAll=false, bool nameChange=false, bool isRecursionStep=false)
 Replace all direct servers of this object with the new servers in newServerList.
 
bool redirectServers (std::unordered_map< RooAbsArg *, RooAbsArg * > const &replacements)
 Replace some servers of this object.
 
bool recursiveRedirectServers (const RooAbsCollection &newServerList, bool mustReplaceAll=false, bool nameChange=false, bool recurseInNewSet=true)
 Recursively replace all servers with the new servers in newSet.
 
virtual bool redirectServersHook (const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep)
 Function that is called at the end of redirectServers().
 
virtual void serverNameChangeHook (const RooAbsArg *, const RooAbsArg *)
 
void addServer (RooAbsArg &server, bool valueProp=true, bool shapeProp=false, std::size_t refCount=1)
 Register another RooAbsArg as a server to us, ie, declare that we depend on it.
 
void addServerList (RooAbsCollection &serverList, bool valueProp=true, bool shapeProp=false)
 Register a list of RooAbsArg as servers to us by calling addServer() for each arg in the list.
 
void replaceServer (RooAbsArg &oldServer, RooAbsArg &newServer, bool valueProp, bool shapeProp)
 Replace 'oldServer' with 'newServer', specifying whether the new server has value or shape server properties.
 
void changeServer (RooAbsArg &server, bool valueProp, bool shapeProp)
 Change dirty flag propagation mask for specified server.
 
void removeServer (RooAbsArg &server, bool force=false)
 Unregister another RooAbsArg as a server to us, ie, declare that we no longer depend on its value and shape.
 
RooAbsArgfindNewServer (const RooAbsCollection &newSet, bool nameChange) const
 Find the new server in the specified set that matches the old server.
 
virtual void optimizeCacheMode (const RooArgSet &observables)
 Activate cache mode optimization with given definition of observables.
 
virtual void optimizeCacheMode (const RooArgSet &observables, RooArgSet &optNodes, RooLinkedList &processedNodes)
 Activate cache mode optimization with given definition of observables.
 
bool 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.
 
bool 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.
 
virtual void constOptimizeTestStatistic (ConstOpCode opcode, bool doAlsoTrackingOpt=true)
 Interface function signaling a request to perform constant term optimization.
 
virtual CacheMode canNodeBeCached () const
 
virtual void setCacheAndTrackHints (RooArgSet &)
 
bool isShapeDirty () const
 
bool isValueDirty () const
 
bool isValueDirtyAndClear () const
 
bool isValueOrShapeDirtyAndClear () const
 
void registerCache (RooAbsCache &cache)
 Register RooAbsCache with this object.
 
void unRegisterCache (RooAbsCache &cache)
 Unregister a RooAbsCache. Called from the RooAbsCache destructor.
 
Int_t numCaches () const
 Return number of registered caches.
 
RooAbsCachegetCache (Int_t index) const
 Return registered cache object by index.
 
OperMode operMode () const
 Query the operation mode of this node.
 
void setOperMode (OperMode mode, bool recurseADirty=true)
 Set the operation mode of this node.
 
void setValueDirty ()
 Mark the element dirty. This forces a re-evaluation when a value is requested.
 
void setShapeDirty ()
 Notify that a shape-like property (e.g. binning) has changed.
 
const char * aggregateCacheUniqueSuffix () const
 
virtual const char * cacheUniqueSuffix () const
 
void wireAllCaches ()
 
RooExpensiveObjectCacheexpensiveObjectCache () const
 
virtual void setExpensiveObjectCache (RooExpensiveObjectCache &cache)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 
- 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.
 
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'.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 A buffer for reading values from trees.
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from RooAbsArg
static void setDirtyInhibit (bool flag)
 Control global dirty inhibit mode.
 
static void verboseDirty (bool flag)
 Activate verbose messaging related to dirty flag propagation.
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Static Public Member Functions inherited from RooPrintable
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
 Return a reference to the current default stream to use in Print().
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
 

Protected Member Functions

void attachToTree (TTree &t, Int_t bufSize=32000) override
 Attach the category index and label as branches to the given TTree.
 
void attachToVStore (RooVectorDataStore &vstore) override
 Attach the category index and label to as branches to the given vector store.
 
void clearTypes ()
 Delete all currently defined states.
 
void copyCache (const RooAbsArg *source, bool valueOnly=false, bool setValueDirty=true) override
 Copy the cached value from given source and raise dirty flag.
 
virtual const std::map< std::string, RooAbsCategory::value_type >::value_typedefineState (const std::string &label)
 Define a new state with given label.
 
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.
 
void defineStateUnchecked (const std::string &label, value_type index)
 Internal version of defineState() that does not check if type already exists.
 
virtual value_type evaluate () const =0
 Evaluate the category state and return.
 
void fillTreeBranch (TTree &t) override
 Fill tree branches associated with current object with current value.
 
bool isValid () const override
 WVE (08/21/01) Probably obsolete now.
 
value_type nextAvailableStateIndex () const
 
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 other categories, this function has to be implemented to recompute _stateNames and _insertionOrder.
 
RooCatTyperetrieveLegacyState (value_type index) const
 Return the legacy RooCatType corresponding to index. If it doesn't exist, create one.
 
void setCachedValue (double value, bool notifyClients=true) final
 Overwrite the value stored in this object's cache.
 
void setTreeBranchStatus (TTree &t, bool active) override
 (De)activate associate tree branch
 
std::map< std::string, value_type > & stateNames ()
 Access the map of state names to index numbers.
 
const std::map< std::string, value_type > & stateNames () const
 Access the map of state names to index numbers.
 
void syncCache (const RooArgSet *set=nullptr) override
 Explicitly synchronize RooAbsCategory internal cache.
 
- Protected Member Functions inherited from RooAbsArg
void attachToStore (RooAbsDataStore &store)
 Attach this argument to the data store such that it reads data from there.
 
TString cleanBranchName () const
 Construct a mangled name from the actual name that is free of any math symbols that might be interpreted by TTree.
 
void clearShapeDirty () const
 
void clearValueAndShapeDirty () const
 
void clearValueDirty () const
 
virtual void getObservablesHook (const RooArgSet *, RooArgSet *) const
 
virtual void getParametersHook (const RooArgSet *, RooArgSet *, bool) const
 
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.
 
bool inhibitDirty () const
 Delete watch flag.
 
virtual void ioStreamerPass2 ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.
 
virtual void operModeHook ()
 
virtual void optimizeDirtyHook (const RooArgSet *)
 
void printAttribList (std::ostream &os) const
 Transient boolean attributes (not copied in ctor)
 
void registerProxy (RooArgProxy &proxy)
 Register an RooArgProxy in the proxy list.
 
void registerProxy (RooListProxy &proxy)
 Register an RooListProxy in the proxy list.
 
void registerProxy (RooSetProxy &proxy)
 Register an RooSetProxy in the proxy list.
 
void setProxyNormSet (const RooArgSet *nset)
 Forward a change in the cached normalization argset to all the registered proxies.
 
void setShapeDirty (const RooAbsArg *source)
 Notify that a shape-like property (e.g. binning) has changed.
 
void setValueDirty (const RooAbsArg *source)
 Force element to re-evaluate itself when a value is requested.
 
void unRegisterProxy (RooArgProxy &proxy)
 Remove proxy from proxy list.
 
void unRegisterProxy (RooListProxy &proxy)
 Remove proxy from proxy list.
 
void unRegisterProxy (RooSetProxy &proxy)
 Remove proxy from proxy list.
 
- 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).
 
void MakeZombie ()
 

Static Protected Member Functions

static const decltype(_stateNames) ::value_typeinvalidCategory ()
 A category state to signify an invalid category.
 
- 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.
 

Protected Attributes

value_type _currentIndex {std::numeric_limits<int>::min()}
 Current category state.
 
std::vector< std::string > _insertionOrder
 Keeps track in which order state numbers have been inserted. Make sure this is updated in recomputeShape().
 
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.
 
std::map< std::string, value_type_stateNames
 Map state names to index numbers. Make sure state names are updated in recomputeShape().
 
- Protected Attributes inherited from RooAbsArg
std::set< std::string > _boolAttrib
 
std::set< std::string > _boolAttribTransient
 
std::vector< RooAbsCache * > _cacheList
 
RefCountList_t _clientList
 
RefCountList_t _clientListShape
 
RefCountList_t _clientListValue
 
std::size_t _dataToken = std::numeric_limits<std::size_t>::max()
 In which workspace do I live, if any.
 
bool _deleteWatch = false
 
RooExpensiveObjectCache_eocache {nullptr}
 Prohibit server redirects – Debugging tool.
 
bool _fast = false
 
bool _isConstant = false
 De-duplicated name pointer. This will be equal for all objects with the same name.
 
bool _localNoInhibitDirty = false
 Cached isConstant status.
 
RooWorkspace_myws = nullptr
 Prevent 'AlwaysDirty' mode for this node.
 
const TNamed_namePtr = nullptr
 Pointer to global cache manager for any expensive components created by this object.
 
OperMode _operMode = Auto
 
RooArgSet_ownedComponents = nullptr
 
bool _prohibitServerRedirect = false
 Set of owned component.
 
RooRefArray _proxyList
 
ProxyListCache _proxyListCache
 
RefCountList_t _serverList
 
bool _shapeDirty = true
 
std::map< std::string, std::string > _stringAttrib
 
bool _valueDirty = true
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Attributes

std::unique_ptr< TreeReadBuffer_treeReadBuffer
 

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

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Static Protected Attributes inherited from RooAbsArg
static bool _inhibitDirty
 
static bool _verboseDirty
 cache of the list of proxies. Avoids type casting.
 
- 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 36 of file RooAbsCategory.h.

Constructor & Destructor Documentation

◆ RooAbsCategory() [1/3]

RooAbsCategory::RooAbsCategory ( )

Definition at line 76 of file RooAbsCategory.cxx.

◆ RooAbsCategory() [2/3]

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

Constructor.

Definition at line 82 of file RooAbsCategory.cxx.

◆ RooAbsCategory() [3/3]

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

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

Definition at line 94 of file RooAbsCategory.cxx.

◆ ~RooAbsCategory()

RooAbsCategory::~RooAbsCategory ( )
override

Destructor.

Definition at line 108 of file RooAbsCategory.cxx.

Member Function Documentation

◆ attachToTree()

void RooAbsCategory::attachToTree ( TTree tree,
Int_t  bufSize = 32000 
)
overrideprotectedvirtual

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 445 of file RooAbsCategory.cxx.

◆ attachToVStore()

void RooAbsCategory::attachToVStore ( RooVectorDataStore vstore)
overrideprotectedvirtual

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

Implements RooAbsArg.

Definition at line 432 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 91 of file RooAbsCategory.h.

◆ Class()

static TClass * RooAbsCategory::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooAbsCategory::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t RooAbsCategory::Class_Version ( )
inlinestaticconstexpr

A buffer for reading values from trees.

Returns
Version of this class

Definition at line 226 of file RooAbsCategory.h.

◆ clearTypes()

void RooAbsCategory::clearTypes ( )
protected

Delete all currently defined states.

Definition at line 274 of file RooAbsCategory.cxx.

◆ copyCache()

void RooAbsCategory::copyCache ( const RooAbsArg source,
bool  valueOnly = false,
bool  setValDirty = true 
)
overrideprotectedvirtual

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 553 of file RooAbsCategory.cxx.

◆ createFundamental()

RooFit::OwningPtr< RooAbsArg > RooAbsCategory::createFundamental ( const char *  newname = nullptr) const
overridevirtual

Create a RooCategory fundamental object with our properties.

Implements RooAbsArg.

Definition at line 635 of file RooAbsCategory.cxx.

◆ createTable()

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

Create a table matching the shape of this category.

Definition at line 367 of file RooAbsCategory.cxx.

◆ DeclFileName()

static const char * RooAbsCategory::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 226 of file RooAbsCategory.h.

◆ 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 217 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 242 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 226 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

◆ empty()

bool RooAbsCategory::empty ( ) const
inline

If there are no states defined.

Definition at line 103 of file RooAbsCategory.h.

◆ 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 95 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 RooBinningCategory, RooCategory, RooMappedCategory, RooMultiCategory, RooSuperCategory, and RooThresholdCategory.

◆ fillTreeBranch()

void RooAbsCategory::fillTreeBranch ( TTree t)
overrideprotectedvirtual

Fill tree branches associated with current object with current value.

Implements RooAbsArg.

Definition at line 510 of file RooAbsCategory.cxx.

◆ getCurrentIndex()

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

Return index number of current state.

Reimplemented in RooCategory.

Definition at line 118 of file RooAbsCategory.cxx.

◆ getCurrentLabel()

const char * RooAbsCategory::getCurrentLabel ( ) const
virtual

Return label string of current state.

Reimplemented in RooMultiCategory.

Definition at line 134 of file RooAbsCategory.cxx.

◆ getCurrentOrdinalNumber()

unsigned int RooAbsCategory::getCurrentOrdinalNumber ( ) const

Return ordinal number of the current state.

Definition at line 611 of file RooAbsCategory.cxx.

◆ getIndex()

Int_t RooAbsCategory::getIndex ( ) const
inline

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

Definition at line 133 of file RooAbsCategory.h.

◆ getLabel()

const char * RooAbsCategory::getLabel ( ) const
inline

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

Definition at line 135 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 591 of file RooAbsCategory.cxx.

◆ hasIndex()

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

Check if a state with index index exists.

Definition at line 192 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 60 of file RooAbsCategory.h.

◆ invalidCategory()

decltype(RooAbsCategory::_stateNames) const ::value_type & RooAbsCategory::invalidCategory ( )
staticprotected

A category state to signify an invalid category.

The category name is empty, the index is the minimal int.

Definition at line 70 of file RooAbsCategory.cxx.

◆ IsA()

TClass * RooAbsCategory::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

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

Definition at line 226 of file RooAbsCategory.h.

◆ isCategory()

bool RooAbsCategory::isCategory ( ) const
inlineoverridevirtual

Reimplemented from RooAbsArg.

Definition at line 107 of file RooAbsCategory.h.

◆ isIdentical()

bool RooAbsCategory::isIdentical ( const RooAbsArg other,
bool  assumeSameType = false 
) const
overridevirtual

Implements RooAbsArg.

Definition at line 179 of file RooAbsCategory.cxx.

◆ isIntegrationSafeLValue()

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

Definition at line 83 of file RooAbsCategory.h.

◆ isSignType()

bool RooAbsCategory::isSignType ( bool  mustHaveZero = false) const

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

Definition at line 653 of file RooAbsCategory.cxx.

◆ isValid() [1/2]

bool RooAbsCategory::isValid ( ) const
inlineoverrideprotectedvirtual

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

Reimplemented from RooAbsArg.

Definition at line 192 of file RooAbsCategory.h.

◆ isValid() [2/2]

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

Check if given state is defined for this object.

Definition at line 357 of file RooAbsCategory.cxx.

◆ 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 287 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 205 of file RooAbsCategory.cxx.

◆ lookupType() [1/3]

const RooCatType * RooAbsCategory::lookupType ( const char *  label,
bool  printError = false 
) 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 332 of file RooAbsCategory.cxx.

◆ lookupType() [2/3]

const RooCatType * RooAbsCategory::lookupType ( const RooCatType other,
bool  printError = false 
) 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 300 of file RooAbsCategory.cxx.

◆ lookupType() [3/3]

const RooCatType * RooAbsCategory::lookupType ( RooAbsCategory::value_type  index,
bool  printError = false 
) 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 311 of file RooAbsCategory.cxx.

◆ nextAvailableStateIndex()

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

Definition at line 702 of file RooAbsCategory.cxx.

◆ numTypes()

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

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

Definition at line 129 of file RooAbsCategory.h.

◆ operator!=() [1/3]

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

Definition at line 54 of file RooAbsCategory.h.

◆ operator!=() [2/3]

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

Definition at line 56 of file RooAbsCategory.h.

◆ operator!=() [3/3]

bool RooAbsCategory::operator!= ( value_type  index)
inline

Definition at line 52 of file RooAbsCategory.h.

◆ operator==() [1/3]

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

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

Definition at line 159 of file RooAbsCategory.cxx.

◆ operator==() [2/3]

bool RooAbsCategory::operator== ( const RooAbsArg other) const
overridevirtual

Equality operator with another RooAbsArg.

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

Implements RooAbsArg.

Definition at line 170 of file RooAbsCategory.cxx.

◆ operator==() [3/3]

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

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

Definition at line 149 of file RooAbsCategory.cxx.

◆ printMultiline()

void RooAbsCategory::printMultiline ( std::ostream &  os,
Int_t  contents,
bool  verbose = false,
TString  indent = "" 
) const
overridevirtual

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 RooBinningCategory, RooMappedCategory, RooMultiCategory, RooSuperCategory, and RooThresholdCategory.

Definition at line 410 of file RooAbsCategory.cxx.

◆ printValue()

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

Print value (label name)

Reimplemented from RooPrintable.

Definition at line 397 of file RooAbsCategory.cxx.

◆ readFromStream()

bool RooAbsCategory::readFromStream ( std::istream &  is,
bool  compact,
bool  verbose = false 
)
overridevirtual

Read object contents from stream (dummy for now)

Implements RooAbsArg.

Reimplemented in RooMultiCategory, RooCategory, and RooMappedCategory.

Definition at line 377 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 RooBinningCategory, RooCategory, RooMappedCategory, RooMultiCategory, RooSuperCategory, and RooThresholdCategory.

◆ 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 691 of file RooAbsCategory.cxx.

◆ setCachedValue()

void RooAbsCategory::setCachedValue ( double  value,
bool  notifyClients = true 
)
finalprotectedvirtual

Overwrite the value stored in this object's cache.

This can be used to fake a computation that resulted in value.

Parameters
[in]valueValue to write. The argument is reinterpreted as a category state. If such a state does not exist, this will create undefined behaviour.
[in]notifyClientsIf true, notify users of this object that its value changed. This is the default.

Reimplemented from RooAbsArg.

Definition at line 573 of file RooAbsCategory.cxx.

◆ setTreeBranchStatus()

void RooAbsCategory::setTreeBranchStatus ( TTree t,
bool  active 
)
overrideprotectedvirtual

(De)activate associate tree branch

Implements RooAbsArg.

Definition at line 527 of file RooAbsCategory.cxx.

◆ size()

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

Number of states defined.

Definition at line 99 of file RooAbsCategory.h.

◆ stateNames() [1/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 168 of file RooAbsCategory.h.

◆ stateNames() [2/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 158 of file RooAbsCategory.h.

◆ Streamer()

void RooAbsCategory::Streamer ( TBuffer R__b)
overridevirtual

◆ StreamerNVirtual()

void RooAbsCategory::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 226 of file RooAbsCategory.h.

◆ syncCache()

void RooAbsCategory::syncCache ( const RooArgSet set = nullptr)
overrideprotectedvirtual

Explicitly synchronize RooAbsCategory internal cache.

Implements RooAbsArg.

Definition at line 540 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 671 of file RooAbsCategory.cxx.

◆ writeToStream()

void RooAbsCategory::writeToStream ( std::ostream &  os,
bool  compact 
) const
overridevirtual

Write object contents to ostream.

Implements RooAbsArg.

Reimplemented in RooCategory, RooMappedCategory, RooMultiCategory, and RooThresholdCategory.

Definition at line 387 of file RooAbsCategory.cxx.

Friends And Related Symbol Documentation

◆ RooVectorDataStore

friend class RooVectorDataStore
friend

Definition at line 203 of file RooAbsCategory.h.

Member Data Documentation

◆ _currentIndex

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

Current category state.

Definition at line 216 of file RooAbsCategory.h.

◆ _insertionOrder

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

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

Definition at line 218 of file RooAbsCategory.h.

◆ _legacyStates

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

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

Definition at line 219 of file RooAbsCategory.h.

◆ _stateNames

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

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

Definition at line 217 of file RooAbsCategory.h.

◆ _treeReadBuffer

std::unique_ptr<TreeReadBuffer> RooAbsCategory::_treeReadBuffer
private

Definition at line 224 of file RooAbsCategory.h.

Libraries for RooAbsCategory:

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