e584702c5b47d9f85ed13025e1115c62ae3063ec
[gnulib.git] / lib / gl_rbtree_list.c
1 /* Sequential list data type implemented by a binary tree.
2    Copyright (C) 2006, 2008 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 <http://www.gnu.org/licenses/>.  */
17
18 #include <config.h>
19
20 /* Specification.  */
21 #include "gl_rbtree_list.h"
22
23 #include <stdlib.h>
24
25 #include "xalloc.h"
26
27 /* -------------------------- gl_list_t Data Type -------------------------- */
28
29 /* Generic red-black tree code.  */
30 #include "gl_anyrbtree_list1.h"
31 #include "gl_anyrbtree_list2.h"
32
33 /* Generic binary tree code.  */
34 #include "gl_anytree_list1.h"
35 #include "gl_anytree_list2.h"
36
37 /* For debugging.  */
38 static unsigned int
39 check_invariants (gl_list_node_t node, gl_list_node_t parent)
40 {
41   unsigned int left_blackheight =
42     (node->left != NULL ? check_invariants (node->left, node) : 0);
43   unsigned int right_blackheight =
44     (node->right != NULL ? check_invariants (node->right, node) : 0);
45
46   if (!(node->parent == parent))
47     abort ();
48   if (!(node->branch_size
49         == (node->left != NULL ? node->left->branch_size : 0)
50            + 1 + (node->right != NULL ? node->right->branch_size : 0)))
51     abort ();
52   if (!(node->color == BLACK || node->color == RED))
53     abort ();
54   if (parent == NULL && !(node->color == BLACK))
55     abort ();
56   if (!(left_blackheight == right_blackheight))
57     abort ();
58
59   return left_blackheight + (node->color == BLACK ? 1 : 0);
60 }
61 void
62 gl_rbtree_list_check_invariants (gl_list_t list)
63 {
64   if (list->root != NULL)
65     check_invariants (list->root, NULL);
66 }
67
68 const struct gl_list_implementation gl_rbtree_list_implementation =
69   {
70     gl_tree_create_empty,
71     gl_tree_create,
72     gl_tree_size,
73     gl_tree_node_value,
74     gl_tree_node_set_value,
75     gl_tree_next_node,
76     gl_tree_previous_node,
77     gl_tree_get_at,
78     gl_tree_set_at,
79     gl_tree_search_from_to,
80     gl_tree_indexof_from_to,
81     gl_tree_add_first,
82     gl_tree_add_last,
83     gl_tree_add_before,
84     gl_tree_add_after,
85     gl_tree_add_at,
86     gl_tree_remove_node,
87     gl_tree_remove_at,
88     gl_tree_remove,
89     gl_tree_list_free,
90     gl_tree_iterator,
91     gl_tree_iterator_from_to,
92     gl_tree_iterator_next,
93     gl_tree_iterator_free,
94     gl_tree_sortedlist_search,
95     gl_tree_sortedlist_search_from_to,
96     gl_tree_sortedlist_indexof,
97     gl_tree_sortedlist_indexof_from_to,
98     gl_tree_sortedlist_add,
99     gl_tree_sortedlist_remove
100   };