lib/gl_avltree_list.c

   1 /* Sequential list data type implemented by a binary tree.
   2    Copyright (C) 2006 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 2, or (at your option)
   8    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, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 /* Specification.  */
  24 #include "gl_avltree_list.h"
  25
  26 #include <stdlib.h>
  27
  28 #include "xalloc.h"
  29
  30 /* -------------------------- gl_list_t Data Type -------------------------- */
  31
  32 /* Generic AVL tree code.  */
  33 #include "gl_anyavltree_list1.h"
  34 #include "gl_anyavltree_list2.h"
  35
  36 /* Generic binary tree code.  */
  37 #include "gl_anytree_list1.h"
  38 #include "gl_anytree_list2.h"
  39
  40 /* For debugging.  */
  41 static unsigned int
  42 check_invariants (gl_list_node_t node, gl_list_node_t parent)
  43 {
  44   unsigned int left_height =
  45     (node->left != NULL ? check_invariants (node->left, node) : 0);
  46   unsigned int right_height =
  47     (node->right != NULL ? check_invariants (node->right, node) : 0);
  48   int balance = (int)right_height - (int)left_height;
  49
  50   if (!(node->parent == parent))
  51     abort ();
  52   if (!(node->branch_size
  53         == (node->left != NULL ? node->left->branch_size : 0)
  54            + 1 + (node->right != NULL ? node->right->branch_size : 0)))
  55     abort ();
  56   if (!(balance >= -1 && balance <= 1))
  57     abort ();
  58   if (!(node->balance == balance))
  59     abort ();
  60
  61   return 1 + (left_height > right_height ? left_height : right_height);
  62 }
  63 void
  64 gl_avltree_list_check_invariants (gl_list_t list)
  65 {
  66   if (list->root != NULL)
  67     check_invariants (list->root, NULL);
  68 }
  69
  70 const struct gl_list_implementation gl_avltree_list_implementation =
  71   {
  72     gl_tree_create_empty,
  73     gl_tree_create,
  74     gl_tree_size,
  75     gl_tree_node_value,
  76     gl_tree_next_node,
  77     gl_tree_previous_node,
  78     gl_tree_get_at,
  79     gl_tree_set_at,
  80     gl_tree_search,
  81     gl_tree_indexof,
  82     gl_tree_add_first,
  83     gl_tree_add_last,
  84     gl_tree_add_before,
  85     gl_tree_add_after,
  86     gl_tree_add_at,
  87     gl_tree_remove_node,
  88     gl_tree_remove_at,
  89     gl_tree_remove,
  90     gl_tree_list_free,
  91     gl_tree_iterator,
  92     gl_tree_iterator_from_to,
  93     gl_tree_iterator_next,
  94     gl_tree_iterator_free,
  95     gl_tree_sortedlist_search,
  96     gl_tree_sortedlist_indexof,
  97     gl_tree_sortedlist_add,
  98     gl_tree_sortedlist_remove
  99   };