lib/gl_avltreehash_list.c

   1 /* Sequential list data type implemented by a hash table with a binary tree.
   2    Copyright (C) 2006, 2008-2019 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #include <config.h>
  19
  20 /* Specification.  */
  21 #include "gl_avltreehash_list.h"
  22
  23 #include <stdint.h> /* for SIZE_MAX */
  24 #include <stdlib.h>
  25
  26 #include "gl_avltree_oset.h"
  27 #include "xsize.h"
  28
  29 #ifndef uintptr_t
  30 # define uintptr_t unsigned long
  31 #endif
  32
  33 #define WITH_HASHTABLE 1
  34
  35 /* Which kind of binary trees to use for ordered sets.  Quite arbitrary.  */
  36 #define OSET_TREE_FLAVOR GL_AVLTREE_OSET
  37
  38 /* -------------------------- gl_list_t Data Type -------------------------- */
  39
  40 /* Generic hash-table code: Type definitions.  */
  41 #include "gl_anyhash1.h"
  42
  43 /* Generic AVL tree code: Type definitions.  */
  44 #include "gl_anyavltree_list1.h"
  45
  46 /* Generic hash-table code: Low-level code.  */
  47 #define CONTAINER_T gl_list_t
  48 #define CONTAINER_COUNT(list) \
  49   ((list)->root != NULL ? (list)->root->branch_size : 0)
  50 #include "gl_anyhash2.h"
  51
  52 /* Generic binary tree code: Type definitions.  */
  53 #include "gl_anytree_list1.h"
  54
  55 /* Hash-table with binary tree code: Handling of hash buckets.  */
  56 #include "gl_anytreehash_list1.h"
  57
  58 /* Generic AVL tree code: Insertion/deletion algorithms.  */
  59 #include "gl_anyavltree_list2.h"
  60
  61 /* Generic binary tree code: Functions taking advantage of the hash table.  */
  62 #include "gl_anytreehash_list2.h"
  63
  64 /* Generic binary tree code: All other functions.  */
  65 #include "gl_anytree_list2.h"
  66
  67 /* For debugging.  */
  68 static unsigned int
  69 check_invariants (gl_list_node_t node, gl_list_node_t parent)
  70 {
  71   unsigned int left_height =
  72     (node->left != NULL ? check_invariants (node->left, node) : 0);
  73   unsigned int right_height =
  74     (node->right != NULL ? check_invariants (node->right, node) : 0);
  75   int balance = (int)right_height - (int)left_height;
  76
  77   if (!(node->parent == parent))
  78     abort ();
  79   if (!(node->branch_size
  80         == (node->left != NULL ? node->left->branch_size : 0)
  81            + 1 + (node->right != NULL ? node->right->branch_size : 0)))
  82     abort ();
  83   if (!(balance >= -1 && balance <= 1))
  84     abort ();
  85   if (!(node->balance == balance))
  86     abort ();
  87
  88   return 1 + (left_height > right_height ? left_height : right_height);
  89 }
  90 void
  91 gl_avltreehash_list_check_invariants (gl_list_t list)
  92 {
  93   if (list->root != NULL)
  94     check_invariants (list->root, NULL);
  95 }
  96
  97
  98 const struct gl_list_implementation gl_avltreehash_list_implementation =
  99   {
 100     gl_tree_nx_create_empty,
 101     gl_tree_nx_create,
 102     gl_tree_size,
 103     gl_tree_node_value,
 104     gl_tree_node_nx_set_value,
 105     gl_tree_next_node,
 106     gl_tree_previous_node,
 107     gl_tree_get_at,
 108     gl_tree_nx_set_at,
 109     gl_tree_search_from_to,
 110     gl_tree_indexof_from_to,
 111     gl_tree_nx_add_first,
 112     gl_tree_nx_add_last,
 113     gl_tree_nx_add_before,
 114     gl_tree_nx_add_after,
 115     gl_tree_nx_add_at,
 116     gl_tree_remove_node,
 117     gl_tree_remove_at,
 118     gl_tree_remove,
 119     gl_tree_list_free,
 120     gl_tree_iterator,
 121     gl_tree_iterator_from_to,
 122     gl_tree_iterator_next,
 123     gl_tree_iterator_free,
 124     gl_tree_sortedlist_search,
 125     gl_tree_sortedlist_search_from_to,
 126     gl_tree_sortedlist_indexof,
 127     gl_tree_sortedlist_indexof_from_to,
 128     gl_tree_sortedlist_nx_add,
 129     gl_tree_sortedlist_remove
 130   };