source: trunk/src/emx/include/splay-tree.h@ 2375

Last change on this file since 2375 was 1506, checked in by bird, 21 years ago

@unixroot. header reviews. ++
  • Property cvs2svn:cvs-rev set to 1.2
  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 5.6 KB
Line 
1/* splay-tree.h,v 1.2 2004/09/14 22:27:35 bird Exp */
2/** @file
3 * GNU, -liberty.
4 */
5/* A splay-tree datatype.
6 Copyright 1998, 1999, 2000 Free Software Foundation, Inc.
7 Contributed by Mark Mitchell (mark@markmitchell.com).
8
9This file is part of GCC.
10
11GCC is free software; you can redistribute it and/or modify it
12under the terms of the GNU General Public License as published by
13the Free Software Foundation; either version 2, or (at your option)
14any later version.
15
16GCC is distributed in the hope that it will be useful, but
17WITHOUT ANY WARRANTY; without even the implied warranty of
18MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19General Public License for more details.
20
21You should have received a copy of the GNU General Public License
22along with GCC; see the file COPYING. If not, write to
23the Free Software Foundation, 59 Temple Place - Suite 330,
24Boston, MA 02111-1307, USA. */
25
26/* For an easily readable description of splay-trees, see:
27
28 Lewis, Harry R. and Denenberg, Larry. Data Structures and Their
29 Algorithms. Harper-Collins, Inc. 1991.
30
31 The major feature of splay trees is that all basic tree operations
32 are amortized O(log n) time for a tree with n nodes. */
33
34#ifndef _SPLAY_TREE_H
35#define _SPLAY_TREE_H
36
37#ifdef __cplusplus
38extern "C" {
39#endif /* __cplusplus */
40
41#include <ansidecl.h>
42
43/* Use typedefs for the key and data types to facilitate changing
44 these types, if necessary. These types should be sufficiently wide
45 that any pointer or scalar can be cast to these types, and then
46 cast back, without loss of precision. */
47typedef unsigned long int splay_tree_key;
48typedef unsigned long int splay_tree_value;
49
50/* Forward declaration for a node in the tree. */
51typedef struct splay_tree_node_s *splay_tree_node;
52
53/* The type of a function which compares two splay-tree keys. The
54 function should return values as for qsort. */
55typedef int (*splay_tree_compare_fn) PARAMS((splay_tree_key, splay_tree_key));
56
57/* The type of a function used to deallocate any resources associated
58 with the key. */
59typedef void (*splay_tree_delete_key_fn) PARAMS((splay_tree_key));
60
61/* The type of a function used to deallocate any resources associated
62 with the value. */
63typedef void (*splay_tree_delete_value_fn) PARAMS((splay_tree_value));
64
65/* The type of a function used to iterate over the tree. */
66typedef int (*splay_tree_foreach_fn) PARAMS((splay_tree_node, void*));
67
68/* The type of a function used to allocate memory for tree root and
69 node structures. The first argument is the number of bytes needed;
70 the second is a data pointer the splay tree functions pass through
71 to the allocator. This function must never return zero. */
72typedef void *(*splay_tree_allocate_fn) PARAMS((int, void *));
73
74/* The type of a function used to free memory allocated using the
75 corresponding splay_tree_allocate_fn. The first argument is the
76 memory to be freed; the latter is a data pointer the splay tree
77 functions pass through to the freer. */
78typedef void (*splay_tree_deallocate_fn) PARAMS((void *, void *));
79
80/* The nodes in the splay tree. */
81struct splay_tree_node_s
82{
83 /* The key. */
84 splay_tree_key key;
85
86 /* The value. */
87 splay_tree_value value;
88
89 /* The left and right children, respectively. */
90 splay_tree_node left;
91 splay_tree_node right;
92};
93
94/* The splay tree itself. */
95typedef struct splay_tree_s
96{
97 /* The root of the tree. */
98 splay_tree_node root;
99
100 /* The comparision function. */
101 splay_tree_compare_fn comp;
102
103 /* The deallocate-key function. NULL if no cleanup is necessary. */
104 splay_tree_delete_key_fn delete_key;
105
106 /* The deallocate-value function. NULL if no cleanup is necessary. */
107 splay_tree_delete_value_fn delete_value;
108
109 /* Allocate/free functions, and a data pointer to pass to them. */
110 splay_tree_allocate_fn allocate;
111 splay_tree_deallocate_fn deallocate;
112 void *allocate_data;
113
114} *splay_tree;
115
116extern splay_tree splay_tree_new PARAMS((splay_tree_compare_fn,
117 splay_tree_delete_key_fn,
118 splay_tree_delete_value_fn));
119extern splay_tree splay_tree_new_with_allocator
120 PARAMS((splay_tree_compare_fn,
121 splay_tree_delete_key_fn,
122 splay_tree_delete_value_fn,
123 splay_tree_allocate_fn,
124 splay_tree_deallocate_fn,
125 void *));
126extern void splay_tree_delete PARAMS((splay_tree));
127extern splay_tree_node splay_tree_insert
128 PARAMS((splay_tree,
129 splay_tree_key,
130 splay_tree_value));
131extern void splay_tree_remove PARAMS((splay_tree,
132 splay_tree_key));
133extern splay_tree_node splay_tree_lookup
134 PARAMS((splay_tree,
135 splay_tree_key));
136extern splay_tree_node splay_tree_predecessor
137 PARAMS((splay_tree,
138 splay_tree_key));
139extern splay_tree_node splay_tree_successor
140 PARAMS((splay_tree,
141 splay_tree_key));
142extern splay_tree_node splay_tree_max
143 PARAMS((splay_tree));
144extern splay_tree_node splay_tree_min
145 PARAMS((splay_tree));
146extern int splay_tree_foreach PARAMS((splay_tree,
147 splay_tree_foreach_fn,
148 void*));
149extern int splay_tree_compare_ints PARAMS((splay_tree_key,
150 splay_tree_key));
151extern int splay_tree_compare_pointers PARAMS((splay_tree_key,
152 splay_tree_key));
153
154#ifdef __cplusplus
155}
156#endif /* __cplusplus */
157
158#endif /* _SPLAY_TREE_H */
Note: See TracBrowser for help on using the repository browser.