Logo ROOT   6.19/01
Reference Guide
TExMap Class Reference

This class stores a (key,value) pair using an external hash.

The (key,value) are Long64_t's and therefore can contain object pointers or any longs. The map uses an open addressing hashing method (linear probing).

Definition at line 33 of file TExMap.h.

Classes

struct  Assoc_t
 

Public Member Functions

 TExMap (Int_t mapSize=100)
 Create a TExMap. More...
 
 TExMap (const TExMap &map)
 Copy constructor. More...
 
 ~TExMap ()
 Delete TExMap. More...
 
void Add (ULong64_t hash, Long64_t key, Long64_t value)
 Add an (key,value) pair to the table. The key should be unique. More...
 
void Add (Long64_t key, Long64_t value)
 
void AddAt (UInt_t slot, ULong64_t hash, Long64_t key, Long64_t value)
 Add an (key,value) pair to the table. More...
 
Int_t Capacity () const
 
void Delete (Option_t *opt="")
 Delete all entries stored in the TExMap. More...
 
void Expand (Int_t newsize)
 Expand the TExMap. More...
 
Int_t GetSize () const
 
Long64_t GetValue (ULong64_t hash, Long64_t key)
 Return the value belonging to specified key and hash value. More...
 
Long64_t GetValue (Long64_t key)
 
Long64_t GetValue (ULong64_t hash, Long64_t key, UInt_t &slot)
 Return the value belonging to specified key and hash value. More...
 
Long64_toperator() (ULong64_t hash, Long64_t key)
 Return a reference to the value belonging to the key with the specified hash value. More...
 
Long64_toperator() (Long64_t key)
 
TExMapoperator= (const TExMap &)
 Assignment operator. More...
 
void Remove (ULong64_t hash, Long64_t key)
 Remove entry with specified key from the TExMap. More...
 
void Remove (Long64_t key)
 
- 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 void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. 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 const char * GetName () const
 Returns 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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. 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...
 

Private Member Functions

Int_t FindElement (ULong64_t hash, Long64_t key)
 Find an entry with specified hash and key in the TExMap. More...
 
void FixCollisions (Int_t index)
 Rehash the map in case an entry has been removed. More...
 
Bool_t HighWaterMark ()
 

Private Attributes

Int_t fSize
 
Assoc_tfTable
 
Int_t fTally
 

Friends

class TExMapIter
 

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...
 
- 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 <TExMap.h>

Inheritance diagram for TExMap:
[legend]

Constructor & Destructor Documentation

◆ TExMap() [1/2]

TExMap::TExMap ( Int_t  mapSize = 100)

Create a TExMap.

Definition at line 32 of file TExMap.cxx.

◆ TExMap() [2/2]

TExMap::TExMap ( const TExMap map)

Copy constructor.

Definition at line 53 of file TExMap.cxx.

◆ ~TExMap()

TExMap::~TExMap ( )

Delete TExMap.

Definition at line 79 of file TExMap.cxx.

Member Function Documentation

◆ Add() [1/2]

void TExMap::Add ( ULong64_t  hash,
Long64_t  key,
Long64_t  value 
)

Add an (key,value) pair to the table. The key should be unique.

Definition at line 87 of file TExMap.cxx.

◆ Add() [2/2]

void TExMap::Add ( Long64_t  key,
Long64_t  value 
)
inline

Definition at line 66 of file TExMap.h.

◆ AddAt()

void TExMap::AddAt ( UInt_t  slot,
ULong64_t  hash,
Long64_t  key,
Long64_t  value 
)

Add an (key,value) pair to the table.

The key should be unique. If the 'slot' is open, use it to store the value, otherwise revert to Add(hash,key,value) This is usually used in conjunction with GetValue with 3 parameters:

if ((idx = (ULong64_t)fMap->GetValue(hash, key, slot)) != 0) {
...
} else {
fMap->AddAt(slot,hash,key,value);
}

Definition at line 116 of file TExMap.cxx.

◆ Capacity()

Int_t TExMap::Capacity ( ) const
inline

Definition at line 69 of file TExMap.h.

◆ Delete()

void TExMap::Delete ( Option_t opt = "")
virtual

Delete all entries stored in the TExMap.

Reimplemented from TObject.

Definition at line 163 of file TExMap.cxx.

◆ Expand()

void TExMap::Expand ( Int_t  newsize)

Expand the TExMap.

Definition at line 278 of file TExMap.cxx.

◆ FindElement()

Int_t TExMap::FindElement ( ULong64_t  hash,
Long64_t  key 
)
private

Find an entry with specified hash and key in the TExMap.

Returns the slot of the key or the next empty slot.

Definition at line 236 of file TExMap.cxx.

◆ FixCollisions()

void TExMap::FixCollisions ( Int_t  index)
private

Rehash the map in case an entry has been removed.

Definition at line 256 of file TExMap.cxx.

◆ GetSize()

Int_t TExMap::GetSize ( ) const
inline

Definition at line 71 of file TExMap.h.

◆ GetValue() [1/3]

Long64_t TExMap::GetValue ( ULong64_t  hash,
Long64_t  key 
)

Return the value belonging to specified key and hash value.

If key not found return 0.

Definition at line 173 of file TExMap.cxx.

◆ GetValue() [2/3]

Long64_t TExMap::GetValue ( Long64_t  key)
inline

Definition at line 73 of file TExMap.h.

◆ GetValue() [3/3]

Long64_t TExMap::GetValue ( ULong64_t  hash,
Long64_t  key,
UInt_t slot 
)

Return the value belonging to specified key and hash value.

If key not found return 0. In 'slot', return the index of the slot used or the first empty slot. (to be used with AddAt).

Definition at line 196 of file TExMap.cxx.

◆ HighWaterMark()

Bool_t TExMap::HighWaterMark ( )
inlineprivate

Definition at line 54 of file TExMap.h.

◆ operator()() [1/2]

Long64_t & TExMap::operator() ( ULong64_t  hash,
Long64_t  key 
)

Return a reference to the value belonging to the key with the specified hash value.

If the key does not exist it will be added. NOTE: the reference will be invalidated an Expand() triggered by an Add() or another operator() call.

Definition at line 138 of file TExMap.cxx.

◆ operator()() [2/2]

Long64_t& TExMap::operator() ( Long64_t  key)
inline

Definition at line 79 of file TExMap.h.

◆ operator=()

TExMap & TExMap::operator= ( const TExMap map)

Assignment operator.

Definition at line 64 of file TExMap.cxx.

◆ Remove() [1/2]

void TExMap::Remove ( ULong64_t  hash,
Long64_t  key 
)

Remove entry with specified key from the TExMap.

Definition at line 216 of file TExMap.cxx.

◆ Remove() [2/2]

void TExMap::Remove ( Long64_t  key)
inline

Definition at line 76 of file TExMap.h.

Friends And Related Function Documentation

◆ TExMapIter

friend class TExMapIter
friend

Definition at line 35 of file TExMap.h.

Member Data Documentation

◆ fSize

Int_t TExMap::fSize
private

Definition at line 51 of file TExMap.h.

◆ fTable

Assoc_t* TExMap::fTable
private

Definition at line 50 of file TExMap.h.

◆ fTally

Int_t TExMap::fTally
private

Definition at line 52 of file TExMap.h.


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