1 /* Produced by texiweb from libavl.w. */ 2 /* *INDENT-OFF* */ 3 4 /* libavl - library for manipulation of binary trees. 5 Copyright (C) 1998-2002, 2004 Free Software Foundation, Inc. 6 7 This program is free software; you can redistribute it and/or 8 modify it under the terms of the GNU General Public License as 9 published by the Free Software Foundation; either version 2 of the 10 License, or (at your option) any later version. 11 12 This program is distributed in the hope that it will be useful, but 13 WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 15 See the GNU General Public License for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with this program; if not, write to the Free Software 19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 20 02111-1307, USA. 21 22 The author may be contacted at <blp@gnu.org> on the Internet, or 23 write to Ben Pfaff, Stanford University, Computer Science Dept., 353 24 Serra Mall, Stanford CA 94305, USA. 25 */ 26 27 #ifndef AVL_H 28 #define AVL_H 1 29 30 #include <stddef.h> 31 32 /* Function types. */ 33 typedef int avl_comparison_func (const void *avl_a, const void *avl_b, 34 void *avl_param); 35 typedef void avl_item_func (void *avl_item, void *avl_param); 36 typedef void *avl_copy_func (void *avl_item, void *avl_param); 37 38 #ifndef LIBAVL_ALLOCATOR 39 #define LIBAVL_ALLOCATOR 40 /* Memory allocator. */ 41 struct libavl_allocator 42 { 43 void *(*libavl_malloc) (struct libavl_allocator *, size_t libavl_size); 44 void (*libavl_free) (struct libavl_allocator *, void *libavl_block); 45 }; 46 #endif 47 48 /* Default memory allocator. */ 49 extern struct libavl_allocator avl_allocator_default; 50 void *avl_malloc (struct libavl_allocator *, size_t); 51 void avl_free (struct libavl_allocator *, void *); 52 53 /* Maximum AVL height. */ 54 #ifndef AVL_MAX_HEIGHT 55 #define AVL_MAX_HEIGHT 32 56 #endif 57 58 /* Tree data structure. */ 59 struct avl_table 60 { 61 struct avl_node *avl_root; /* Tree's root. */ 62 avl_comparison_func *avl_compare; /* Comparison function. */ 63 void *avl_param; /* Extra argument to |avl_compare|. */ 64 struct libavl_allocator *avl_alloc; /* Memory allocator. */ 65 size_t avl_count; /* Number of items in tree. */ 66 unsigned long avl_generation; /* Generation number. */ 67 }; 68 69 /* An AVL tree node. */ 70 struct avl_node 71 { 72 struct avl_node *avl_link[2]; /* Subtrees. */ 73 void *avl_data; /* Pointer to data. */ 74 signed char avl_balance; /* Balance factor. */ 75 }; 76 77 /* AVL traverser structure. */ 78 struct avl_traverser 79 { 80 struct avl_table *avl_table; /* Tree being traversed. */ 81 struct avl_node *avl_node; /* Current node in tree. */ 82 struct avl_node *avl_stack[AVL_MAX_HEIGHT]; 83 /* All the nodes above |avl_node|. */ 84 size_t avl_height; /* Number of nodes in |avl_parent|. */ 85 unsigned long avl_generation; /* Generation number. */ 86 }; 87 88 /* Table functions. */ 89 struct avl_table *avl_create (avl_comparison_func *, void *, 90 struct libavl_allocator *); 91 struct avl_table *avl_copy (const struct avl_table *, avl_copy_func *, 92 avl_item_func *, struct libavl_allocator *); 93 void avl_destroy (struct avl_table *, avl_item_func *); 94 void **avl_probe (struct avl_table *, void *); 95 void *avl_insert (struct avl_table *, void *); 96 void *avl_replace (struct avl_table *, void *); 97 void *avl_delete (struct avl_table *, const void *); 98 void *avl_find (const struct avl_table *, const void *); 99 void avl_assert_insert (struct avl_table *, void *); 100 void *avl_assert_delete (struct avl_table *, void *); 101 102 #define avl_count(table) ((size_t) (table)->avl_count) 103 104 /* Table traverser functions. */ 105 void avl_t_init (struct avl_traverser *, struct avl_table *); 106 void *avl_t_first (struct avl_traverser *, struct avl_table *); 107 void *avl_t_last (struct avl_traverser *, struct avl_table *); 108 void *avl_t_find (struct avl_traverser *, struct avl_table *, void *); 109 void *avl_t_insert (struct avl_traverser *, struct avl_table *, void *); 110 void *avl_t_copy (struct avl_traverser *, const struct avl_traverser *); 111 void *avl_t_next (struct avl_traverser *); 112 void *avl_t_prev (struct avl_traverser *); 113 void *avl_t_cur (struct avl_traverser *); 114 void *avl_t_replace (struct avl_traverser *, void *); 115 116 #endif /* avl.h */ 117 /* *INDENT-ON* */ 118