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

RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFit.

Values or shapes usually depend on values or shapes of other RooAbsArg instances. Connecting several RooAbsArg in a computation graph models an expression tree that can be evaluated.

Building a computation graph of RooFit objects

Therefore, RooAbsArg provides functionality to connect objects of type RooAbsArg into a computation graph to pass values between those objects. A value can e.g. be a real-valued number, (instances of RooAbsReal), or an integer, that is, catgory index (instances of RooAbsCategory). The third subclass of RooAbsArg is RooStringVar, but it is rarely used.

The "shapes" that a RooAbsArg can possess can e.g. be the definition range of an observable, or how many states a category object has. In computations, values are expected to change often, while shapes remain mostly constant (unless e.g. a new range is set for an observable).

Nodes of a computation graph are connected using instances of RooAbsProxy. If Node B declares a member RooTemplateProxy<TypeOfNodeA>, Node A will be registered as a server of values to Node B, and Node B will know that it is a client of node A. Using functions like dependsOn(), or getObservables() / getParameters(), the relation of A --> B can be queried. Using graphVizTree(), one can create a visualisation of the expression tree.

An instance of RooAbsArg can have named attributes. It also has flags to indicate that either its value or its shape were changed (= it is dirty). RooAbsArg provides functionality to manage client/server relations in a computation graph (clientServerInterface), and helps propagating value/shape changes through the graph. RooAbsArg implements interfaces for inspecting client/server relationships (clientServerInterface) and setting/clearing/querying named attributes.

Caching of values

The values of nodes in the computation graph are cached in RooFit. If a value is used in two nodes of a graph, it doesn't need to be recomputed. If a node acquires a new value, it notifies its consumers ("clients") that their cached values are dirty. See the functions in optimisationInterface for details. A node uses its isValueDirty() and isShapeDirty() functions to decide if a computation is necessary. Caching can be vetoed globally by setting a bit using setDirtyInhibit(). This will make computations slower, but all the nodes of the computation graph will be evaluated irrespective of whether their state is clean or dirty. Using setOperMode(), caching can also be enabled/disabled for single nodes.

Definition at line 72 of file RooAbsArg.h.

Public Types

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

 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=0)
 Copy constructor transfers all boolean and string properties of the original object.
 
virtual ~RooAbsArg ()
 Destructor.
 
Bool_t addOwnedComponents (const RooArgSet &comps)
 Take ownership of the contents of 'comps'.
 
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_t checkObservables (const RooArgSet *nset) const
 Overloadable function in which derived classes can implement consistency checks of the variables.
 
virtual TObjectClone (const char *newname=0) const
 Make a clone of an object using the Streamer facility.
 
virtual TObjectclone (const char *newname=0) const =0
 
virtual RooAbsArgcloneTree (const char *newname=0) const
 Clone tree expression of objects.
 
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.
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Define default contents to print.
 
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.
 
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.
 
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.
 
Bool_t dependsOnValue (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=0) const
 Check whether this object depends on values from an element in the serverList.
 
Bool_t getAttribute (const Text_t *name) const
 Check if a named attribute is set. By default, all attributes are unset.
 
RooLinkedList getCloningAncestors () const
 Return ancestors in cloning chain of this RooAbsArg.
 
RooArgSetgetComponents () const
 Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.
 
RooArgSetgetObservables (const RooAbsData &data) const
 Return the observables of this pdf given the observables defined by data.
 
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).
 
RooArgSetgetObservables (const RooArgSet &set, Bool_t valueOnly=kTRUE) const
 Given a set of possible observables, return the observables that this PDF depends on.
 
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.
 
bool getObservables (const RooArgSet *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.
 
RooArgSetgetParameters (const RooAbsData &data, bool stripDisconnected=true) const
 Return the parameters of this p.d.f when used in conjuction with dataset 'data'.
 
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).
 
RooArgSetgetParameters (const RooArgSet &observables, bool stripDisconnected=true) const
 Return the parameters of the p.d.f given the provided set of observables.
 
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_t getTransientAttribute (const Text_t *name) const
 Check if a named attribute is set.
 
RooArgSetgetVariables (Bool_t stripDisconnected=kTRUE) const
 Return RooArgSet with all variables (tree leaf nodes of expresssion 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_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'.
 
Bool_t isConstant () const
 Check if the "Constant" attribute is set.
 
virtual Bool_t isDerived () const
 Does value or shape of this arg depend on any other arg?
 
virtual bool isIdentical (const RooAbsArg &other, Bool_t assumeSameType=kFALSE) const =0
 
virtual Bool_t IsSortable () const
 
Bool_t localNoDirtyInhibit () const
 
const TNamednamePtr () const
 
Int_t numProxies () const
 Return the number of registered proxies.
 
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.
 
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.
 
RooAbsArgoperator= (const RooAbsArg &other)
 Assign all boolean and string properties of the original object.
 
virtual bool operator== (const RooAbsArg &other) const =0
 
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.
 
const RooArgSetownedComponents () const
 
virtual void Print (Option_t *options=0) const
 Print the object to the defaultPrintStream().
 
virtual void printAddress (std::ostream &os) const
 Print class name of object.
 
virtual void printArgs (std::ostream &os) const
 Print object arguments, ie its proxies.
 
virtual void printClassName (std::ostream &os) const
 Print object class name.
 
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.
 
void printCompactTree (std::ostream &os, const char *indent="", const char *namePat=0, RooAbsArg *client=0)
 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=0, Int_t nLevel=999)
 Print tree structure of expression tree on given ostream, only branch nodes are printed.
 
void printDirty (Bool_t depth=kTRUE) const
 Print information about current value dirty state information.
 
virtual void printMetaArgs (std::ostream &) const
 
virtual void printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
 Implement multi-line detailed printing.
 
virtual void printName (std::ostream &os) const
 Print object name.
 
virtual void printTitle (std::ostream &os) const
 Print object title.
 
virtual void printTree (std::ostream &os, TString indent="") const
 Print object tree structure.
 
virtual Bool_t readFromStream (std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)=0
 
Bool_t recursiveCheckObservables (const RooArgSet *nset) const
 Recursively call checkObservables on all nodes in the expression tree.
 
void setAttribute (const Text_t *name, Bool_t value=kTRUE)
 Set (default) or clear a named boolean attribute of this object.
 
void setLocalNoDirtyInhibit (Bool_t flag) const
 
void SetName (const char *name)
 Set the name of the TNamed.
 
void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
void setProhibitServerRedirect (Bool_t 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_t value=kTRUE)
 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 writeToStream (std::ostream &os, Bool_t compact) const =0
 
Legacy RooFit interface.

This is a collection of functions that remain supported, but more elegant interfaces are usually available.

TIteratorclientIterator () const
 Retrieve a client iterator.
 
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
 
Client-Server Interface

These functions allow RooFit to figure out who is serving values to whom.

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_t isValueServer (const RooAbsArg &arg) const
 Check if this is serving values to arg.
 
Bool_t isValueServer (const char *name) const
 Check if this is serving values to an object with name name.
 
Bool_t isShapeServer (const RooAbsArg &arg) const
 Check if this is serving shape to arg.
 
Bool_t isShapeServer (const char *name) const
 Check if this is serving shape to an object with name name.
 
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.
 
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.
 
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.
 
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.
 
virtual RooAbsArgcreateFundamental (const char *newname=0) const =0
 Create a fundamental-type object that stores our type of value.
 
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.
 
Bool_t redirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t isRecursionStep=kFALSE)
 Replace all direct servers of this object with the new servers in newServerList.
 
Bool_t recursiveRedirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t recurseInNewSet=kTRUE)
 Recursively replace all servers with the new servers in newSet.
 
virtual bool redirectServersHook (const RooAbsCollection &, bool, bool, bool)
 Function that is called at the end of redirectServers().
 
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.
 
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.
 
void replaceServer (RooAbsArg &oldServer, RooAbsArg &newServer, Bool_t valueProp, Bool_t shapeProp)
 Replace 'oldServer' with 'newServer'.
 
void changeServer (RooAbsArg &server, Bool_t valueProp, Bool_t shapeProp)
 Change dirty flag propagation mask for specified server.
 
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.
 
RooAbsArgfindNewServer (const RooAbsCollection &newSet, Bool_t nameChange) const
 Find the new server in the specified set that matches the old server.
 
Optimisation interface

These functions allow RooFit to optimise a computation graph, to keep track of cached values, and to invalidate caches.

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_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.
 
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.
 
virtual void constOptimizeTestStatistic (ConstOpCode opcode, Bool_t doAlsoTrackingOpt=kTRUE)
 Interface function signaling a request to perform constant term optimization.
 
virtual CacheMode canNodeBeCached () const
 
virtual void setCacheAndTrackHints (RooArgSet &)
 
Bool_t isShapeDirty () const
 
Bool_t isValueDirty () const
 
Bool_t isValueDirtyAndClear () const
 
Bool_t 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_t recurseADirty=kTRUE)
 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.
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
 
virtual void Copy (TObject &named) const
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual void ls (Option_t *option="") const
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
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.
 
- 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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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)
 
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.
 
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)
 Operator delete [].
 
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.
 
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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, 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'.
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object.
 

Static Public Member Functions

static void setDirtyInhibit (Bool_t flag)
 Control global dirty inhibit mode.
 
static void verboseDirty (Bool_t flag)
 Activate verbose messaging related to dirty flag propagation.
 
- Static Public Member Functions inherited from TObject
static Long_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 std::ostream & defaultPrintStream (std::ostream *os=0)
 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 attachToStore (RooAbsDataStore &store)
 Attach this argument to the data store such that it reads data from there.
 
virtual void attachToTree (TTree &t, Int_t bufSize=32000)=0
 Overloadable function for derived classes to implement attachment as branch to a TTree.
 
virtual void attachToVStore (RooVectorDataStore &vstore)=0
 
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 copyCache (const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE)=0
 
virtual void fillTreeBranch (TTree &t)=0
 
virtual void getObservablesHook (const RooArgSet *, RooArgSet *) const
 
virtual void getParametersHook (const RooArgSet *, RooArgSet *, Bool_t) 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_t 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 Bool_t isValid () const
 WVE (08/21/01) Probably obsolete now.
 
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.
 
virtual void setTreeBranchStatus (TTree &t, Bool_t active)=0
 
void setValueDirty (const RooAbsArg *source)
 Force element to re-evaluate itself when a value is requested.
 
virtual void syncCache (const RooArgSet *nset=0)=0
 
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 void ioStreamerPass2Finalize ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.
 

Protected Attributes

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 {nullptr}
 Prohibit server redirects – Debugging tool.
 
Bool_t _fast
 
Bool_t _isConstant
 Do not persist. Pointer to global instance of string that matches object named.
 
Bool_t _localNoInhibitDirty
 Cached isConstant status.
 
RooWorkspace_myws
 Prevent 'AlwaysDirty' mode for this node.
 
TNamed_namePtr
 
OperMode _operMode
 Mark batches as dirty (only meaningful for RooAbsReal).
 
RooArgSet_ownedComponents
 
Bool_t _prohibitServerRedirect
 Set of owned component.
 
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
 

Static Protected Attributes

static Bool_t _inhibitDirty
 
static Bool_t _verboseDirty
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

Private Member Functions

void addParameters (RooArgSet &params, const RooArgSet *nset=0, Bool_t stripDisconnected=kTRUE) const
 INTERNAL helper function for getParameters()
 
RefCountListLegacyIterator_tmakeLegacyIterator (const RefCountList_t &list) const
 

Friends

std::ostream & operator<< (std::ostream &os, const RooAbsArg &arg)
 
std::istream & operator>> (std::istream &is, RooAbsArg &arg)
 Istream operator.
 
class RooAbsCollection
 
class RooAbsReal
 
class RooAddModel
 
class RooAddPdf
 
class RooAddPdfOrig
 
class RooArgProxy
 
class RooArgSet
 
class RooCompositeDataStore
 
class RooCustomizer
 
class RooDataSet
 
class RooExtendPdf
 
class RooHistFunc
 
class RooHistFunc2
 
class RooHistPdf
 
class RooListProxy
 
class RooObjectFactory
 
class RooProdPdf
 
class RooProjectedPdf
 
class RooRealIntegral
 
class RooRealMPFE
 
void RooRefArray::Streamer (TBuffer &)
 
class RooSetProxy
 
class RooTreeDataStore
 
class RooVectorDataStore
 
class RooWorkspace
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 

#include <RooAbsArg.h>

Inheritance diagram for RooAbsArg:
[legend]

Member Typedef Documentation

◆ RefCountList_t

◆ RefCountListLegacyIterator_t

Member Enumeration Documentation

◆ CacheMode

Enumerator
Always 
NotAdvised 
Never 

Definition at line 407 of file RooAbsArg.h.

◆ ConstOpCode

Enumerator
Activate 
DeActivate 
ConfigChange 
ValueChange 

Definition at line 406 of file RooAbsArg.h.

◆ OperMode

Enumerator
Auto 
AClean 
ADirty 

Definition at line 408 of file RooAbsArg.h.

Constructor & Destructor Documentation

◆ RooAbsArg() [1/3]

RooAbsArg::RooAbsArg ( )

Default constructor.

Definition at line 126 of file RooAbsArg.cxx.

◆ ~RooAbsArg()

RooAbsArg::~RooAbsArg ( )
virtual

Destructor.

Definition at line 223 of file RooAbsArg.cxx.

◆ RooAbsArg() [2/3]

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

Create an object with the specified name and descriptive title.

The newly created object has no clients or servers and has its dirty flags set.

Definition at line 140 of file RooAbsArg.cxx.

◆ RooAbsArg() [3/3]

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

Copy constructor transfers all boolean and string properties of the original object.

Transient properties and client-server links are not copied

Definition at line 156 of file RooAbsArg.cxx.

Member Function Documentation

◆ addOwnedComponents()

Bool_t RooAbsArg::addOwnedComponents ( const RooArgSet comps)

Take ownership of the contents of 'comps'.

Definition at line 2206 of file RooAbsArg.cxx.

◆ addParameters()

void RooAbsArg::addParameters ( RooArgSet params,
const RooArgSet nset = 0,
Bool_t  stripDisconnected = kTRUE 
) const
private

INTERNAL helper function for getParameters()

Definition at line 588 of file RooAbsArg.cxx.

◆ addServer()

void RooAbsArg::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.

Parameters
serverThe server to be registered.
valuePropIn addition to the basic client-server relationship, declare dependence on the server's value.
valuePropIn addition to the basic client-server relationship, declare dependence on the server's shape.
refCountOptionally add with higher reference count (if multiple components depend on it)

Definition at line 389 of file RooAbsArg.cxx.

◆ addServerList()

void RooAbsArg::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.

Definition at line 425 of file RooAbsArg.cxx.

◆ aggregateCacheUniqueSuffix()

const char * RooAbsArg::aggregateCacheUniqueSuffix ( ) const

Definition at line 2279 of file RooAbsArg.cxx.

◆ attachDataSet()

void RooAbsArg::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.

Definition at line 1551 of file RooAbsArg.cxx.

◆ attachDataStore()

void RooAbsArg::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.

Definition at line 1570 of file RooAbsArg.cxx.

◆ attachToStore()

void RooAbsArg::attachToStore ( RooAbsDataStore store)
protected

Attach this argument to the data store such that it reads data from there.

Definition at line 2254 of file RooAbsArg.cxx.

◆ attachToTree()

void RooAbsArg::attachToTree ( TTree t,
Int_t  bufSize = 32000 
)
protectedpure virtual

Overloadable function for derived classes to implement attachment as branch to a TTree.

Implemented in RooAbsCategory, RooAbsReal, RooRealVar, and RooStringVar.

Definition at line 1351 of file RooAbsArg.cxx.

◆ attachToVStore()

virtual void RooAbsArg::attachToVStore ( RooVectorDataStore vstore)
protectedpure virtual

◆ attributes()

const std::set< std::string > & RooAbsArg::attributes ( ) const
inline

Definition at line 359 of file RooAbsArg.h.

◆ branchNodeServerList()

void RooAbsArg::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.

A branch node is node that has one or more servers declared.

Definition at line 521 of file RooAbsArg.cxx.

◆ cacheUniqueSuffix()

virtual const char * RooAbsArg::cacheUniqueSuffix ( ) const
inlinevirtual

Reimplemented in RooAbsOptTestStatistic.

Definition at line 516 of file RooAbsArg.h.

◆ canNodeBeCached()

virtual CacheMode RooAbsArg::canNodeBeCached ( ) const
inlinevirtual

Reimplemented in RooAddPdf, RooProdPdf, RooProduct, RooRealSumFunc, and RooRealSumPdf.

Definition at line 430 of file RooAbsArg.h.

◆ changeServer()

void RooAbsArg::changeServer ( RooAbsArg server,
Bool_t  valueProp,
Bool_t  shapeProp 
)

Change dirty flag propagation mask for specified server.

Definition at line 476 of file RooAbsArg.cxx.

◆ checkDependents()

Bool_t RooAbsArg::checkDependents ( const RooArgSet nset) const
inline
Deprecated:
Use checkObservables()

Definition at line 171 of file RooAbsArg.h.

◆ checkObservables()

Bool_t RooAbsArg::checkObservables ( const RooArgSet nset) const
virtual

Overloadable function in which derived classes can implement consistency checks of the variables.

If this function returns true, indicating an error, the fitter or generator will abort.

Reimplemented in RooAddModel, RooAddPdf, RooProdPdf, RooRealSumFunc, and RooRealSumPdf.

Definition at line 764 of file RooAbsArg.cxx.

◆ cleanBranchName()

TString RooAbsArg::cleanBranchName ( ) const
protected

Construct a mangled name from the actual name that is free of any math symbols that might be interpreted by TTree.

Definition at line 1927 of file RooAbsArg.cxx.

◆ clearShapeDirty()

void RooAbsArg::clearShapeDirty ( ) const
inlineprotected

Definition at line 584 of file RooAbsArg.h.

◆ clearValueAndShapeDirty()

void RooAbsArg::clearValueAndShapeDirty ( ) const
inlineprotected

Definition at line 576 of file RooAbsArg.h.

◆ clearValueDirty()

void RooAbsArg::clearValueDirty ( ) const
inlineprotected

Definition at line 581 of file RooAbsArg.h.

◆ clientIterator()

TIterator * RooAbsArg::clientIterator ( ) const
inline

Retrieve a client iterator.

Definition at line 125 of file RooAbsArg.h.

◆ clients()

const RefCountList_t & RooAbsArg::clients ( ) const
inline

List of all clients of this object.

Definition at line 185 of file RooAbsArg.h.

◆ Clone()

virtual TObject * RooAbsArg::Clone ( const char *  newname = 0) const
inlinevirtual

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TNamed.

Definition at line 84 of file RooAbsArg.h.

◆ clone()

virtual TObject * RooAbsArg::clone ( const char *  newname = 0) const
pure virtual

Implemented in RooStats::HistFactory::FlexibleInterpVar, RooStats::HistFactory::HistFactorySimultaneous, RooStats::HistFactory::LinInterpVar, ParamHistFunc, PiecewiseInterpolation, RooStats::HistFactory::RooBarlowBeestonLL, Roo2DKeysPdf, RooArgusBG, RooBCPEffDecay, RooBCPGenDecay, RooBDecay, RooBernstein, RooBifurGauss, RooBMixDecay, RooBreitWigner, RooBukinPdf, RooCBShape, RooCFunction1Binding< VO, VI >, RooCFunction1PdfBinding< VO, VI >, RooCFunction2Binding< VO, VI1, VI2 >, RooCFunction2PdfBinding< VO, VI1, VI2 >, RooCFunction3Binding< VO, VI1, VI2, VI3 >, RooCFunction3PdfBinding< VO, VI1, VI2, VI3 >, RooCFunction4Binding< VO, VI1, VI2, VI3, VI4 >, RooCFunction4PdfBinding< VO, VI1, VI2, VI3, VI4 >, RooChebychev, RooChiSquarePdf, RooCrystalBall, RooDecay, RooDstD0BG, RooFunctor1DBinding, RooFunctor1DPdfBinding, RooFunctorBinding, RooFunctorPdfBinding, RooGamma, RooGaussModel, RooGExpModel, RooHistConstraint, RooIntegralMorph, RooJeffreysPrior, RooKeysPdf, RooLandau, RooLognormal, RooMomentMorph, RooMomentMorphFunc, RooMomentMorphFuncND, RooMomentMorphND, RooMultiBinomial, RooNDKeysPdf, RooNonCPEigenDecay, RooNovosibirsk, RooParametricStepFunction, RooParamHistFunc, RooPolynomial, RooStepFunction, RooTFnBinding, RooTFnPdfBinding, RooUnblindCPAsymVar, RooUnblindOffset, RooUnblindPrecision, RooUnblindUniform, RooUniform, RooVoigtian, RooAddition, RooAddModel, RooAddPdf, RooBinningCategory, RooCachedPdf, RooCachedReal, RooChangeTracker, RooChi2Var, RooConstraintSum, RooConstVar, RooConvCoefVar, RooDataWeightedAverage, RooDerivative, RooEfficiency, RooEffProd, RooErrorVar, RooExtendedBinding, RooExtendedTerm, RooExtendPdf, RooFFTConvPdf, RooFirstMoment, RooFormulaVar, RooFracRemainder, RooGenericPdf, RooGenProdProj, RooHistFunc, RooHistPdf, RooLinearVar, RooMappedCategory, RooMoment, RooMultiVarGaussian, RooNLLVar, RooNumCdf, RooNumConvolution, RooNumConvPdf, RooNumRunningInt, RooPolyVar, RooProdPdf, RooProduct, RooProfileLL, RooProjectedPdf, RooPullVar, RooRangeBoolean, RooRealIntegral, RooRealMPFE, RooRealSumFunc, RooRealSumPdf, RooRealVar, RooRecursiveFraction, RooSecondMoment, RooSimultaneous, RooThresholdCategory, RooTruthModel, RooXYChi2Var, RooLegendre, RooNonCentralChiSquare, RooSpHarmonic, RooStats::Heaviside, NuMuToNuE_Oscillation, RooResolutionModel, RooExponential, RooGaussian, RooJohnson, RooPoisson, RooBinSamplingPdf, RooCategory, RooMultiCategory, RooStringVar, RooSuperCategory, RooWrapperPdf, and RooHypatia2.

◆ cloneTree()

RooAbsArg * RooAbsArg::cloneTree ( const char *  newname = 0) const
virtual

Clone tree expression of objects.

All tree nodes will be owned by the head node return by cloneTree()

Definition at line 2220 of file RooAbsArg.cxx.

◆ Compare()

Int_t RooAbsArg::Compare ( const TObject other) const
virtual

Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name.

Reimplemented from TNamed.

Definition at line 1589 of file RooAbsArg.cxx.

◆ constOptimizeTestStatistic()

void RooAbsArg::constOptimizeTestStatistic ( ConstOpCode  opcode,
Bool_t  doAlsoTrackingOpt = kTRUE 
)
virtual

Interface function signaling a request to perform constant term optimization.

This default implementation takes no action other than to forward the calls to all servers

Reimplemented in RooRealMPFE, RooAbsOptTestStatistic, and RooAbsTestStatistic.

Definition at line 1802 of file RooAbsArg.cxx.

◆ copyCache()

virtual void RooAbsArg::copyCache ( const RooAbsArg source,
Bool_t  valueOnly = kFALSE,
Bool_t  setValDirty = kTRUE 
)
protectedpure virtual

◆ createFundamental()

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

Create a fundamental-type object that stores our type of value.

The created object will have a valid value, but not necessarily the same as our value. The caller is responsible for deleting the returned object.

Implemented in RooAbsCategory, RooAbsReal, and RooStringVar.

◆ defaultPrintContents()

Int_t RooAbsArg::defaultPrintContents ( Option_t opt) const
virtual

Define default contents to print.

Reimplemented from RooPrintable.

Reimplemented in RooRealVar.

Definition at line 1433 of file RooAbsArg.cxx.

◆ dependentOverlaps() [1/2]

Bool_t RooAbsArg::dependentOverlaps ( const RooAbsData dset,
const RooAbsArg testArg 
) const
inline
Deprecated:
Use observableOverlaps()

Definition at line 167 of file RooAbsArg.h.

◆ dependentOverlaps() [2/2]

Bool_t RooAbsArg::dependentOverlaps ( const RooArgSet depList,
const RooAbsArg testArg 
) const
inline
Deprecated:
Use observableOverlaps()

Definition at line 169 of file RooAbsArg.h.

◆ dependsOn() [1/2]

Bool_t RooAbsArg::dependsOn ( const RooAbsArg testArg,
const RooAbsArg ignoreArg = 0,
Bool_t  valueOnly = kFALSE 
) const

Test whether we depend on (ie, are served by) the specified object.

Note that RooAbsArg objects are considered equivalent if they have the same name.

Definition at line 818 of file RooAbsArg.cxx.

◆ dependsOn() [2/2]

Bool_t RooAbsArg::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.

Uses the dependsOn(RooAbsArg&) member function.

Definition at line 799 of file RooAbsArg.cxx.

◆ dependsOnValue() [1/2]

Bool_t RooAbsArg::dependsOnValue ( const RooAbsArg server,
const RooAbsArg ignoreArg = 0 
) const
inline

Check whether this object depends on values served from the object passed as server.

Parameters
serverTest if server serves values to this.
ignoreArgIgnore values served by this object.
Returns
True if values are served.

Definition at line 110 of file RooAbsArg.h.

◆ dependsOnValue() [2/2]

Bool_t RooAbsArg::dependsOnValue ( const RooAbsCollection serverList,
const RooAbsArg ignoreArg = 0 
) const
inline

Check whether this object depends on values from an element in the serverList.

Parameters
serverListTest if one of the elements in this list serves values to this.
ignoreArgIgnore values served by this object.
Returns
True if values are served.

Definition at line 102 of file RooAbsArg.h.

◆ expensiveObjectCache()

RooExpensiveObjectCache & RooAbsArg::expensiveObjectCache ( ) const

Definition at line 2267 of file RooAbsArg.cxx.

◆ fillTreeBranch()

virtual void RooAbsArg::fillTreeBranch ( TTree t)
protectedpure virtual

◆ findConstantNodes() [1/2]

Bool_t RooAbsArg::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.

Definition at line 1709 of file RooAbsArg.cxx.

◆ findConstantNodes() [2/2]

Bool_t RooAbsArg::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.

Definition at line 1727 of file RooAbsArg.cxx.

◆ findNewServer()

RooAbsArg * RooAbsArg::findNewServer ( const RooAbsCollection newSet,
Bool_t  nameChange 
) const

Find the new server in the specified set that matches the old server.

Allow a name change if nameChange is kTRUE, in which case the new server is selected by searching for a new server with an attribute of "ORIGNAME:<oldName>". Return zero if there is not a unique match.

Definition at line 1112 of file RooAbsArg.cxx.

◆ findServer() [1/3]

RooAbsArg * RooAbsArg::findServer ( const char *  name) const
inline

Return server of this with name name. Returns nullptr if not found.

Definition at line 203 of file RooAbsArg.h.

◆ findServer() [2/3]

RooAbsArg * RooAbsArg::findServer ( const RooAbsArg arg) const
inline

Return server of this that has the same name as arg. Returns nullptr if not found.

Definition at line 208 of file RooAbsArg.h.

◆ findServer() [3/3]

RooAbsArg * RooAbsArg::findServer ( Int_t  index) const
inline

Return i-th server from server list.

Definition at line 213 of file RooAbsArg.h.

◆ getAttribute()

Bool_t RooAbsArg::getAttribute ( const Text_t name) const

Check if a named attribute is set. By default, all attributes are unset.

Definition at line 315 of file RooAbsArg.cxx.

◆ getCache()

RooAbsCache * RooAbsArg::getCache ( Int_t  index) const

Return registered cache object by index.

Definition at line 1997 of file RooAbsArg.cxx.

◆ getCloningAncestors()

RooLinkedList RooAbsArg::getCloningAncestors ( ) const

Return ancestors in cloning chain of this RooAbsArg.

NOTE: Returned pointers are not guaranteed to be 'live', so do not dereference without proper caution

Definition at line 2016 of file RooAbsArg.cxx.

◆ getComponents()

RooArgSet * RooAbsArg::getComponents ( ) const

Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.

Definition at line 746 of file RooAbsArg.cxx.

◆ getDependents() [1/3]

RooArgSet * RooAbsArg::getDependents ( const RooAbsData set) const
inline
Deprecated:
Use getObservables()

Definition at line 163 of file RooAbsArg.h.

◆ getDependents() [2/3]

RooArgSet * RooAbsArg::getDependents ( const RooArgSet set) const
inline
Deprecated:
Use getObservables()

Definition at line 161 of file RooAbsArg.h.

◆ getDependents() [3/3]

RooArgSet * RooAbsArg::getDependents ( const RooArgSet depList) const
inline
Deprecated:
Use getObservables()

Definition at line 165 of file RooAbsArg.h.

◆ getObservables() [1/5]

RooArgSet * RooAbsArg::getObservables ( const RooAbsData data) const
inline

Return the observables of this pdf given the observables defined by data.

Definition at line 318 of file RooAbsArg.h.

◆ getObservables() [2/5]

RooArgSet * RooAbsArg::getObservables ( const RooAbsData set) 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).

The caller of this function is responsible for deleting the returned argset. The complement of this function is getParameters().

Definition at line 680 of file RooAbsArg.cxx.

◆ getObservables() [3/5]

RooArgSet * RooAbsArg::getObservables ( const RooArgSet set,
Bool_t  valueOnly = kTRUE 
) const
inline

Given a set of possible observables, return the observables that this PDF depends on.

Definition at line 313 of file RooAbsArg.h.

◆ getObservables() [4/5]

RooArgSet * RooAbsArg::getObservables ( const RooArgSet dataList,
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.

The caller of this function is responsible for deleting the returned argset. The complement of this function is getParameters().

Definition at line 695 of file RooAbsArg.cxx.

◆ getObservables() [5/5]

bool RooAbsArg::getObservables ( const RooArgSet dataList,
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.

Returns true only if something went wrong. The complement of this function is getParameters().

Parameters
[in]dataListSet of leaf nodes to match.
[out]outputSetOutput set.
[in]valueOnlyIf this parameter is true, we only match leafs that depend on the value of any arg in dataList.

Definition at line 714 of file RooAbsArg.cxx.

◆ getObservablesHook()

virtual void RooAbsArg::getObservablesHook ( const RooArgSet ,
RooArgSet  
) const
inlineprotectedvirtual

Definition at line 574 of file RooAbsArg.h.

◆ getParameters() [1/5]

RooArgSet * RooAbsArg::getParameters ( const RooAbsData data,
bool  stripDisconnected = true 
) const
inline

Return the parameters of this p.d.f when used in conjuction with dataset 'data'.

Definition at line 303 of file RooAbsArg.h.

◆ getParameters() [2/5]

RooArgSet * RooAbsArg::getParameters ( const RooAbsData set,
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).

The caller of this function is responsible for deleting the returned argset. The complement of this function is getObservables()

Definition at line 579 of file RooAbsArg.cxx.

◆ getParameters() [3/5]

RooArgSet * RooAbsArg::getParameters ( const RooArgSet observables,
bool  stripDisconnected = true 
) const
inline

Return the parameters of the p.d.f given the provided set of observables.

Definition at line 307 of file RooAbsArg.h.

◆ getParameters() [4/5]

RooArgSet * RooAbsArg::getParameters ( 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.

The caller of this function is responsible for deleting the returned argset. The complement of this function is getObservables().

Definition at line 626 of file RooAbsArg.cxx.

◆ getParameters() [5/5]

bool RooAbsArg::getParameters ( const RooArgSet observables,
RooArgSet outputSet,
bool  stripDisconnected = true 
) const
virtual

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.

Returns true only if something went wrong. The complement of this function is getObservables().

Parameters
[in]observablesSet of leafs to ignore because they are observables and not parameters.
[out]outputSetOutput set.
[in]stripDisconnectedAllow pdf to strip parameters from list before adding it.

Reimplemented in RooStats::HistFactory::RooBarlowBeestonLL.

Definition at line 642 of file RooAbsArg.cxx.

◆ getParametersHook()

virtual void RooAbsArg::getParametersHook ( const RooArgSet ,
RooArgSet ,
Bool_t   
) const
inlineprotectedvirtual

Reimplemented in RooProdPdf.

Definition at line 573 of file RooAbsArg.h.

◆ getProxy()

RooAbsProxy * RooAbsArg::getProxy ( Int_t  index) const

Return the nth proxy from the proxy list.

Definition at line 1312 of file RooAbsArg.cxx.

◆ getStringAttribute()

const Text_t * RooAbsArg::getStringAttribute ( const Text_t key) const

Get string attribute mapped under key 'key'.

Returns null pointer if no attribute exists under that key

Definition at line 337 of file RooAbsArg.cxx.

◆ getTransientAttribute()

Bool_t RooAbsArg::getTransientAttribute ( const Text_t name) const

Check if a named attribute is set.

By default, all attributes are unset.

Definition at line 373 of file RooAbsArg.cxx.

◆ getVariables()

RooArgSet * RooAbsArg::getVariables ( Bool_t  stripDisconnected = kTRUE) const

Return RooArgSet with all variables (tree leaf nodes of expresssion tree)

Definition at line 2006 of file RooAbsArg.cxx.

◆ graphVizAddConnections()

void RooAbsArg::graphVizAddConnections ( std::set< std::pair< RooAbsArg *, RooAbsArg * > > &  )
protected

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.

Definition at line 2116 of file RooAbsArg.cxx.

◆ graphVizTree() [1/2]

void RooAbsArg::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.

Use the GraphViz tool suite to make e.g. a gif or ps file from the .dot file

Based on concept developed by Kyle Cranmer

Definition at line 2043 of file RooAbsArg.cxx.

◆ graphVizTree() [2/2]

void RooAbsArg::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.

Based on concept developed by Kyle Cranmer

Definition at line 2059 of file RooAbsArg.cxx.

◆ hasClients()

Bool_t RooAbsArg::hasClients ( ) const
inline

Definition at line 116 of file RooAbsArg.h.

◆ hasRange()

virtual Bool_t RooAbsArg::hasRange ( const char *  ) const
inlinevirtual

Reimplemented in RooAbsRealLValue, RooCategory, and RooSuperCategory.

Definition at line 400 of file RooAbsArg.h.

◆ importWorkspaceHook()

virtual Bool_t RooAbsArg::importWorkspaceHook ( RooWorkspace ws)
inlinevirtual

Reimplemented in RooHistFunc, and RooHistPdf.

Definition at line 557 of file RooAbsArg.h.

◆ inhibitDirty()

Bool_t RooAbsArg::inhibitDirty ( ) const
protected

Delete watch flag.

Definition at line 117 of file RooAbsArg.cxx.

◆ inRange()

virtual Bool_t RooAbsArg::inRange ( const char *  ) const
inlinevirtual

Reimplemented in RooAbsRealLValue, RooCategory, and RooSuperCategory.

Definition at line 396 of file RooAbsArg.h.

◆ ioStreamerPass2()

void RooAbsArg::ioStreamerPass2 ( )
protectedvirtual

Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.

A second pass is typically needed when evolving data member of RooAbsArg-derived classes that are container classes with references to other members, which may not yet be 'live' in the first ioStreamer() evolution pass.

Classes may overload this function, but must call the base method in the overloaded call to ensure base evolution is handled properly

Reimplemented in RooHistFunc.

Definition at line 2370 of file RooAbsArg.cxx.

◆ ioStreamerPass2Finalize()

void RooAbsArg::ioStreamerPass2Finalize ( )
staticprotected

Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.

This static finalize method is called after ioStreamerPass2() is called on each directly listed object in the workspace. It's purpose is to complete schema evolution of any objects in the workspace that are not directly listed as content elements (e.g. analytical convolution tokens )

Definition at line 2398 of file RooAbsArg.cxx.

◆ isCloneOf()

Bool_t RooAbsArg::isCloneOf ( const RooAbsArg other) const

Check if this object was created as a clone of 'other'.

Definition at line 282 of file RooAbsArg.cxx.

◆ isConstant()

Bool_t RooAbsArg::isConstant ( ) const
inline

Check if the "Constant" attribute is set.

Definition at line 380 of file RooAbsArg.h.

◆ isDerived()

virtual Bool_t RooAbsArg::isDerived ( ) const
inlinevirtual

Does value or shape of this arg depend on any other arg?

Reimplemented in RooAbsOptTestStatistic, RooConstVar, RooRealVar, and RooCategory.

Definition at line 92 of file RooAbsArg.h.

◆ isFundamental()

virtual Bool_t RooAbsArg::isFundamental ( ) const
inlinevirtual

Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return kTRUE.

Note that this test is subtlely different from the dynamic isDerived() test, e.g. a constant is not derived but is also not fundamental.

Reimplemented in RooErrorVar, RooRealVar, RooCategory, and RooStringVar.

Definition at line 243 of file RooAbsArg.h.

◆ isIdentical()

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

Implemented in RooAbsCategory, RooAbsReal, and RooStringVar.

◆ isLValue()

virtual Bool_t RooAbsArg::isLValue ( ) const
inlinevirtual

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.

Reimplemented in RooAbsCategoryLValue, and RooAbsRealLValue.

Definition at line 255 of file RooAbsArg.h.

◆ isShapeDirty()

Bool_t RooAbsArg::isShapeDirty ( ) const
inline

Definition at line 434 of file RooAbsArg.h.

◆ isShapeServer() [1/2]

Bool_t RooAbsArg::isShapeServer ( const char *  name) const
inline

Check if this is serving shape to an object with name name.

Definition at line 229 of file RooAbsArg.h.

◆ isShapeServer() [2/2]

Bool_t RooAbsArg::isShapeServer ( const RooAbsArg arg) const
inline

Check if this is serving shape to arg.

Definition at line 225 of file RooAbsArg.h.

◆ IsSortable()

virtual Bool_t RooAbsArg::IsSortable ( ) const
inlinevirtual

Reimplemented from TNamed.

Definition at line 387 of file RooAbsArg.h.

◆ isValid()

Bool_t RooAbsArg::isValid ( ) const
protectedvirtual

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

Reimplemented in RooAbsCategory, RooAbsReal, RooRealIntegral, and RooStringVar.

Definition at line 1362 of file RooAbsArg.cxx.

◆ isValueDirty()

Bool_t RooAbsArg::isValueDirty ( ) const
inline

Definition at line 439 of file RooAbsArg.h.

◆ isValueDirtyAndClear()

Bool_t RooAbsArg::isValueDirtyAndClear ( ) const
inline

Definition at line 454 of file RooAbsArg.h.

◆ isValueOrShapeDirtyAndClear()

Bool_t RooAbsArg::isValueOrShapeDirtyAndClear ( ) const
inline

Definition at line 473 of file RooAbsArg.h.

◆ isValueServer() [1/2]

Bool_t RooAbsArg::isValueServer ( const char *  name) const
inline

Check if this is serving values to an object with name name.

Definition at line 221 of file RooAbsArg.h.

◆ isValueServer() [2/2]

Bool_t RooAbsArg::isValueServer ( const RooAbsArg arg) const
inline

Check if this is serving values to arg.

Definition at line 217 of file RooAbsArg.h.

◆ leafNodeServerList()

void RooAbsArg::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.

A leaf node is node that has no servers declared.

Definition at line 510 of file RooAbsArg.cxx.

◆ localNoDirtyInhibit()

Bool_t RooAbsArg::localNoDirtyInhibit ( ) const
inline

Definition at line 679 of file RooAbsArg.h.

◆ makeLegacyIterator()

RooAbsArg::RefCountListLegacyIterator_t * RooAbsArg::makeLegacyIterator ( const RefCountList_t list) const
private

Definition at line 2416 of file RooAbsArg.cxx.

◆ namePtr()

const TNamed * RooAbsArg::namePtr ( ) const
inline

Definition at line 550 of file RooAbsArg.h.

◆ numCaches()

Int_t RooAbsArg::numCaches ( ) const

Return number of registered caches.

Definition at line 1988 of file RooAbsArg.cxx.

◆ numProxies()

Int_t RooAbsArg::numProxies ( ) const

Return the number of registered proxies.

Definition at line 1325 of file RooAbsArg.cxx.

◆ observableOverlaps() [1/2]

Bool_t RooAbsArg::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.

Definition at line 868 of file RooAbsArg.cxx.

◆ observableOverlaps() [2/2]

Bool_t RooAbsArg::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.

Definition at line 878 of file RooAbsArg.cxx.

◆ operator=()

RooAbsArg & RooAbsArg::operator= ( const RooAbsArg other)

Assign all boolean and string properties of the original object.

Transient properties and client-server links are not assigned.

Definition at line 191 of file RooAbsArg.cxx.

◆ operator==()

virtual bool RooAbsArg::operator== ( const RooAbsArg other) const
pure virtual

Implemented in RooAbsCategory, RooAbsReal, and RooStringVar.

◆ operMode()

OperMode RooAbsArg::operMode ( ) const
inline

Query the operation mode of this node.

Definition at line 502 of file RooAbsArg.h.

◆ operModeHook()

virtual void RooAbsArg::operModeHook ( )
inlineprotectedvirtual

Reimplemented in RooCachedReal, RooGenProdProj, and RooRealIntegral.

Definition at line 567 of file RooAbsArg.h.

◆ optimizeCacheMode() [1/2]

void RooAbsArg::optimizeCacheMode ( const RooArgSet observables)
virtual

Activate cache mode optimization with given definition of observables.

The cache operation mode of all objects in the expression tree will modified such that all nodes that depend directly or indirectly on any of the listed observables will be set to ADirty, as they are expected to change every time. This save change tracking overhead for nodes that are a priori known to change every time

Definition at line 1633 of file RooAbsArg.cxx.

◆ optimizeCacheMode() [2/2]

void RooAbsArg::optimizeCacheMode ( const RooArgSet observables,
RooArgSet optimizedNodes,
RooLinkedList processedNodes 
)
virtual

Activate cache mode optimization with given definition of observables.

The cache operation mode of all objects in the expression tree will modified such that all nodes that depend directly or indirectly on any of the listed observables will be set to ADirty, as they are expected to change every time. This save change tracking overhead for nodes that are a priori known to change every time

Definition at line 1652 of file RooAbsArg.cxx.

◆ optimizeDirtyHook()

virtual void RooAbsArg::optimizeDirtyHook ( const RooArgSet )
inlineprotectedvirtual

Definition at line 569 of file RooAbsArg.h.

◆ overlaps()

Bool_t RooAbsArg::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.

Definition at line 854 of file RooAbsArg.cxx.

◆ ownedComponents()

const RooArgSet * RooAbsArg::ownedComponents ( ) const
inline

Definition at line 540 of file RooAbsArg.h.

◆ Print()

virtual void RooAbsArg::Print ( Option_t options = 0) const
inlinevirtual

Print the object to the defaultPrintStream().

Parameters
[in]optionsV print verbose. T print a tree structure with all children.

Reimplemented from TNamed.

Definition at line 340 of file RooAbsArg.h.

◆ printAddress()

void RooAbsArg::printAddress ( std::ostream &  os) const
virtual

Print class name of object.

Reimplemented from RooPrintable.

Definition at line 1399 of file RooAbsArg.cxx.

◆ printArgs()

◆ printAttribList()

void RooAbsArg::printAttribList ( std::ostream &  os) const
protected

Transient boolean attributes (not copied in ctor)

Print the attribute list.

Definition at line 1535 of file RooAbsArg.cxx.

◆ printClassName()

void RooAbsArg::printClassName ( std::ostream &  os) const
virtual

Print object class name.

Reimplemented from RooPrintable.

Definition at line 1393 of file RooAbsArg.cxx.

◆ printCompactTree() [1/2]

void RooAbsArg::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.

If namePat is not "*", only nodes with names matching the pattern will be printed. The client argument is used in recursive calls to properly display the value or shape nature of the client-server links. It should be zero in calls initiated by users.

Definition at line 1842 of file RooAbsArg.cxx.

◆ printCompactTree() [2/2]

void RooAbsArg::printCompactTree ( std::ostream &  os,
const char *  indent = "",
const char *  namePat = 0,
RooAbsArg client = 0 
)

Print tree structure of expression tree on given ostream.

If namePat is not "*", only nodes with names matching the pattern will be printed. The client argument is used in recursive calls to properly display the value or shape nature of the client-server links. It should be zero in calls initiated by users.

Definition at line 1859 of file RooAbsArg.cxx.

◆ printCompactTreeHook()

void RooAbsArg::printCompactTreeHook ( std::ostream &  os,
const char *  ind = "" 
)
virtual

Hook function interface for object to insert additional information when printed in the context of a tree structure.

This default implementation prints nothing

Reimplemented in RooAbsOptTestStatistic, RooAbsTestStatistic, and RooNumConvolution.

Definition at line 1956 of file RooAbsArg.cxx.

◆ printComponentTree()

void RooAbsArg::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.

Lead nodes (variables) will not be shown

If namePat is not "*", only nodes with names matching the pattern will be printed.

Definition at line 1902 of file RooAbsArg.cxx.

◆ printDirty()

void RooAbsArg::printDirty ( Bool_t  depth = kTRUE) const

Print information about current value dirty state information.

If depth flag is true, information is recursively printed for all nodes in this arg tree.

Definition at line 1601 of file RooAbsArg.cxx.

◆ printMetaArgs()

virtual void RooAbsArg::printMetaArgs ( std::ostream &  ) const
inlinevirtual

◆ printMultiline()

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

◆ printName()

void RooAbsArg::printName ( std::ostream &  os) const
virtual

Print object name.

Reimplemented from RooPrintable.

Definition at line 1373 of file RooAbsArg.cxx.

◆ printTitle()

void RooAbsArg::printTitle ( std::ostream &  os) const
virtual

Print object title.

Reimplemented from RooPrintable.

Definition at line 1383 of file RooAbsArg.cxx.

◆ printTree()

void RooAbsArg::printTree ( std::ostream &  os,
TString  indent = "" 
) const
virtual

Print object tree structure.

Reimplemented from RooPrintable.

Definition at line 1508 of file RooAbsArg.cxx.

◆ readFromStream()

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

◆ recursiveCheckDependents()

Bool_t RooAbsArg::recursiveCheckDependents ( const RooArgSet nset) const
inline
Deprecated:
Use recursiveCheckObservables()

Definition at line 173 of file RooAbsArg.h.

◆ recursiveCheckObservables()

Bool_t RooAbsArg::recursiveCheckObservables ( const RooArgSet nset) const

Recursively call checkObservables on all nodes in the expression tree.

Definition at line 773 of file RooAbsArg.cxx.

◆ recursiveRedirectServers()

Bool_t RooAbsArg::recursiveRedirectServers ( const RooAbsCollection newSet,
Bool_t  mustReplaceAll = kFALSE,
Bool_t  nameChange = kFALSE,
Bool_t  recurseInNewSet = kTRUE 
)

Recursively replace all servers with the new servers in newSet.

This substitutes objects that we receive values from (also indirectly through other objects) with new objects that have the same name.

Copied from redirectServers:

This substitutes objects that we receive values from with new objects that have the same name.

See also
recursiveRedirectServers() Use recursive version if servers that are only indirectly serving this object should be replaced as well.
redirectServers() If only the direct servers of an object need to be replaced.

Note that changing the types of objects is generally allowed, but can be wrong if the interface of an object changes. For example, one can reparametrise a model by substituting a variable with a function:

\[ f(x\, |\, a) = a \cdot x \rightarrow f(x\, |\, b) = (2.1 \cdot b) \cdot x \]

If an object, however, expects a PDF, and this is substituted with a function that isn't normalised, wrong results might be obtained or it might even crash the program. The types of the objects being substituted are not checked.

Parameters
[in]newSetOrigSet of new servers that should be used instead of the current servers.
[in]mustReplaceAllA warning is printed and error status is returned if not all servers could be substituted successfully.
[in]nameChangeIf false, an object named "x" is replaced with an object named "x" in newSetOrig. If the object in newSet is called differently, set nameChange to true and use setStringAttribute on the x object:
objectToReplaceX.setStringAttribute("ORIGNAME", "x")
[in]isRecursionStepInternal switch used when called from recursiveRedirectServers().

Definition at line 1157 of file RooAbsArg.cxx.

◆ redirectServers()

Bool_t RooAbsArg::redirectServers ( const RooAbsCollection newSetOrig,
Bool_t  mustReplaceAll = kFALSE,
Bool_t  nameChange = kFALSE,
Bool_t  isRecursionStep = kFALSE 
)

Replace all direct servers of this object with the new servers in newServerList.

This substitutes objects that we receive values from with new objects that have the same name.

See also
recursiveRedirectServers() Use recursive version if servers that are only indirectly serving this object should be replaced as well.
redirectServers() If only the direct servers of an object need to be replaced.

Note that changing the types of objects is generally allowed, but can be wrong if the interface of an object changes. For example, one can reparametrise a model by substituting a variable with a function:

\[ f(x\, |\, a) = a \cdot x \rightarrow f(x\, |\, b) = (2.1 \cdot b) \cdot x \]

If an object, however, expects a PDF, and this is substituted with a function that isn't normalised, wrong results might be obtained or it might even crash the program. The types of the objects being substituted are not checked.

Parameters
[in]newSetOrigSet of new servers that should be used instead of the current servers.
[in]mustReplaceAllA warning is printed and error status is returned if not all servers could be substituted successfully.
[in]nameChangeIf false, an object named "x" is replaced with an object named "x" in newSetOrig. If the object in newSet is called differently, set nameChange to true and use setStringAttribute on the x object:
objectToReplaceX.setStringAttribute("ORIGNAME", "x")
[in]isRecursionStepInternal switch used when called from recursiveRedirectServers().

Definition at line 994 of file RooAbsArg.cxx.

◆ redirectServersHook()

virtual bool RooAbsArg::redirectServersHook ( const RooAbsCollection ,
bool  ,
bool  ,
bool   
)
inlinevirtual

Function that is called at the end of redirectServers().

Can be overloaded to inject some class-dependent behavior after server redirection, e.g. resetting of caches. The return value is meant to be an error flag, so in case something goes wrong the function should return true.

See also
redirectServers() For a detailed explanation of the function parameters.
Parameters
[in]newServerListOne of the original parameters passed to redirectServers().
[in]mustReplaceAllOne of the original parameters passed to redirectServers().
[in]nameChangeOne of the original parameters passed to redirectServers().
[in]isRecursiveStepOne of the original parameters passed to redirectServers().

Reimplemented in RooAddPdf, RooStats::HistFactory::RooBarlowBeestonLL, RooAbsPdf, RooDerivative, RooProdPdf, RooProfileLL, RooAbsOptTestStatistic, RooAbsTestStatistic, RooFFTConvPdf, RooFormulaVar, RooGenericPdf, RooNumConvolution, RooRealIntegral, RooResolutionModel, and RooProjectedPdf.

Definition at line 275 of file RooAbsArg.h.

◆ registerCache()

void RooAbsArg::registerCache ( RooAbsCache cache)

Register RooAbsCache with this object.

This function is called by RooAbsCache constructors for objects that are a datamember of this RooAbsArg. By registering itself the RooAbsArg is aware of all its cache data members and will forward server change and cache mode change calls to the cache objects, which in turn can forward them their contents

Definition at line 1969 of file RooAbsArg.cxx.

◆ registerProxy() [1/3]

void RooAbsArg::registerProxy ( RooArgProxy proxy)
protected

Register an RooArgProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg wil forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur. The proxied argument is also added as value and/or shape server

Definition at line 1203 of file RooAbsArg.cxx.

◆ registerProxy() [2/3]

void RooAbsArg::registerProxy ( RooListProxy proxy)
protected

Register an RooListProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg wil forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur.

Definition at line 1278 of file RooAbsArg.cxx.

◆ registerProxy() [3/3]

void RooAbsArg::registerProxy ( RooSetProxy proxy)
protected

Register an RooSetProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg wil forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur.

Definition at line 1245 of file RooAbsArg.cxx.

◆ removeServer()

void RooAbsArg::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.

Definition at line 440 of file RooAbsArg.cxx.

◆ replaceServer()

void RooAbsArg::replaceServer ( RooAbsArg oldServer,
RooAbsArg newServer,
Bool_t  valueProp,
Bool_t  shapeProp 
)

Replace 'oldServer' with 'newServer'.

Definition at line 465 of file RooAbsArg.cxx.

◆ serverIterator()

TIterator * RooAbsArg::serverIterator ( ) const
inline

Definition at line 140 of file RooAbsArg.h.

◆ serverMIterator()

RooFIter RooAbsArg::serverMIterator ( ) const
inline

Definition at line 154 of file RooAbsArg.h.

◆ serverNameChangeHook()

virtual void RooAbsArg::serverNameChangeHook ( const RooAbsArg ,
const RooAbsArg  
)
inlinevirtual

Definition at line 282 of file RooAbsArg.h.

◆ servers()

const RefCountList_t & RooAbsArg::servers ( ) const
inline

List of all servers of this object.

Definition at line 199 of file RooAbsArg.h.

◆ setAttribute()

void RooAbsArg::setAttribute ( const Text_t name,
Bool_t  value = kTRUE 
)

Set (default) or clear a named boolean attribute of this object.

Definition at line 292 of file RooAbsArg.cxx.

◆ setCacheAndTrackHints()

virtual void RooAbsArg::setCacheAndTrackHints ( RooArgSet )
inlinevirtual

Reimplemented in RooAbsAnaConvPdf, RooAddPdf, RooProdPdf, RooProduct, RooRealSumFunc, and RooRealSumPdf.

Definition at line 431 of file RooAbsArg.h.

◆ setDirtyInhibit()

void RooAbsArg::setDirtyInhibit ( Bool_t  flag)
static

Control global dirty inhibit mode.

When set to true no value or shape dirty flags are propagated and cache is always considered to be dirty.

Definition at line 265 of file RooAbsArg.cxx.

◆ setExpensiveObjectCache()

virtual void RooAbsArg::setExpensiveObjectCache ( RooExpensiveObjectCache cache)
inlinevirtual

Reimplemented in RooRealVar.

Definition at line 521 of file RooAbsArg.h.

◆ setLocalNoDirtyInhibit()

void RooAbsArg::setLocalNoDirtyInhibit ( Bool_t  flag) const
inline

Definition at line 678 of file RooAbsArg.h.

◆ SetName()

void RooAbsArg::SetName ( const char *  name)
virtual

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 2315 of file RooAbsArg.cxx.

◆ SetNameTitle()

void RooAbsArg::SetNameTitle ( const char *  name,
const char *  title 
)
virtual

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 2331 of file RooAbsArg.cxx.

◆ setOperMode()

void RooAbsArg::setOperMode ( OperMode  mode,
Bool_t  recurseADirty = kTRUE 
)

Set the operation mode of this node.

Change cache operation mode to given mode.

If recurseAdirty is true, then a mode change to AlwaysDirty will automatically be propagated recursively to all client nodes

Definition at line 1815 of file RooAbsArg.cxx.

◆ setProhibitServerRedirect()

void RooAbsArg::setProhibitServerRedirect ( Bool_t  flag)
inline

Definition at line 542 of file RooAbsArg.h.

◆ setProxyNormSet()

void RooAbsArg::setProxyNormSet ( const RooArgSet nset)
protected

Forward a change in the cached normalization argset to all the registered proxies.

Definition at line 1336 of file RooAbsArg.cxx.

◆ setShapeDirty() [1/2]

void RooAbsArg::setShapeDirty ( )
inline

Notify that a shape-like property (e.g. binning) has changed.

Definition at line 513 of file RooAbsArg.h.

◆ setShapeDirty() [2/2]

void RooAbsArg::setShapeDirty ( const RooAbsArg source)
protected

Notify that a shape-like property (e.g. binning) has changed.

Mark this object as having changed its shape, and propagate this status change to all of our clients.

Definition at line 937 of file RooAbsArg.cxx.

◆ setStringAttribute()

void RooAbsArg::setStringAttribute ( const Text_t key,
const Text_t value 
)

Associate string 'value' to this object under key 'key'.

Definition at line 324 of file RooAbsArg.cxx.

◆ setTransientAttribute()

void RooAbsArg::setTransientAttribute ( const Text_t name,
Bool_t  value = kTRUE 
)

Set (default) or clear a named boolean attribute of this object.

Definition at line 351 of file RooAbsArg.cxx.

◆ setTreeBranchStatus()

virtual void RooAbsArg::setTreeBranchStatus ( TTree t,
Bool_t  active 
)
protectedpure virtual

Implemented in RooAbsCategory, RooAbsReal, and RooStringVar.

◆ setValueDirty() [1/2]

void RooAbsArg::setValueDirty ( )
inline

Mark the element dirty. This forces a re-evaluation when a value is requested.

Definition at line 508 of file RooAbsArg.h.

◆ setValueDirty() [2/2]

void RooAbsArg::setValueDirty ( const RooAbsArg source)
protected

Force element to re-evaluate itself when a value is requested.

Mark this object as having changed its value, and propagate this status change to all of our clients.

If the object is not in automatic dirty state propagation mode, this call has no effect.

Definition at line 893 of file RooAbsArg.cxx.

◆ setWorkspace()

void RooAbsArg::setWorkspace ( RooWorkspace ws)
inline

Definition at line 544 of file RooAbsArg.h.

◆ shapeClientIterator()

TIterator * RooAbsArg::shapeClientIterator ( ) const
inline

Definition at line 135 of file RooAbsArg.h.

◆ shapeClientMIterator()

RooFIter RooAbsArg::shapeClientMIterator ( ) const
inline

Definition at line 150 of file RooAbsArg.h.

◆ shapeClients()

const RefCountList_t & RooAbsArg::shapeClients ( ) const
inline

List of all shape clients of this object.

Shape clients receive property information such as changes of a value range.

Definition at line 194 of file RooAbsArg.h.

◆ stringAttributes()

const std::map< std::string, std::string > & RooAbsArg::stringAttributes ( ) const
inline

Definition at line 366 of file RooAbsArg.h.

◆ syncCache()

virtual void RooAbsArg::syncCache ( const RooArgSet nset = 0)
protectedpure virtual

◆ transientAttributes()

const std::set< std::string > & RooAbsArg::transientAttributes ( ) const
inline

Definition at line 374 of file RooAbsArg.h.

◆ treeNodeServerList()

void RooAbsArg::treeNodeServerList ( RooAbsCollection list,
const RooAbsArg arg = 0,
Bool_t  doBranch = kTRUE,
Bool_t  doLeaf = kTRUE,
Bool_t  valueOnly = kFALSE,
Bool_t  recurseFundamental = kFALSE 
) const

Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node.

Parameters
[in]listOutput list
[in]argStart searching at this element of the tree.
[in]doBranchAdd branch nodes to the list.
[in]doLeafAdd leaf nodes to the list.
[in]valueOnlyOnly check if an element is a value server (no shape server).
[in]recurseFundamental

Definition at line 537 of file RooAbsArg.cxx.

◆ unRegisterCache()

void RooAbsArg::unRegisterCache ( RooAbsCache cache)

Unregister a RooAbsCache. Called from the RooAbsCache destructor.

Definition at line 1978 of file RooAbsArg.cxx.

◆ unRegisterProxy() [1/3]

void RooAbsArg::unRegisterProxy ( RooArgProxy proxy)
protected

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1231 of file RooAbsArg.cxx.

◆ unRegisterProxy() [2/3]

void RooAbsArg::unRegisterProxy ( RooListProxy proxy)
protected

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1301 of file RooAbsArg.cxx.

◆ unRegisterProxy() [3/3]

void RooAbsArg::unRegisterProxy ( RooSetProxy proxy)
protected

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1264 of file RooAbsArg.cxx.

◆ valueClientIterator()

TIterator * RooAbsArg::valueClientIterator ( ) const
inline

Definition at line 130 of file RooAbsArg.h.

◆ valueClientMIterator()

RooFIter RooAbsArg::valueClientMIterator ( ) const
inline

Definition at line 146 of file RooAbsArg.h.

◆ valueClients()

const RefCountList_t & RooAbsArg::valueClients ( ) const
inline

List of all value clients of this object. Value clients receive value updates.

Definition at line 189 of file RooAbsArg.h.

◆ verboseDirty()

void RooAbsArg::verboseDirty ( Bool_t  flag)
static

Activate verbose messaging related to dirty flag propagation.

Definition at line 274 of file RooAbsArg.cxx.

◆ wireAllCaches()

void RooAbsArg::wireAllCaches ( )

Definition at line 2297 of file RooAbsArg.cxx.

◆ writeToStream()

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const RooAbsArg arg 
)
friend

◆ operator>>

std::istream & operator>> ( std::istream &  is,
RooAbsArg arg 
)
friend

Istream operator.

Definition at line 1526 of file RooAbsArg.cxx.

◆ RooAbsCollection

friend class RooAbsCollection
friend

Definition at line 607 of file RooAbsArg.h.

◆ RooAbsReal

friend class RooAbsReal
friend

Definition at line 612 of file RooAbsArg.h.

◆ RooAddModel

friend class RooAddModel
friend

Definition at line 624 of file RooAbsArg.h.

◆ RooAddPdf

friend class RooAddPdf
friend

Definition at line 298 of file RooAbsArg.h.

◆ RooAddPdfOrig

friend class RooAddPdfOrig
friend

Definition at line 299 of file RooAbsArg.h.

◆ RooArgProxy

friend class RooArgProxy
friend

Definition at line 625 of file RooAbsArg.h.

◆ RooArgSet

friend class RooArgSet
friend

Definition at line 606 of file RooAbsArg.h.

◆ RooCompositeDataStore

friend class RooCompositeDataStore
friend

Definition at line 648 of file RooAbsArg.h.

◆ RooCustomizer

friend class RooCustomizer
friend

Definition at line 608 of file RooAbsArg.h.

◆ RooDataSet

friend class RooDataSet
friend

Definition at line 651 of file RooAbsArg.h.

◆ RooExtendPdf

friend class RooExtendPdf
friend

Definition at line 610 of file RooAbsArg.h.

◆ RooHistFunc

friend class RooHistFunc
friend

Definition at line 630 of file RooAbsArg.h.

◆ RooHistFunc2

friend class RooHistFunc2
friend

Definition at line 631 of file RooAbsArg.h.

◆ RooHistPdf

friend class RooHistPdf
friend

Definition at line 629 of file RooAbsArg.h.

◆ RooListProxy

friend class RooListProxy
friend

Definition at line 627 of file RooAbsArg.h.

◆ RooObjectFactory

friend class RooObjectFactory
friend

Definition at line 628 of file RooAbsArg.h.

◆ RooProdPdf

friend class RooProdPdf
friend

Definition at line 297 of file RooAbsArg.h.

◆ RooProjectedPdf

friend class RooProjectedPdf
friend

Definition at line 613 of file RooAbsArg.h.

◆ RooRealIntegral

friend class RooRealIntegral
friend

Definition at line 611 of file RooAbsArg.h.

◆ RooRealMPFE

friend class RooRealMPFE
friend

Definition at line 652 of file RooAbsArg.h.

◆ RooRefArray::Streamer

void RooRefArray::Streamer ( TBuffer )
friend

◆ RooSetProxy

friend class RooSetProxy
friend

Definition at line 626 of file RooAbsArg.h.

◆ RooTreeDataStore

friend class RooTreeDataStore
friend

Definition at line 649 of file RooAbsArg.h.

◆ RooVectorDataStore

friend class RooVectorDataStore
friend

Definition at line 650 of file RooAbsArg.h.

◆ RooWorkspace

friend class RooWorkspace
friend

Definition at line 609 of file RooAbsArg.h.

Member Data Documentation

◆ _allBatchesDirty

bool RooAbsArg::_allBatchesDirty {true}
mutableprotected

Definition at line 685 of file RooAbsArg.h.

◆ _boolAttrib

std::set<std::string> RooAbsArg::_boolAttrib
protected

Definition at line 641 of file RooAbsArg.h.

◆ _boolAttribTransient

std::set<std::string> RooAbsArg::_boolAttribTransient
protected

Definition at line 643 of file RooAbsArg.h.

◆ _cacheList

std::deque<RooAbsCache*> RooAbsArg::_cacheList
protected

Definition at line 620 of file RooAbsArg.h.

◆ _clientList

RefCountList_t RooAbsArg::_clientList
protected

Definition at line 615 of file RooAbsArg.h.

◆ _clientListShape

RefCountList_t RooAbsArg::_clientListShape
protected

Definition at line 616 of file RooAbsArg.h.

◆ _clientListValue

RefCountList_t RooAbsArg::_clientListValue
protected

Definition at line 617 of file RooAbsArg.h.

◆ _deleteWatch

Bool_t RooAbsArg::_deleteWatch
protected

Definition at line 673 of file RooAbsArg.h.

◆ _eocache

RooExpensiveObjectCache* RooAbsArg::_eocache {nullptr}
mutableprotected

Prohibit server redirects – Debugging tool.

Definition at line 695 of file RooAbsArg.h.

◆ _fast

Bool_t RooAbsArg::_fast
mutableprotected

Definition at line 688 of file RooAbsArg.h.

◆ _inhibitDirty

Bool_t RooAbsArg::_inhibitDirty
staticprotected

Definition at line 672 of file RooAbsArg.h.

◆ _isConstant

Bool_t RooAbsArg::_isConstant
protected

Do not persist. Pointer to global instance of string that matches object named.

Definition at line 698 of file RooAbsArg.h.

◆ _localNoInhibitDirty

Bool_t RooAbsArg::_localNoInhibitDirty
mutableprotected

Cached isConstant status.

Definition at line 700 of file RooAbsArg.h.

◆ _myws

RooWorkspace* RooAbsArg::_myws
mutableprotected

Prevent 'AlwaysDirty' mode for this node.

Definition at line 705 of file RooAbsArg.h.

◆ _namePtr

TNamed* RooAbsArg::_namePtr
mutableprotected

Definition at line 697 of file RooAbsArg.h.

◆ _operMode

OperMode RooAbsArg::_operMode
mutableprotected

Mark batches as dirty (only meaningful for RooAbsReal).

Definition at line 687 of file RooAbsArg.h.

◆ _ownedComponents

RooArgSet* RooAbsArg::_ownedComponents
protected

Definition at line 691 of file RooAbsArg.h.

◆ _prohibitServerRedirect

Bool_t RooAbsArg::_prohibitServerRedirect
mutableprotected

Set of owned component.

Definition at line 693 of file RooAbsArg.h.

◆ _proxyList

RooRefArray RooAbsArg::_proxyList
protected

Definition at line 619 of file RooAbsArg.h.

◆ _serverList

RefCountList_t RooAbsArg::_serverList
protected

Definition at line 614 of file RooAbsArg.h.

◆ _shapeDirty

Bool_t RooAbsArg::_shapeDirty
mutableprotected

Definition at line 684 of file RooAbsArg.h.

◆ _stringAttrib

std::map<std::string,std::string> RooAbsArg::_stringAttrib
protected

Definition at line 642 of file RooAbsArg.h.

◆ _valueDirty

Bool_t RooAbsArg::_valueDirty
mutableprotected

Definition at line 683 of file RooAbsArg.h.

◆ _verboseDirty

Bool_t RooAbsArg::_verboseDirty
staticprotected

Definition at line 671 of file RooAbsArg.h.

Libraries for RooAbsArg:

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