Logo ROOT   master
Reference Guide
RooLinkedList Class Reference

RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in a doubly linked list.

It can optionally add a hash table to speed up random access in large collections Use RooAbsCollection derived objects for public use (e.g. RooArgSet or RooArgList)

Definition at line 35 of file RooLinkedList.h.

Public Member Functions

 RooLinkedList (Int_t htsize=0)
 
 RooLinkedList (const RooLinkedList &other)
 Copy constructor. More...
 
virtual ~RooLinkedList ()
 Destructor. More...
 
virtual void Add (TObject *arg)
 
TObjectAt (Int_t index) const
 Return object stored in sequential position given by index. More...
 
void Clear (Option_t *o=0)
 Remove all elements from collection. More...
 
virtual TObjectClone (const char *=0) const
 Make a clone of an object using the Streamer facility. More...
 
void Delete (Option_t *o=0)
 Remove all elements in collection and delete all elements NB: Collection does not own elements, this function should be used judiciously by caller. More...
 
TObjectfind (const char *name) const
 Return pointer to object with given name in collection. More...
 
RooAbsArgfindArg (const RooAbsArg *) const
 Return pointer to object with given name in collection. More...
 
TObjectFindObject (const char *name) const
 Return pointer to obejct with given name. More...
 
TObjectFindObject (const TObject *obj) const
 Find object in list. More...
 
TObjectFirst () const
 
RooFIter fwdIterator () const
 Create a one-time-use forward iterator for this list. More...
 
Int_t getHashTableSize () const
 
const char * GetName () const
 Returns name of object. More...
 
Int_t GetSize () const
 
ULong_t Hash () const
 Return hash value for this object. More...
 
Int_t IndexOf (const char *name) const
 Return position of given object in list. More...
 
Int_t IndexOf (const TObject *arg) const
 Return position of given object in list. More...
 
RooLinkedListIter iterator (Bool_t forward=kTRUE) const
 Create an iterator for this list. More...
 
TIteratorMakeIterator (Bool_t forward=kTRUE) const
 Create a TIterator for this list. More...
 
RooLinkedListoperator= (const RooLinkedList &other)
 Assignment operator, copy contents from 'other'. More...
 
void Print (const char *opt) const
 Print contents of list, defers to Print() function of contained objects. More...
 
virtual void RecursiveRemove (TObject *obj)
 If one of the TObject we have a referenced to is deleted, remove the reference. More...
 
virtual Bool_t Remove (TObject *arg)
 Remove object from collection. More...
 
Bool_t Replace (const TObject *oldArg, const TObject *newArg)
 Replace object 'oldArg' in collection with new object 'newArg'. More...
 
void setHashTableSize (Int_t size)
 Change the threshold for hash-table use to given size. More...
 
void SetName (const char *name)
 
void Sort (Bool_t ascend=kTRUE)
 
void useNptr (Bool_t flag)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Member Functions

virtual void Add (TObject *arg, Int_t refCount)
 Insert object into collection with given reference count value. More...
 
RooLinkedListElemcreateElement (TObject *obj, RooLinkedListElem *elem=0)
 cout << "RooLinkedList::createElem(" << this << ") obj = " << obj << " elem = " << elem << endl ; More...
 
void deleteElement (RooLinkedListElem *)
 
RooLinkedListElemfindLink (const TObject *arg) const
 Find the element link containing the given object. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

RooLinkedListElem_first
 
Int_t _hashThresh
 
RooHashTable_htableLink
 Hash table by name. More...
 
RooHashTable_htableName
 Link to last element of list. More...
 
RooLinkedListElem_last
 Link to first element of list. More...
 
TString _name
 Hash table by link pointer. More...
 
Int_t _size
 
Bool_t _useNptr
 

Private Types

typedef RooLinkedListImplDetails::Pool Pool
 memory pool for quick allocation of RooLinkedListElems More...
 

Static Private Member Functions

template<bool ascending>
static RooLinkedListElemmergesort_impl (RooLinkedListElem *l1, const unsigned sz, RooLinkedListElem **tail=0)
 length 0, 1 lists are sorted More...
 

Private Attributes

std::vector< RooLinkedListElem * > _at
 

Static Private Attributes

static Pool_pool = 0
 shared memory pool for allocation of RooLinkedListElems More...
 

Friends

class RooFIterForLinkedList
 
class RooLinkedListIterImpl
 

Additional Inherited Members

- 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)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <RooLinkedList.h>

Inheritance diagram for RooLinkedList:
[legend]

Member Typedef Documentation

◆ Pool

typedef RooLinkedListImplDetails::Pool RooLinkedList::Pool
private

memory pool for quick allocation of RooLinkedListElems

Definition at line 126 of file RooLinkedList.h.

Constructor & Destructor Documentation

◆ RooLinkedList() [1/2]

RooLinkedList::RooLinkedList ( Int_t  htsize = 0)

Definition at line 263 of file RooLinkedList.cxx.

◆ RooLinkedList() [2/2]

RooLinkedList::RooLinkedList ( const RooLinkedList other)

Copy constructor.

Definition at line 273 of file RooLinkedList.cxx.

◆ ~RooLinkedList()

RooLinkedList::~RooLinkedList ( )
virtual

Destructor.

Definition at line 367 of file RooLinkedList.cxx.

Member Function Documentation

◆ Add() [1/2]

virtual void RooLinkedList::Add ( TObject arg)
inlinevirtual

Reimplemented in RooRefCountList.

Definition at line 62 of file RooLinkedList.h.

◆ Add() [2/2]

void RooLinkedList::Add ( TObject arg,
Int_t  refCount 
)
protectedvirtual

Insert object into collection with given reference count value.

Reimplemented in RooRefCountList.

Definition at line 411 of file RooLinkedList.cxx.

◆ At()

TObject * RooLinkedList::At ( Int_t  index) const

Return object stored in sequential position given by index.

If index is out of range, a null pointer is returned.

Definition at line 496 of file RooLinkedList.cxx.

◆ Clear()

void RooLinkedList::Clear ( Option_t o = 0)
virtual

Remove all elements from collection.

Reimplemented from TObject.

Definition at line 557 of file RooLinkedList.cxx.

◆ Clone()

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

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented from TObject.

Definition at line 43 of file RooLinkedList.h.

◆ createElement()

RooLinkedListElem * RooLinkedList::createElement ( TObject obj,
RooLinkedListElem elem = 0 
)
protected

cout << "RooLinkedList::createElem(" << this << ") obj = " << obj << " elem = " << elem << endl ;

Definition at line 290 of file RooLinkedList.cxx.

◆ Delete()

void RooLinkedList::Delete ( Option_t o = 0)
virtual

Remove all elements in collection and delete all elements NB: Collection does not own elements, this function should be used judiciously by caller.

Reimplemented from TObject.

Definition at line 587 of file RooLinkedList.cxx.

◆ deleteElement()

void RooLinkedList::deleteElement ( RooLinkedListElem elem)
protected

Definition at line 299 of file RooLinkedList.cxx.

◆ find()

TObject * RooLinkedList::find ( const char *  name) const

Return pointer to object with given name in collection.

If no such object is found, return null pointer.

Definition at line 619 of file RooLinkedList.cxx.

◆ findArg()

RooAbsArg * RooLinkedList::findArg ( const RooAbsArg arg) const

Return pointer to object with given name in collection.

If no such object is found, return null pointer.

Definition at line 675 of file RooLinkedList.cxx.

◆ findLink()

RooLinkedListElem * RooLinkedList::findLink ( const TObject arg) const
protected

Find the element link containing the given object.

Definition at line 391 of file RooLinkedList.cxx.

◆ FindObject() [1/2]

TObject * RooLinkedList::FindObject ( const char *  name) const
virtual

Return pointer to obejct with given name.

If no such object is found return a null pointer

Reimplemented from TObject.

Definition at line 539 of file RooLinkedList.cxx.

◆ FindObject() [2/2]

TObject * RooLinkedList::FindObject ( const TObject obj) const
virtual

Find object in list.

If list contains object return (same) pointer to object, otherwise return null pointer

Reimplemented from TObject.

Definition at line 548 of file RooLinkedList.cxx.

◆ First()

TObject* RooLinkedList::First ( ) const
inline

Definition at line 78 of file RooLinkedList.h.

◆ fwdIterator()

RooFIter RooLinkedList::fwdIterator ( ) const

Create a one-time-use forward iterator for this list.

Returns
RooFIter that only supports next()

Definition at line 766 of file RooLinkedList.cxx.

◆ getHashTableSize()

Int_t RooLinkedList::getHashTableSize ( ) const
inline

Definition at line 50 of file RooLinkedList.h.

◆ GetName()

const char* RooLinkedList::GetName ( ) const
inlinevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 89 of file RooLinkedList.h.

◆ GetSize()

Int_t RooLinkedList::GetSize ( ) const
inline

Definition at line 60 of file RooLinkedList.h.

◆ Hash()

ULong_t RooLinkedList::Hash ( ) const
inlinevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Definition at line 95 of file RooLinkedList.h.

◆ IndexOf() [1/2]

Int_t RooLinkedList::IndexOf ( const char *  name) const

Return position of given object in list.

If object is not contained in list, return -1

Definition at line 716 of file RooLinkedList.cxx.

◆ IndexOf() [2/2]

Int_t RooLinkedList::IndexOf ( const TObject arg) const

Return position of given object in list.

If object is not contained in list, return -1

Definition at line 700 of file RooLinkedList.cxx.

◆ iterator()

RooLinkedListIter RooLinkedList::iterator ( Bool_t  forward = kTRUE) const

Create an iterator for this list.

Parameters
forwardRun in forward direction (default).
Returns
RooLinkedListIter (subclass of TIterator) over this list

Definition at line 757 of file RooLinkedList.cxx.

◆ MakeIterator()

TIterator * RooLinkedList::MakeIterator ( Bool_t  forward = kTRUE) const

Create a TIterator for this list.

Parameters
forwardRun in forward direction (default).
Returns
Pointer to a TIterator. The caller owns the pointer.

Definition at line 747 of file RooLinkedList.cxx.

◆ mergesort_impl()

template<bool ascending>
RooLinkedListElem * RooLinkedList::mergesort_impl ( RooLinkedListElem l1,
const unsigned  sz,
RooLinkedListElem **  tail = 0 
)
staticprivate

length 0, 1 lists are sorted

Definition at line 789 of file RooLinkedList.cxx.

◆ operator=()

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

Assignment operator, copy contents from 'other'.

Definition at line 309 of file RooLinkedList.cxx.

◆ Print()

void RooLinkedList::Print ( const char *  opt) const
virtual

Print contents of list, defers to Print() function of contained objects.

Reimplemented from TObject.

Definition at line 732 of file RooLinkedList.cxx.

◆ RecursiveRemove()

void RooLinkedList::RecursiveRemove ( TObject obj)
virtual

If one of the TObject we have a referenced to is deleted, remove the reference.

Reimplemented from TObject.

Definition at line 487 of file RooLinkedList.cxx.

◆ Remove()

Bool_t RooLinkedList::Remove ( TObject arg)
virtual

Remove object from collection.

Reimplemented in RooRefCountList.

Definition at line 455 of file RooLinkedList.cxx.

◆ Replace()

Bool_t RooLinkedList::Replace ( const TObject oldArg,
const TObject newArg 
)

Replace object 'oldArg' in collection with new object 'newArg'.

If 'oldArg' is not found in collection kFALSE is returned

Definition at line 516 of file RooLinkedList.cxx.

◆ setHashTableSize()

void RooLinkedList::setHashTableSize ( Int_t  size)

Change the threshold for hash-table use to given size.

If a hash table exists when this method is called, it is regenerated.

Definition at line 328 of file RooLinkedList.cxx.

◆ SetName()

void RooLinkedList::SetName ( const char *  name)
inline

Definition at line 90 of file RooLinkedList.h.

◆ Sort()

void RooLinkedList::Sort ( Bool_t  ascend = kTRUE)

Definition at line 773 of file RooLinkedList.cxx.

◆ useNptr()

void RooLinkedList::useNptr ( Bool_t  flag)
inline

Definition at line 92 of file RooLinkedList.h.

Friends And Related Function Documentation

◆ RooFIterForLinkedList

friend class RooFIterForLinkedList
friend

Definition at line 105 of file RooLinkedList.h.

◆ RooLinkedListIterImpl

friend class RooLinkedListIterImpl
friend

Definition at line 104 of file RooLinkedList.h.

Member Data Documentation

◆ _at

std::vector<RooLinkedListElem *> RooLinkedList::_at
private

Definition at line 130 of file RooLinkedList.h.

◆ _first

RooLinkedListElem* RooLinkedList::_first
protected

Definition at line 113 of file RooLinkedList.h.

◆ _hashThresh

Int_t RooLinkedList::_hashThresh
protected

Definition at line 111 of file RooLinkedList.h.

◆ _htableLink

RooHashTable* RooLinkedList::_htableLink
protected

Hash table by name.

Definition at line 116 of file RooLinkedList.h.

◆ _htableName

RooHashTable* RooLinkedList::_htableName
protected

Link to last element of list.

Definition at line 115 of file RooLinkedList.h.

◆ _last

RooLinkedListElem* RooLinkedList::_last
protected

Link to first element of list.

Definition at line 114 of file RooLinkedList.h.

◆ _name

TString RooLinkedList::_name
protected

Hash table by link pointer.

Definition at line 118 of file RooLinkedList.h.

◆ _pool

RooLinkedList::Pool * RooLinkedList::_pool = 0
staticprivate

shared memory pool for allocation of RooLinkedListElems

Definition at line 128 of file RooLinkedList.h.

◆ _size

Int_t RooLinkedList::_size
protected

Definition at line 112 of file RooLinkedList.h.

◆ _useNptr

Bool_t RooLinkedList::_useNptr
protected

Definition at line 119 of file RooLinkedList.h.

Libraries for RooLinkedList:
[legend]

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