218 lines
4.6 KiB
C
218 lines
4.6 KiB
C
/* Abstract AVL Tree Generic C Package.
|
|
** Interface generation header file.
|
|
**
|
|
** This code is in the public domain. See cavl_tree.html for interface
|
|
** documentation.
|
|
**
|
|
** Version: 1.5 Author: Walt Karas
|
|
*/
|
|
|
|
/* This header contains the definition of CHAR_BIT (number of bits in a
|
|
** char). */
|
|
#include <limits.h>
|
|
|
|
#undef L__
|
|
#undef L__EST_LONG_BIT
|
|
#undef L__SIZE
|
|
#undef L__SC
|
|
#undef L__LONG_BIT
|
|
#undef L__BIT_ARR_DEFN
|
|
|
|
#ifndef AVL_SEARCH_TYPE_DEFINED_
|
|
#define AVL_SEARCH_TYPE_DEFINED_
|
|
|
|
typedef enum
|
|
{
|
|
AVL_EQUAL = 1,
|
|
AVL_LESS = 2,
|
|
AVL_GREATER = 4,
|
|
AVL_LESS_EQUAL = AVL_EQUAL | AVL_LESS,
|
|
AVL_GREATER_EQUAL = AVL_EQUAL | AVL_GREATER
|
|
}
|
|
avl_search_type;
|
|
|
|
#endif
|
|
|
|
#ifdef AVL_UNIQUE
|
|
|
|
#define L__ AVL_UNIQUE
|
|
|
|
#else
|
|
|
|
#define L__(X) X
|
|
|
|
#endif
|
|
|
|
/* Determine storage class for function prototypes. */
|
|
#ifdef AVL_PRIVATE
|
|
|
|
#define L__SC static
|
|
|
|
#else
|
|
|
|
#define L__SC extern
|
|
|
|
#endif
|
|
|
|
#ifdef AVL_SIZE
|
|
|
|
#define L__SIZE AVL_SIZE
|
|
|
|
#else
|
|
|
|
#define L__SIZE unsigned long
|
|
|
|
#endif
|
|
|
|
typedef struct
|
|
{
|
|
#ifdef AVL_INSIDE_STRUCT
|
|
|
|
AVL_INSIDE_STRUCT
|
|
|
|
#endif
|
|
|
|
AVL_HANDLE root;
|
|
}
|
|
L__(avl);
|
|
|
|
/* Function prototypes. */
|
|
|
|
L__SC void L__(init)(L__(avl) *tree);
|
|
|
|
L__SC int L__(is_empty)(L__(avl) *tree);
|
|
|
|
L__SC AVL_HANDLE L__(insert)(L__(avl) *tree, AVL_HANDLE h);
|
|
|
|
L__SC AVL_HANDLE L__(search)(L__(avl) *tree, AVL_KEY k, avl_search_type st);
|
|
|
|
L__SC AVL_HANDLE L__(search_least)(L__(avl) *tree);
|
|
|
|
L__SC AVL_HANDLE L__(search_greatest)(L__(avl) *tree);
|
|
|
|
L__SC AVL_HANDLE L__(search_root)(L__(avl) *tree);
|
|
|
|
L__SC AVL_HANDLE L__(remove)(L__(avl) *tree, AVL_KEY k);
|
|
|
|
L__SC AVL_HANDLE L__(subst)(L__(avl) *tree, AVL_HANDLE new_node);
|
|
|
|
#ifdef AVL_BUILD_ITER_TYPE
|
|
|
|
L__SC int L__(build)(
|
|
L__(avl) *tree, AVL_BUILD_ITER_TYPE p, L__SIZE num_nodes);
|
|
|
|
#endif
|
|
|
|
/* ANSI C/ISO C++ require that a long have at least 32 bits. Set
|
|
** L__EST_LONG_BIT to be the greatest multiple of 8 in the range
|
|
** 32 - 64 (inclusive) that is less than or equal to the number of
|
|
** bits in a long.
|
|
*/
|
|
|
|
#if (((LONG_MAX >> 31) >> 7) == 0)
|
|
|
|
#define L__EST_LONG_BIT 32
|
|
|
|
#elif (((LONG_MAX >> 31) >> 15) == 0)
|
|
|
|
#define L__EST_LONG_BIT 40
|
|
|
|
#elif (((LONG_MAX >> 31) >> 23) == 0)
|
|
|
|
#define L__EST_LONG_BIT 48
|
|
|
|
#elif (((LONG_MAX >> 31) >> 31) == 0)
|
|
|
|
#define L__EST_LONG_BIT 56
|
|
|
|
#else
|
|
|
|
#define L__EST_LONG_BIT 64
|
|
|
|
#endif
|
|
|
|
/* Number of bits in a long. */
|
|
#define L__LONG_BIT (sizeof(long) * CHAR_BIT)
|
|
|
|
/* The macro L__BIT_ARR_DEFN defines a bit array whose index is a (0-based)
|
|
** node depth. The definition depends on whether the maximum depth is more
|
|
** or less than the number of bits in a single long.
|
|
*/
|
|
|
|
#if ((AVL_MAX_DEPTH) > L__EST_LONG_BIT)
|
|
|
|
/* Maximum depth may be more than number of bits in a long. */
|
|
|
|
#define L__BIT_ARR_DEFN(NAME) \
|
|
unsigned long NAME[((AVL_MAX_DEPTH) + L__LONG_BIT - 1) / L__LONG_BIT];
|
|
|
|
#else
|
|
|
|
/* Maximum depth is definitely less than number of bits in a long. */
|
|
|
|
#define L__BIT_ARR_DEFN(NAME) unsigned long NAME;
|
|
|
|
#endif
|
|
|
|
/* Iterator structure. */
|
|
typedef struct
|
|
{
|
|
/* Tree being iterated over. */
|
|
L__(avl) *tree_;
|
|
|
|
/* Records a path into the tree. If bit n is true, indicates
|
|
** take greater branch from the nth node in the path, otherwise
|
|
** take the less branch. bit 0 gives branch from root, and
|
|
** so on. */
|
|
L__BIT_ARR_DEFN(branch)
|
|
|
|
/* Zero-based depth of path into tree. */
|
|
int depth;
|
|
|
|
/* Handles of nodes in path from root to current node (returned by *). */
|
|
AVL_HANDLE path_h[(AVL_MAX_DEPTH) - 1];
|
|
}
|
|
L__(iter);
|
|
|
|
/* Iterator function prototypes. */
|
|
|
|
L__SC void L__(start_iter)(
|
|
L__(avl) *tree, L__(iter) *iter, AVL_KEY k, avl_search_type st);
|
|
|
|
L__SC void L__(start_iter_least)(L__(avl) *tree, L__(iter) *iter);
|
|
|
|
L__SC void L__(start_iter_greatest)(L__(avl) *tree, L__(iter) *iter);
|
|
|
|
L__SC AVL_HANDLE L__(get_iter)(L__(iter) *iter);
|
|
|
|
L__SC void L__(incr_iter)(L__(iter) *iter);
|
|
|
|
L__SC void L__(decr_iter)(L__(iter) *iter);
|
|
|
|
L__SC void L__(init_iter)(L__(iter) *iter);
|
|
|
|
#define AVL_IMPL_INIT 1
|
|
#define AVL_IMPL_IS_EMPTY (1 << 1)
|
|
#define AVL_IMPL_INSERT (1 << 2)
|
|
#define AVL_IMPL_SEARCH (1 << 3)
|
|
#define AVL_IMPL_SEARCH_LEAST (1 << 4)
|
|
#define AVL_IMPL_SEARCH_GREATEST (1 << 5)
|
|
#define AVL_IMPL_REMOVE (1 << 6)
|
|
#define AVL_IMPL_BUILD (1 << 7)
|
|
#define AVL_IMPL_START_ITER (1 << 8)
|
|
#define AVL_IMPL_START_ITER_LEAST (1 << 9)
|
|
#define AVL_IMPL_START_ITER_GREATEST (1 << 10)
|
|
#define AVL_IMPL_GET_ITER (1 << 11)
|
|
#define AVL_IMPL_INCR_ITER (1 << 12)
|
|
#define AVL_IMPL_DECR_ITER (1 << 13)
|
|
#define AVL_IMPL_INIT_ITER (1 << 14)
|
|
#define AVL_IMPL_SUBST (1 << 15)
|
|
|
|
#define AVL_IMPL_ALL (~0)
|
|
|
|
#undef L__
|
|
#undef L__EST_LONG_BIT
|
|
#undef L__SIZE
|
|
#undef L__SC
|
|
#undef L__LONG_BIT
|
|
#undef L__BIT_ARR_DEFN
|