ROOT 6.08/07 Reference Guide |
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject's.
The hash table is used for quick access and lookup of objects while the list allows the objects to be ordered. The hash value is calculated using the value returned by the TObject's Hash() function. Each class inheriting from TObject can override Hash() as it sees fit.
Definition at line 36 of file THashList.h.
Public Member Functions | |
THashList (Int_t capacity=TCollection::kInitHashTableCapacity, Int_t rehash=0) | |
Create a THashList object. More... | |
THashList (TObject *parent, Int_t capacity=TCollection::kInitHashTableCapacity, Int_t rehash=0) | |
For backward compatibility only. Use other ctor. More... | |
virtual | ~THashList () |
Delete a hashlist. More... | |
void | AddAfter (const TObject *after, TObject *obj) |
Insert object after object after in the list. More... | |
void | AddAfter (TObjLink *after, TObject *obj) |
Insert object after object after in the list. More... | |
void | AddAt (TObject *obj, Int_t idx) |
Insert object at location idx in the list. More... | |
void | AddBefore (const TObject *before, TObject *obj) |
Insert object before object before in the list. More... | |
void | AddBefore (TObjLink *before, TObject *obj) |
Insert object before object before in the list. More... | |
void | AddFirst (TObject *obj) |
Add object at the beginning of the list. More... | |
void | AddFirst (TObject *obj, Option_t *opt) |
Add object at the beginning of the list and also store option. More... | |
void | AddLast (TObject *obj) |
Add object at the end of the list. More... | |
void | AddLast (TObject *obj, Option_t *opt) |
Add object at the end of the list and also store option. More... | |
Float_t | AverageCollisions () const |
Return the average collision rate. More... | |
void | Clear (Option_t *option="") |
Remove all objects from the list. More... | |
void | Delete (Option_t *option="") |
Remove all objects from the list AND delete all heap based objects. More... | |
TObject * | FindObject (const char *name) const |
Find object using its name. More... | |
TObject * | FindObject (const TObject *obj) const |
Find object using its hash value (returned by its Hash() member). More... | |
const TList * | GetListForObject (const char *name) const |
Return the THashTable's list (bucket) in which obj can be found based on its hash; see THashTable::GetListForObject(). More... | |
const TList * | GetListForObject (const TObject *obj) const |
Return the THashTable's list (bucket) in which obj can be found based on its hash; see THashTable::GetListForObject(). More... | |
void | RecursiveRemove (TObject *obj) |
Remove object from this collection and recursively remove the object from all other objects (and collections). More... | |
void | Rehash (Int_t newCapacity) |
Rehash the hashlist. More... | |
TObject * | Remove (TObject *obj) |
Remove object from the list. More... | |
TObject * | Remove (TObjLink *lnk) |
Remove object via its objlink from the list. More... | |
Public Member Functions inherited from TList | |
TList () | |
TList (TObject *) | |
virtual | ~TList () |
Delete the list. More... | |
virtual void | Add (TObject *obj) |
virtual void | Add (TObject *obj, Option_t *opt) |
virtual TObject * | After (const TObject *obj) const |
Returns the object after object obj. More... | |
virtual TObject * | At (Int_t idx) const |
Returns the object at position idx. Returns 0 if idx is out of range. More... | |
virtual TObject * | Before (const TObject *obj) const |
Returns the object before object obj. More... | |
virtual TObject * | First () const |
Return the first object in the list. Returns 0 when list is empty. More... | |
virtual TObjLink * | FirstLink () const |
virtual TObject ** | GetObjectRef (const TObject *obj) const |
Return address of pointer to obj. More... | |
Bool_t | IsAscending () |
virtual TObject * | Last () const |
Return the last object in the list. Returns 0 when list is empty. More... | |
virtual TObjLink * | LastLink () const |
virtual TIterator * | MakeIterator (Bool_t dir=kIterForward) const |
Return a list iterator. More... | |
virtual void | RemoveLast () |
Remove the last object of the list. More... | |
virtual void | Sort (Bool_t order=kSortAscending) |
Sort linked list. More... | |
Public Member Functions inherited from TSeqCollection | |
virtual | ~TSeqCollection () |
virtual Int_t | GetLast () const |
Returns index of last object in collection. More... | |
virtual Int_t | IndexOf (const TObject *obj) const |
Return index of object in collection. More... | |
virtual Bool_t | IsSorted () const |
Int_t | LastIndex () const |
Long64_t | Merge (TCollection *list) |
Merge this collection with all collections coming in the input list. More... | |
virtual void | RemoveAfter (TObject *after) |
virtual TObject * | RemoveAt (Int_t idx) |
virtual void | RemoveBefore (TObject *before) |
virtual void | RemoveFirst () |
void | UnSort () |
Public Member Functions inherited from TCollection | |
virtual | ~TCollection () |
virtual void | AddAll (const TCollection *col) |
Add all objects from collection col to this collection. More... | |
void | AddVector (TObject *obj1,...) |
Add all arguments to the collection. More... | |
Bool_t | AssertClass (TClass *cl) const |
Make sure all objects in this collection inherit from class cl. More... | |
TIter | begin () const |
void | Browse (TBrowser *b) |
Browse this collection (called by TBrowser). More... | |
Int_t | Capacity () const |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an collection using the Streamer facility. More... | |
Int_t | Compare (const TObject *obj) const |
Compare two TCollection objects. More... | |
Bool_t | Contains (const char *name) const |
Bool_t | Contains (const TObject *obj) const |
virtual void | Draw (Option_t *option="") |
Draw all objects in this collection. More... | |
virtual void | Dump () const |
Dump all objects in this collection. More... | |
TIter | end () const |
virtual Int_t | GetEntries () const |
virtual const char * | GetName () const |
Return name of this collection. More... | |
virtual Int_t | GetSize () const |
virtual Int_t | GrowBy (Int_t delta) const |
Increase the collection's capacity by delta slots. More... | |
ULong_t | Hash () const |
Return hash value for this object. More... | |
Bool_t | IsArgNull (const char *where, const TObject *obj) const |
Returns true if object is a null pointer. More... | |
virtual Bool_t | IsEmpty () const |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
Bool_t | IsOwner () const |
Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List (ls) all objects in this collection. More... | |
virtual TIterator * | MakeReverseIterator () const |
TObject * | operator() (const char *name) const |
Find an object in this collection by name. More... | |
virtual void | Paint (Option_t *option="") |
Paint all objects in this collection. More... | |
virtual void | Print (Option_t *option="") const |
Default print for collections, calls Print(option, 1). More... | |
virtual void | Print (Option_t *option, Int_t recurse) const |
Print the collection header and its elements. More... | |
virtual void | Print (Option_t *option, const char *wildcard, Int_t recurse=1) const |
Print the collection header and its elements that match the wildcard. More... | |
virtual void | Print (Option_t *option, TPRegexp ®exp, Int_t recurse=1) const |
Print the collection header and its elements that match the regexp. More... | |
virtual void | RemoveAll (TCollection *col) |
Remove all objects in collection col from this collection. More... | |
void | RemoveAll () |
void | SetCurrentCollection () |
Set this collection to be the globally accesible collection. More... | |
void | SetName (const char *name) |
virtual void | SetOwner (Bool_t enable=kTRUE) |
Set whether this collection is the owner (enable==true) of its content. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write all objects in this collection. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write all objects in this collection. More... | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. More... | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
virtual | ~TObject () |
TObject destructor. More... | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. More... | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. More... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. 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 | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. More... | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current pad. 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_t * | GetDrawOption () 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_t * | GetOption () 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... | |
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... | |
Bool_t | IsOnHeap () const |
Bool_t | IsZombie () const |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. 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... | |
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... | |
Protected Attributes | |
THashTable * | fTable |
Protected Attributes inherited from TList | |
Bool_t | fAscending |
cache to speedup sequential calling of Before() and After() functions More... | |
TObjLink * | fCache |
pointer to last entry in linked list More... | |
TObjLink * | fFirst |
TObjLink * | fLast |
pointer to first entry in linked list More... | |
Protected Attributes inherited from TSeqCollection | |
Bool_t | fSorted |
Protected Attributes inherited from TCollection | |
TString | fName |
Int_t | fSize |
Private Member Functions | |
THashList (const THashList &) | |
THashList & | operator= (const THashList &) |
Additional Inherited Members | |
Public Types inherited from TList | |
typedef TListIter | Iterator_t |
Public Types inherited from TCollection | |
enum | { kInitCapacity = 16, kInitHashTableCapacity = 17 } |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
Static Public Member Functions inherited from TSeqCollection | |
static Int_t | ObjCompare (TObject *a, TObject *b) |
Compare to objects in the collection. Use member Compare() of object a. More... | |
static void | QSort (TObject **a, Int_t first, Int_t last) |
Sort array of TObject pointers using a quicksort algorithm. More... | |
static void | QSort (TObject **a, TObject **b, Int_t first, Int_t last) |
static void | QSort (TObject **a, Int_t nBs, TObject ***b, Int_t first, Int_t last) |
Sort array a of TObject pointers using a quicksort algorithm. More... | |
Static Public Member Functions inherited from TCollection | |
static void | EmptyGarbageCollection () |
Do the garbage collection. More... | |
static void | GarbageCollect (TObject *obj) |
Add to the list of things to be cleaned up. More... | |
static TCollection * | GetCurrentCollection () |
Return the globally accessible collection. More... | |
static void | StartGarbageCollection () |
Set up for garbage collection. More... | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
Protected Types inherited from TCollection | |
enum | { kIsOwner = BIT(14) } |
Protected Member Functions inherited from TList | |
virtual void | DeleteLink (TObjLink *lnk) |
Delete a TObjLink object. More... | |
TObjLink ** | DoSort (TObjLink **head, Int_t n) |
Sort linked list. More... | |
TObjLink * | FindLink (const TObject *obj, Int_t &idx) const |
Returns the TObjLink object that contains object obj. More... | |
TObjLink * | LinkAt (Int_t idx) const |
sorting order (when calling Sort() or for TSortedList) More... | |
Bool_t | LnkCompare (TObjLink *l1, TObjLink *l2) |
Compares the objects stored in the TObjLink objects. More... | |
virtual TObjLink * | NewLink (TObject *obj, TObjLink *prev=NULL) |
Return a new TObjLink. More... | |
virtual TObjLink * | NewOptLink (TObject *obj, Option_t *opt, TObjLink *prev=NULL) |
Return a new TObjOptLink (a TObjLink that also stores the option). More... | |
Protected Member Functions inherited from TSeqCollection | |
TSeqCollection () | |
virtual void | Changed () |
Protected Member Functions inherited from TCollection | |
TCollection () | |
virtual const char * | GetCollectionEntryName (TObject *entry) const |
For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on. More... | |
virtual void | PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const |
Print the collection entry. More... | |
virtual void | PrintCollectionHeader (Option_t *option) const |
Print the collection header. 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 () |
#include <THashList.h>
|
private |
THashList::THashList | ( | Int_t | capacity = TCollection::kInitHashTableCapacity , |
Int_t | rehash = 0 |
||
) |
Create a THashList object.
Capacity is the initial hashtable capacity (i.e. number of slots), by default kInitHashTableCapacity = 17, and rehash is the value at which a rehash will be triggered. I.e. when the average size of the linked lists at a slot becomes longer than rehash then the hashtable will be resized and refilled to reduce the collision rate to about 1. The higher the collision rate, i.e. the longer the linked lists, the longer lookup will take. If rehash=0 the table will NOT automatically be rehashed. Use Rehash() for manual rehashing.
WARNING !!! If the name of an object in the HashList is modified, The hashlist must be Rehashed
Definition at line 42 of file THashList.cxx.
THashList::THashList | ( | TObject * | parent, |
Int_t | capacity = TCollection::kInitHashTableCapacity , |
||
Int_t | rehash = 0 |
||
) |
For backward compatibility only. Use other ctor.
Definition at line 50 of file THashList.cxx.
|
virtual |
Delete a hashlist.
Objects are not deleted unless the THashList is the owner (set via SetOwner()).
Definition at line 59 of file THashList.cxx.
Insert object after object after in the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 130 of file THashList.cxx.
Insert object after object after in the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 139 of file THashList.cxx.
Insert object at location idx in the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 148 of file THashList.cxx.
Insert object before object before in the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 112 of file THashList.cxx.
Insert object before object before in the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 121 of file THashList.cxx.
Add object at the beginning of the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 68 of file THashList.cxx.
Add object at the beginning of the list and also store option.
Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 81 of file THashList.cxx.
Add object at the end of the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 90 of file THashList.cxx.
Add object at the end of the list and also store option.
Storing an option is useful when one wants to change the behaviour of an object a little without having to create a complete new copy of the object. This feature is used, for example, by the Draw() method. It allows the same object to be drawn in different ways.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfEnums, TListOfDataMembers, TListOfFunctionTemplates, TListOfEnumsWithLock, and TSelectorList.
Definition at line 103 of file THashList.cxx.
Float_t THashList::AverageCollisions | ( | ) | const |
Return the average collision rate.
The higher the number the longer the linked lists in the hashtable, the slower the lookup. If the number is high, or lookup noticeably too slow, perform a Rehash().
Definition at line 159 of file THashList.cxx.
Remove all objects from the list.
Does not delete the objects unless the THashList is the owner (set via SetOwner()).
Reimplemented from TList.
Reimplemented in TListOfEnums, TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 168 of file THashList.cxx.
Remove all objects from the list AND delete all heap based objects.
If option="slow" then keep list consistent during delete. This allows recursive list operations during the delete (e.g. during the dtor of an object in this list one can still access the list to search for other not yet deleted objects).
Reimplemented from TList.
Reimplemented in TListOfEnums, TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 184 of file THashList.cxx.
|
virtual |
Find object using its name.
Uses the hash value returned by the TString::Hash() after converting name to a TString.
Reimplemented from TList.
Reimplemented in TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 213 of file THashList.cxx.
Find object using its hash value (returned by its Hash() member).
Reimplemented from TList.
Reimplemented in TListOfFunctions, and TListOfEnumsWithLock.
Definition at line 221 of file THashList.cxx.
const TList * THashList::GetListForObject | ( | const char * | name | ) | const |
Return the THashTable's list (bucket) in which obj can be found based on its hash; see THashTable::GetListForObject().
Definition at line 230 of file THashList.cxx.
Return the THashTable's list (bucket) in which obj can be found based on its hash; see THashTable::GetListForObject().
Definition at line 239 of file THashList.cxx.
Remove object from this collection and recursively remove the object from all other objects (and collections).
This function overrides TCollection::RecursiveRemove that calls the Remove function. THashList::Remove cannot be called because it uses the hash value of the hash table. This hash value is not available anymore when RecursiveRemove is called from the TObject destructor.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfDataMembers, TListOfEnums, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 253 of file THashList.cxx.
Rehash the hashlist.
If the collision rate becomes too high (i.e. the average size of the linked lists become too long) then lookup efficiency decreases since relatively long lists have to be searched every time. To improve performance rehash the hashtable. This resizes the table to newCapacity slots and refills the table. Use AverageCollisions() to check if you need to rehash.
Definition at line 277 of file THashList.cxx.
Remove object from the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfDataMembers, TListOfEnums, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 285 of file THashList.cxx.
Remove object via its objlink from the list.
Reimplemented from TList.
Reimplemented in TListOfFunctions, TListOfDataMembers, TListOfEnums, TListOfFunctionTemplates, and TListOfEnumsWithLock.
Definition at line 296 of file THashList.cxx.
|
protected |
Definition at line 39 of file THashList.h.