Logo ROOT  
Reference Guide
TMap Class Reference

TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval (therefore TMap does not conserve the order of the entries). The hash value is calculated using the value returned by the keys Hash() function and the key comparison is done via the IsEqual() function. Both key and value must inherit from TObject.

Definition at line 40 of file TMap.h.

Public Types

typedef TMapIter Iterator_t
 
- Public Types inherited from TCollection
enum  { kInitCapacity = 16, kInitHashTableCapacity = 17 }
 
- 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 Member Functions

 TMap (Int_t capacity=TCollection::kInitHashTableCapacity, Int_t rehash=0)
 TMap ctor. See THashTable for a description of the arguments. More...
 
virtual ~TMap ()
 TMap dtor. More...
 
void Add (TObject *key, TObject *value)
 Add a (key,value) pair to the map. More...
 
void Add (TObject *obj)
 This function may not be used (but we need to provide it since it is a pure virtual in TCollection). More...
 
Float_t AverageCollisions () const
 Return the ratio of entries vs occupied slots. More...
 
Int_t Capacity () const
 Return number of slots in the hashtable. More...
 
void Clear (Option_t *option="")
 Remove all (key,value) pairs from the map. More...
 
Int_t Collisions (const char *keyname) const
 Returns the number of collisions for a key with a certain name (i.e. More...
 
Int_t Collisions (TObject *key) const
 Returns the number of collisions for a key (i.e. More...
 
void Delete (Option_t *option="")
 Remove all (key,value) pairs from the map AND delete the keys when they are allocated on the heap. More...
 
void DeleteAll ()
 Remove all (key,value) pairs from the map AND delete the keys AND values when they are allocated on the heap. More...
 
Bool_t DeleteEntry (TObject *key)
 Remove (key,value) pair with key from the map. More...
 
void DeleteKeys ()
 
void DeleteValues ()
 Remove all (key,value) pairs from the map AND delete the values when they are allocated on the heap. More...
 
TObjectFindObject (const char *keyname) const
 Check if a (key,value) pair exists with keyname as name of the key. More...
 
TObjectFindObject (const TObject *key) const
 Check if a (key,value) pair exists with key as key. More...
 
TObject ** GetObjectRef (const TObject *obj) const
 
const THashTableGetTable () const
 
TObjectGetValue (const char *keyname) const
 Returns a pointer to the value associated with keyname as name of the key. More...
 
TObjectGetValue (const TObject *key) const
 Returns a pointer to the value associated with key. More...
 
Bool_t IsOwnerValue () const
 
TIteratorMakeIterator (Bool_t dir=kIterForward) const
 Create an iterator for TMap. More...
 
TObjectoperator() (const char *keyname) const
 
TObjectoperator() (const TObject *key) const
 
void Rehash (Int_t newCapacity, Bool_t checkObjValidity=kTRUE)
 Rehash the underlaying THashTable (see THashTable::Rehash()). More...
 
TObjectRemove (TObject *key)
 Remove the (key,value) pair with key from the map. More...
 
TPairRemoveEntry (TObject *key)
 Remove (key,value) pair with key from the map. More...
 
virtual void SetOwnerKeyValue (Bool_t ownkeys=kTRUE, Bool_t ownvals=kTRUE)
 Set ownership for keys and values. More...
 
virtual void SetOwnerValue (Bool_t enable=kTRUE)
 Set whether this map is the owner (enable==true) of its values. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write all objects in this map. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write all objects in this map. More...
 
- Public Member Functions inherited from TCollection
virtual ~TCollection ()
 TNamed destructor. More...
 
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 TObjectClone (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
 Return the capacity of the collection, i.e. More...
 
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
 
R__ALWAYS_INLINE Bool_t IsUsingRWLock () const
 
virtual void ls (Option_t *option="") const
 List (ls) all objects in this collection. More...
 
virtual TIteratorMakeReverseIterator () const
 
virtual Bool_t Notify ()
 'Notify' all objects in this collection. More...
 
TObjectoperator() (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 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, Int_t recurse) const
 Print the collection header and its elements. More...
 
virtual void Print (Option_t *option, TPRegexp &regexp, Int_t recurse=1) const
 Print the collection header and its elements that match the regexp. More...
 
virtual void Print (Option_t *option="") const
 Default print for collections, calls Print(option, 1). More...
 
virtual void RecursiveRemove (TObject *obj)
 Remove object from this collection and recursively remove the object from all other objects (and collections). More...
 
void RemoveAll ()
 
virtual void RemoveAll (TCollection *col)
 Remove all objects in collection col from this collection. More...
 
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 bool UseRWLock ()
 Set this collection to use a RW lock upon access, making it thread safe. 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...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void 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 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 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...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
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 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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...
 

Protected Types

enum  EStatusBits { kIsOwnerValue = BIT(15) }
 
- Protected Types inherited from TCollection
enum  EStatusBits { kIsOwner = BIT(14), kUseRWLock = BIT(16) }
 

Protected Member Functions

virtual void PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const
 Print the collection entry. More...
 
- 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 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 ()
 

Private Member Functions

 TMap (const TMap &map)
 
TMapoperator= (const TMap &map)
 

Private Attributes

THashTablefTable
 

Friends

class TMapIter
 

Additional Inherited Members

- 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 TCollectionGetCurrentCollection ()
 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 Attributes inherited from TCollection
TString fName
 
Int_t fSize
 

#include <TMap.h>

Inheritance diagram for TMap:
[legend]

Member Typedef Documentation

◆ Iterator_t

Definition at line 56 of file TMap.h.

Member Enumeration Documentation

◆ EStatusBits

enum TMap::EStatusBits
protected
Enumerator
kIsOwnerValue 

Definition at line 51 of file TMap.h.

Constructor & Destructor Documentation

◆ TMap() [1/2]

TMap::TMap ( const TMap map)
private

◆ TMap() [2/2]

TMap::TMap ( Int_t  capacity = TCollection::kInitHashTableCapacity,
Int_t  rehash = 0 
)

TMap ctor. See THashTable for a description of the arguments.

Definition at line 34 of file TMap.cxx.

◆ ~TMap()

TMap::~TMap ( )
virtual

TMap dtor.

Objects are not deleted unless the TMap is the owner (set via SetOwner()).

Definition at line 44 of file TMap.cxx.

Member Function Documentation

◆ Add() [1/2]

void TMap::Add ( TObject key,
TObject value 
)

Add a (key,value) pair to the map.

Definition at line 62 of file TMap.cxx.

◆ Add() [2/2]

void TMap::Add ( TObject obj)
virtual

This function may not be used (but we need to provide it since it is a pure virtual in TCollection).

Use Add(key,value) instead.

Implements TCollection.

Definition at line 54 of file TMap.cxx.

◆ AverageCollisions()

Float_t TMap::AverageCollisions ( ) const

Return the ratio of entries vs occupied slots.

Definition at line 73 of file TMap.cxx.

◆ Capacity()

Int_t TMap::Capacity ( ) const

Return number of slots in the hashtable.

Use GetSize() to get the number of objects stored in the TMap.

Definition at line 82 of file TMap.cxx.

◆ Clear()

void TMap::Clear ( Option_t option = "")
virtual

Remove all (key,value) pairs from the map.

The keys/values are deleted depending on the state of key-ownership (SetOwner()) and value-ownership (SetOwnerValue()).

To delete these objects regardless of the ownership state use:

Implements TCollection.

Definition at line 97 of file TMap.cxx.

◆ Collisions() [1/2]

Int_t TMap::Collisions ( const char *  keyname) const

Returns the number of collisions for a key with a certain name (i.e.

number of objects in same slot in the hash table, i.e. length of linked list).

Definition at line 116 of file TMap.cxx.

◆ Collisions() [2/2]

Int_t TMap::Collisions ( TObject key) const

Returns the number of collisions for a key (i.e.

number of objects in same slot in the hash table, i.e. length of linked list).

Definition at line 125 of file TMap.cxx.

◆ Delete()

void TMap::Delete ( Option_t option = "")
virtual

Remove all (key,value) pairs from the map AND delete the keys when they are allocated on the heap.

Implements TCollection.

Definition at line 134 of file TMap.cxx.

◆ DeleteAll()

void TMap::DeleteAll ( )

Remove all (key,value) pairs from the map AND delete the keys AND values when they are allocated on the heap.

Definition at line 168 of file TMap.cxx.

◆ DeleteEntry()

Bool_t TMap::DeleteEntry ( TObject key)

Remove (key,value) pair with key from the map.

Returns true if the key was found and removed, false otherwise. The key and value objects are deleted if map is the owner of keys and values respectively.

Definition at line 190 of file TMap.cxx.

◆ DeleteKeys()

void TMap::DeleteKeys ( )
inline

Definition at line 68 of file TMap.h.

◆ DeleteValues()

void TMap::DeleteValues ( )

Remove all (key,value) pairs from the map AND delete the values when they are allocated on the heap.

Definition at line 151 of file TMap.cxx.

◆ FindObject() [1/2]

TObject * TMap::FindObject ( const char *  keyname) const
virtual

Check if a (key,value) pair exists with keyname as name of the key.

Returns a TPair* (need to downcast from TObject). Use Key() and Value() to get the pointers to the key and value, respectively. Returns 0 if not found.

Reimplemented from TCollection.

Definition at line 215 of file TMap.cxx.

◆ FindObject() [2/2]

TObject * TMap::FindObject ( const TObject key) const
virtual

Check if a (key,value) pair exists with key as key.

Returns a TPair* (need to downcast from TObject). Use Key() and Value() to get the pointers to the key and value, respectively. Returns 0 if not found.

Reimplemented from TCollection.

Definition at line 226 of file TMap.cxx.

◆ GetObjectRef()

TObject** TMap::GetObjectRef ( const TObject obj) const
inlinevirtual

Implements TCollection.

Definition at line 74 of file TMap.h.

◆ GetTable()

const THashTable* TMap::GetTable ( ) const
inline

Definition at line 75 of file TMap.h.

◆ GetValue() [1/2]

TObject * TMap::GetValue ( const char *  keyname) const

Returns a pointer to the value associated with keyname as name of the key.

Definition at line 236 of file TMap.cxx.

◆ GetValue() [2/2]

TObject * TMap::GetValue ( const TObject key) const

Returns a pointer to the value associated with key.

Definition at line 246 of file TMap.cxx.

◆ IsOwnerValue()

Bool_t TMap::IsOwnerValue ( ) const
inline

Definition at line 78 of file TMap.h.

◆ MakeIterator()

TIterator * TMap::MakeIterator ( Bool_t  dir = kIterForward) const
virtual

Create an iterator for TMap.

Implements TCollection.

Definition at line 258 of file TMap.cxx.

◆ operator()() [1/2]

TObject* TMap::operator() ( const char *  keyname) const
inline

Definition at line 79 of file TMap.h.

◆ operator()() [2/2]

TObject* TMap::operator() ( const TObject key) const
inline

Definition at line 80 of file TMap.h.

◆ operator=()

TMap& TMap::operator= ( const TMap map)
private

◆ PrintCollectionEntry()

void TMap::PrintCollectionEntry ( TObject entry,
Option_t option,
Int_t  recurse 
) const
protectedvirtual

Print the collection entry.

Reimplemented from TCollection.

Definition at line 266 of file TMap.cxx.

◆ Rehash()

void TMap::Rehash ( Int_t  newCapacity,
Bool_t  checkObjValidity = kTRUE 
)

Rehash the underlaying THashTable (see THashTable::Rehash()).

Definition at line 286 of file TMap.cxx.

◆ Remove()

TObject * TMap::Remove ( TObject key)
virtual

Remove the (key,value) pair with key from the map.

Returns the key object or 0 in case key was not found. If map is the owner of values, the value is deleted.

Implements TCollection.

Definition at line 296 of file TMap.cxx.

◆ RemoveEntry()

TPair * TMap::RemoveEntry ( TObject key)

Remove (key,value) pair with key from the map.

Returns the pair object or 0 in case the key was not found. It is caller's responsibility to delete the pair and, eventually, the key and value objects.

Definition at line 320 of file TMap.cxx.

◆ SetOwnerKeyValue()

void TMap::SetOwnerKeyValue ( Bool_t  ownkeys = kTRUE,
Bool_t  ownvals = kTRUE 
)
virtual

Set ownership for keys and values.

Definition at line 352 of file TMap.cxx.

◆ SetOwnerValue()

void TMap::SetOwnerValue ( Bool_t  enable = kTRUE)
virtual

Set whether this map is the owner (enable==true) of its values.

If it is the owner of its contents, these objects will be deleted whenever the collection itself is deleted. The objects might also be deleted or destructed when Clear is called (depending on the collection).

Definition at line 341 of file TMap.cxx.

◆ Write() [1/2]

Int_t TMap::Write ( const char *  name = 0,
Int_t  option = 0,
Int_t  bsize = 0 
)
virtual

Write all objects in this map.

By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).

Reimplemented from TCollection.

Definition at line 432 of file TMap.cxx.

◆ Write() [2/2]

Int_t TMap::Write ( const char *  name = 0,
Int_t  option = 0,
Int_t  bsize = 0 
) const
virtual

Write all objects in this map.

By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).

Reimplemented from TCollection.

Definition at line 405 of file TMap.cxx.

Friends And Related Function Documentation

◆ TMapIter

friend class TMapIter
friend

Definition at line 42 of file TMap.h.

Member Data Documentation

◆ fTable

THashTable* TMap::fTable
private

Definition at line 45 of file TMap.h.


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