LLVM API Documentation

Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
llvm::SmallPtrSetImplBase Class Reference

#include <SmallPtrSet.h>

Inheritance diagram for llvm::SmallPtrSetImplBase:
Inheritance graph
[legend]
Collaboration diagram for llvm::SmallPtrSetImplBase:
Collaboration graph
[legend]

List of all members.

Public Types

typedef unsigned size_type

Public Member Functions

bool LLVM_ATTRIBUTE_UNUSED_RESULT empty () const
size_type size () const
void clear ()

Protected Member Functions

 SmallPtrSetImplBase (const void **SmallStorage, const SmallPtrSetImplBase &that)
 SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize, SmallPtrSetImplBase &&that)
 SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize)
 ~SmallPtrSetImplBase ()
bool insert_imp (const void *Ptr)
bool erase_imp (const void *Ptr)
bool count_imp (const void *Ptr) const
void swap (SmallPtrSetImplBase &RHS)
void CopyFrom (const SmallPtrSetImplBase &RHS)
void MoveFrom (unsigned SmallSize, SmallPtrSetImplBase &&RHS)

Static Protected Member Functions

static void * getTombstoneMarker ()
static void * getEmptyMarker ()

Protected Attributes

const void ** SmallArray
 SmallArray - Points to a fixed size set of buckets, used in 'small mode'.
const void ** CurArray
unsigned CurArraySize
 CurArraySize - The allocated size of CurArray, always a power of two.
unsigned NumElements
unsigned NumTombstones

Friends

class SmallPtrSetIteratorImpl

Detailed Description

SmallPtrSetImplBase - This is the common code shared among all the SmallPtrSet<>'s, which is almost everything. SmallPtrSet has two modes, one for small and one for large sets.

Small sets use an array of pointers allocated in the SmallPtrSet object, which is treated as a simple array of pointers. When a pointer is added to the set, the array is scanned to see if the element already exists, if not the element is 'pushed back' onto the array. If we run out of space in the array, we grow into the 'large set' case. SmallSet should be used when the sets are often small. In this case, no memory allocation is used, and only light-weight and cache-efficient scanning is used.

Large sets use a classic exponentially-probed hash table. Empty buckets are represented with an illegal pointer value (-1) to allow null pointers to be inserted. Tombstones are represented with another illegal pointer value (-2), to allow deletion. The hash table is resized when the table is 3/4 or more. When this happens, the table is doubled in size.

Definition at line 48 of file SmallPtrSet.h.


Member Typedef Documentation

Definition at line 76 of file SmallPtrSet.h.


Constructor & Destructor Documentation

SmallPtrSetImplBase::SmallPtrSetImplBase ( const void **  SmallStorage,
const SmallPtrSetImplBase that 
) [protected]
SmallPtrSetImplBase::SmallPtrSetImplBase ( const void **  SmallStorage,
unsigned  SmallSize,
SmallPtrSetImplBase &&  that 
) [protected]

Definition at line 189 of file SmallPtrSet.cpp.

References CurArray, CurArraySize, llvm::LibFunc::memcpy, NumTombstones, and SmallArray.

llvm::SmallPtrSetImplBase::SmallPtrSetImplBase ( const void **  SmallStorage,
unsigned  SmallSize 
) [inline, explicit, protected]

Definition at line 67 of file SmallPtrSet.h.

References clear().

Definition at line 332 of file SmallPtrSet.cpp.

References CurArray, and llvm::LibFunc::free.


Member Function Documentation

CopyFrom - implement operator= from a smallptrset that has the same pointer type, but may have a different small size.

Definition at line 218 of file SmallPtrSet.cpp.

References CurArray, CurArraySize, llvm::LibFunc::free, llvm::LibFunc::malloc, llvm::LibFunc::memcpy, NumElements, NumTombstones, llvm::LibFunc::realloc, SmallArray, and T.

Referenced by llvm::SmallPtrSet< const MDNode *, 16 >::operator=().

bool llvm::SmallPtrSetImplBase::count_imp ( const void *  Ptr) const [inline, protected]

Definition at line 111 of file SmallPtrSet.h.

References NumElements, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< const BlockT * >::count().

bool SmallPtrSetImplBase::erase_imp ( const void *  Ptr) [protected]

erase_imp - If the set contains the specified pointer, remove it and return true, otherwise return false. This is hidden from the client so that the derived class can check that the right type of pointer is passed in.

Definition at line 74 of file SmallPtrSet.cpp.

References getEmptyMarker(), getTombstoneMarker(), NumElements, NumTombstones, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< const BlockT * >::erase().

static void* llvm::SmallPtrSetImplBase::getEmptyMarker ( ) [inline, static, protected]

Definition at line 94 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetIteratorImpl::AdvanceIfNotValid(), and erase_imp().

static void* llvm::SmallPtrSetImplBase::getTombstoneMarker ( ) [inline, static, protected]
bool SmallPtrSetImplBase::insert_imp ( const void *  Ptr) [protected]

insert_imp - This returns true if the pointer was new to the set, false if it was already in the set. This is hidden from the client so that the derived class can check that the right type of pointer is passed in.

Definition at line 37 of file SmallPtrSet.cpp.

References CurArraySize, getTombstoneMarker(), NumElements, NumTombstones, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< const BlockT * >::insert().

void SmallPtrSetImplBase::MoveFrom ( unsigned  SmallSize,
SmallPtrSetImplBase &&  RHS 
) [protected]
void SmallPtrSetImplBase::swap ( SmallPtrSetImplBase RHS) [protected]

swap - Swaps the elements of two sets. Note: This method assumes that both sets have the same small size.

Definition at line 282 of file SmallPtrSet.cpp.

References CurArray, CurArraySize, NumElements, NumTombstones, and SmallArray.


Friends And Related Function Documentation

friend class SmallPtrSetIteratorImpl [friend]

Definition at line 49 of file SmallPtrSet.h.


Member Data Documentation

CurArray - This is the current set of buckets. If equal to SmallArray, then the set is in 'small mode'.

Definition at line 55 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetImpl< const BlockT * >::begin(), clear(), CopyFrom(), llvm::SmallPtrSetImpl< const BlockT * >::end(), MoveFrom(), SmallPtrSetImplBase(), swap(), and ~SmallPtrSetImplBase().

CurArraySize - The allocated size of CurArray, always a power of two.

Definition at line 57 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetImpl< const BlockT * >::begin(), clear(), CopyFrom(), llvm::SmallPtrSetImpl< const BlockT * >::end(), insert_imp(), MoveFrom(), SmallPtrSetImplBase(), and swap().

Definition at line 61 of file SmallPtrSet.h.

Referenced by clear(), CopyFrom(), erase_imp(), insert_imp(), MoveFrom(), SmallPtrSetImplBase(), and swap().

SmallArray - Points to a fixed size set of buckets, used in 'small mode'.

Definition at line 52 of file SmallPtrSet.h.

Referenced by CopyFrom(), count_imp(), erase_imp(), insert_imp(), MoveFrom(), SmallPtrSetImplBase(), and swap().


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