src/misc/hash/hashPtr.h File Reference

#include <stdio.h>
#include "extra.h"

Include dependency graph for hashPtr.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Hash_Ptr_Entry_t_
struct	Hash_Ptr_t_
Defines
#define	Hash_PtrForEachEntry(pHash, pEntry, bin)
Typedefs
typedef struct Hash_Ptr_t_	Hash_Ptr_t
typedef struct Hash_Ptr_Entry_t_	Hash_Ptr_Entry_t
Functions
int	Hash_DefaultHashFunc (int key, int nBins)
static Hash_Ptr_t *	Hash_PtrAlloc (int nBins)
static int	Hash_PtrExists (Hash_Ptr_t *p, int key)
static void	Hash_PtrWriteEntry (Hash_Ptr_t *p, int key, void *data)
static void *	Hash_PtrEntry (Hash_Ptr_t *p, int key, int fCreate)
static void **	Hash_PtrEntryPtr (Hash_Ptr_t *p, int key)
static void *	Hash_PtrRemove (Hash_Ptr_t *p, int key)
static void	Hash_PtrFree (Hash_Ptr_t *p)

---

Define Documentation

#define Hash_PtrForEachEntry	(	pHash,
		pEntry,
		bin		)

Value:

for(bin=-1, pEntry=NULL; bin < pHash->nBins; (!pEntry)?(pEntry=pHash->pArray[++bin]):(pEntry=pEntry->pNext)) \
    if (pEntry)

MACRO DEFINITIONS ///

Definition at line 65 of file hashPtr.h.

---

Typedef Documentation

typedef struct Hash_Ptr_Entry_t_ Hash_Ptr_Entry_t

Definition at line 42 of file hashPtr.h.

typedef struct Hash_Ptr_t_ Hash_Ptr_t

PARAMETERS /// BASIC TYPES ///

Definition at line 41 of file hashPtr.h.

---

Function Documentation

int Hash_DefaultHashFunc	(	int	key,
		int	nBins
	)

CFile****************************************************************

FileName [hashFlt.h]

SystemName [ABC: Logic synthesis and verification system.]

PackageName [Hash maps.]

Synopsis [Hash maps.]

Author [Aaron P. Hurst]

Affiliation [UC Berkeley]

Date [Ver. 1.0. Started - May 16, 2006.]

Revision [

Id

vecInt.h,v 1.00 2005/06/20 00:00:00 ahurst Exp

] INCLUDES ///

CFile****************************************************************

FileName [hash.h]

SystemName [ABC: Logic synthesis and verification system.]

PackageName [Hash map.]

Synopsis [External declarations.]

Author [Aaron P. Hurst]

Affiliation [UC Berkeley]

Date [Ver. 1.0. Started - May 16, 2005.]

Revision [

Id

vec.h,v 1.00 2005/06/20 00:00:00 ahurst Exp

] INCLUDES /// PARAMETERS /// BASIC TYPES /// MACRO DEFINITIONS /// FUNCTION DECLARATIONS ///

Definition at line 56 of file hash.h.

                                             {
  return ABS( ( (key+11)*(key)*7+3 ) % nBins );
}

static Hash_Ptr_t* Hash_PtrAlloc

(

int

nBins

)

[inline, static]

FUNCTION DEFINITIONS ///Function*************************************************************

Synopsis [Allocates a hash map with the given number of bins.]

Description []

SideEffects []

SeeAlso []

Definition at line 84 of file hashPtr.h.

{
  Hash_Ptr_t * p;
  int i;
  assert(nBins > 0);
  p = ALLOC( Hash_Ptr_t, 1);
  p->nBins = nBins;
  p->fHash = Hash_DefaultHashFunc;
  p->nSize  = 0;
  p->pArray = ALLOC( Hash_Ptr_Entry_t *, nBins );
  for(i=0; i<nBins; i++)
    p->pArray[i] = NULL;

  return p;
}

static void* Hash_PtrEntry	(	Hash_Ptr_t *	p,
		int	key,
		int	fCreate
	)			[inline, static]

Function*************************************************************

Synopsis [Finds or creates an entry with a key.]

Description [fCreate specifies whether a new entry should be created.]

SideEffects []

SeeAlso []

Definition at line 187 of file hashPtr.h.

{
  int bin;
  Hash_Ptr_Entry_t *pEntry, **pLast;

  // find the bin where this key would live
  bin = (*(p->fHash))(key, p->nBins);

  // search for key
  pLast = &(p->pArray[bin]);
  pEntry = p->pArray[bin];
  while(pEntry) {
    if (pEntry->key == key)
      return pEntry->data;
    pLast = &(pEntry->pNext);
    pEntry = pEntry->pNext;
  }

  // this key does not currently exist
  if (fCreate) {
    // create a new entry and add to bin
    p->nSize++;
    (*pLast) = pEntry = ALLOC( Hash_Ptr_Entry_t, 1 );
    pEntry->pNext = NULL;
    pEntry->key = key;
    pEntry->data = NULL;
    return pEntry->data;
  }

  return NULL;
}

static void** Hash_PtrEntryPtr	(	Hash_Ptr_t *	p,
		int	key
	)			[inline, static]

Function*************************************************************

Synopsis [Finds or creates an entry with a key and returns the pointer to it.]

Description []

SideEffects []

SeeAlso []

Definition at line 231 of file hashPtr.h.

{
  int bin;
  Hash_Ptr_Entry_t *pEntry, **pLast;

  // find the bin where this key would live
  bin = (*(p->fHash))(key, p->nBins);

  // search for key
  pLast = &(p->pArray[bin]);
  pEntry = p->pArray[bin];
  while(pEntry) {
    if (pEntry->key == key)
      return &(pEntry->data);
    pLast = &(pEntry->pNext);
    pEntry = pEntry->pNext;
  }

  // this key does not currently exist
  // create a new entry and add to bin
  p->nSize++;
  (*pLast) = pEntry = ALLOC( Hash_Ptr_Entry_t, 1 );
  pEntry->pNext = NULL;
  pEntry->key = key;
  pEntry->data = NULL;

  return &(pEntry->data);
}

static int Hash_PtrExists	(	Hash_Ptr_t *	p,
		int	key
	)			[inline, static]

Function*************************************************************

Synopsis [Returns 1 if a key already exists.]

Description []

SideEffects []

SeeAlso []

Definition at line 111 of file hashPtr.h.

{
  int bin;
  Hash_Ptr_Entry_t *pEntry, **pLast;

  // find the bin where this key would live
  bin = (*(p->fHash))(key, p->nBins);

  // search for key
  pLast = &(p->pArray[bin]);
  pEntry = p->pArray[bin];
  while(pEntry) {
    if (pEntry->key == key) {
      return 1;
    }
    pLast = &(pEntry->pNext);
    pEntry = pEntry->pNext;
  }

  return 0;
}

static void Hash_PtrFree

(

Hash_Ptr_t *

p

)

[inline, static]

Function*************************************************************

Synopsis [Frees the hash.]

Description []

SideEffects []

SeeAlso []

Definition at line 309 of file hashPtr.h.

                                                 {
  int bin;
  Hash_Ptr_Entry_t *pEntry;

  // free bins
  for(bin = 0; bin < p->nBins; bin++) {
    pEntry = p->pArray[bin];
    while(pEntry) {
      pEntry = pEntry->pNext;
      FREE( pEntry );
    }
  }
 
  // free hash
  FREE( p->pArray );
  FREE( p );
}

static void* Hash_PtrRemove	(	Hash_Ptr_t *	p,
		int	key
	)			[inline, static]

Function*************************************************************

Synopsis [Deletes an entry.]

Description [Returns data, if there was any.]

SideEffects []

SeeAlso []

Definition at line 271 of file hashPtr.h.

{
  int    bin;
  void * data;
  Hash_Ptr_Entry_t *pEntry, **pLast;

  // find the bin where this key would live
  bin = (*(p->fHash))(key, p->nBins);

  // search for key
  pLast = &(p->pArray[bin]);
  pEntry = p->pArray[bin];
  while(pEntry) {
    if (pEntry->key == key) {
      p->nSize--;
      data = pEntry->data;
      *pLast = pEntry->pNext;
      return data;
    }
    pLast = &(pEntry->pNext);
    pEntry = pEntry->pNext;
  }
    
  // could not find key
  return NULL;
}

static void Hash_PtrWriteEntry	(	Hash_Ptr_t *	p,
		int	key,
		void *	data
	)			[inline, static]

Function*************************************************************

Synopsis [Finds or creates an entry with a key and writes value.]

Description []

SideEffects []

SeeAlso []

Definition at line 144 of file hashPtr.h.

{
  int bin;
  Hash_Ptr_Entry_t *pEntry, **pLast;

  // find the bin where this key would live
  bin = (*(p->fHash))(key, p->nBins);

  // search for key
  pLast = &(p->pArray[bin]);
  pEntry = p->pArray[bin];
  while(pEntry) {
    if (pEntry->key == key) {
      pEntry->data = data;
      return;
    }
    pLast = &(pEntry->pNext);
    pEntry = pEntry->pNext;
  }

  // this key does not currently exist
  // create a new entry and add to bin
  p->nSize++;
  (*pLast) = pEntry = ALLOC( Hash_Ptr_Entry_t, 1 );
  pEntry->pNext = NULL;
  pEntry->key = key;
  pEntry->data = data;

  return;
}