186 lines
4.8 KiB
C
186 lines
4.8 KiB
C
/*
|
|
* Treap.h
|
|
*
|
|
* A balanced binary tree implementation
|
|
*
|
|
* Overhead for using the treap is -
|
|
* Overhead for the heap used by the treap :
|
|
* 24 bytes + 4 bytes per extension
|
|
* 12 bytes for the root
|
|
* 20 bytes per node
|
|
*/
|
|
#ifndef _treap_h
|
|
#define _treap_h
|
|
|
|
#include "types.h"
|
|
#include "debug.h"
|
|
#include "mem.h"
|
|
#include "heap.h"
|
|
|
|
/* Turn on and off the treap debugging */
|
|
#ifdef DEBUG
|
|
#define DEBUG_TREAP TRUE
|
|
#else
|
|
#undef DEBUG_TREAP
|
|
#endif
|
|
|
|
|
|
/* Function type for the object compare
|
|
* return -1 for less
|
|
* 1 for more
|
|
* 0 for equal
|
|
*/
|
|
typedef SDWORD (*TREAP_CMP)(UDWORD key1, UDWORD key2);
|
|
|
|
|
|
/* The basic elements in the treap node.
|
|
* These are done as macros so that the memory system
|
|
* can use parts of the treap system.
|
|
*/
|
|
#define TREAP_NODE_BASE \
|
|
UDWORD key; /* The key to sort the node on */ \
|
|
UDWORD priority; /* Treap priority */ \
|
|
void *pObj; /* The object stored in the treap */ \
|
|
struct _treap_node *psLeft, *psRight /* The sub trees */
|
|
|
|
/* The debug info */
|
|
#define TREAP_NODE_DEBUG \
|
|
STRING *pFile; /* file the node was created in */ \
|
|
SDWORD line /* line the node was created at */
|
|
|
|
typedef struct _treap_node
|
|
{
|
|
TREAP_NODE_BASE;
|
|
|
|
#if DEBUG_TREAP
|
|
TREAP_NODE_DEBUG;
|
|
#endif
|
|
|
|
} TREAP_NODE;
|
|
|
|
/* Treap data structure */
|
|
typedef struct _treap
|
|
{
|
|
TREAP_CMP cmp; // comparison function
|
|
OBJ_HEAP *psNodes; // node heap
|
|
TREAP_NODE *psRoot; // root of the tree
|
|
|
|
#if DEBUG_TREAP
|
|
STRING *pFile; // file the treap was created in
|
|
SDWORD line; // line the treap was created at
|
|
#endif
|
|
} TREAP;
|
|
|
|
/****************************************************************************************/
|
|
/* Function Protoypes */
|
|
/* */
|
|
/* These should not be called directly - use the macros below */
|
|
|
|
|
|
/* Store the location in C code at which a call to the heap was made */
|
|
extern void treapSetCallPos(STRING *pFileName, SDWORD lineNumber);
|
|
|
|
/* Function type for object equality */
|
|
//typedef BOOL (*TREAP_EQUAL)(void *pObj1, void *pObj2);
|
|
|
|
/* Function to create a treap
|
|
* Pass in key comparison function
|
|
* Initial number of nodes to allocate
|
|
* Number of additional nodes to allocate when extending
|
|
*/
|
|
extern BOOL treapCreate(TREAP **ppsTreap, TREAP_CMP cmp, UDWORD init, UDWORD ext);
|
|
|
|
/* Add an object to a treap
|
|
*/
|
|
extern BOOL treapAdd(TREAP *psTreap, UDWORD key, void *pObj);
|
|
|
|
/* Remove an object from the treap */
|
|
extern BOOL treapDel(TREAP *psTreap, UDWORD key);
|
|
|
|
/* Find an object in a treap */
|
|
extern void *treapFind(TREAP *psTreap, UDWORD key);
|
|
|
|
/* Release all the nodes in the treap */
|
|
extern void treapReset(TREAP *psTreap);
|
|
|
|
/* Destroy a treap and release all the memory associated with it */
|
|
extern void treapDestroy(TREAP *psTreap);
|
|
|
|
/* Display the treap structure using DBPRINTF */
|
|
extern void treapDisplay(TREAP *psTreap);
|
|
|
|
/* Return the object with the smallest key in the treap
|
|
* This is useful if the objects in the treap need to be
|
|
* deallocated. i.e. getSmallest, delete from treap, free memory
|
|
*/
|
|
extern void *treapGetSmallest(TREAP *psTreap);
|
|
|
|
/****************************************************************************************/
|
|
/* Comparison Functions */
|
|
|
|
/* A useful comparison function - keys are string pointers */
|
|
extern SDWORD treapStringCmp(UDWORD key1, UDWORD key2);
|
|
|
|
/****************************************************************************************/
|
|
/* Macro definitions */
|
|
|
|
#if DEBUG_TREAP
|
|
|
|
// debugging versions of the TREAP calls
|
|
#define TREAP_CREATE(ppsTreap, cmp, init, ext) \
|
|
(treapSetCallPos(__FILE__, __LINE__), \
|
|
treapCreate(ppsTreap, cmp, init, ext))
|
|
|
|
#define TREAP_ADD(psTreap, key, pObject) \
|
|
(treapSetCallPos(__FILE__, __LINE__), \
|
|
treapAdd(psTreap, key, pObject))
|
|
|
|
#define TREAP_DEL(psTreap, key) \
|
|
treapDel(psTreap, key)
|
|
|
|
#define TREAP_FIND(psTreap, key) \
|
|
treapFind(psTreap, key)
|
|
|
|
#define TREAP_RESET(psTreap) \
|
|
treapReset(psTreap)
|
|
|
|
#define TREAP_DESTROY(psTreap) \
|
|
treapDestroy(psTreap)
|
|
|
|
#define TREAP_DISPLAY(psTreap) \
|
|
treapDisplay(psTreap)
|
|
|
|
#define TREAP_GETSMALLEST(psTreap) \
|
|
treapGetSmallest(psTreap)
|
|
|
|
#else
|
|
|
|
// release versions of the TREAP calls
|
|
#define TREAP_CREATE(ppsTreap, cmp, init, ext) \
|
|
treapCreate(ppsTreap, cmp, init, ext)
|
|
|
|
#define TREAP_ADD(psTreap, key, pObject) \
|
|
treapAdd(psTreap, key, pObject)
|
|
|
|
#define TREAP_DEL(psTreap, key) \
|
|
treapDel(psTreap, key)
|
|
|
|
#define TREAP_FIND(psTreap, key) \
|
|
treapFind(psTreap, key)
|
|
|
|
#define TREAP_RESET(psTreap) \
|
|
treapReset(psTreap)
|
|
|
|
#define TREAP_DESTROY(psTreap) \
|
|
treapDestroy(psTreap)
|
|
|
|
#define TREAP_DISPLAY(psTreap)
|
|
|
|
#define TREAP_GETSMALLEST(psTreap) \
|
|
treapGetSmallest(psTreap)
|
|
|
|
#endif
|
|
|
|
|
|
#endif
|