d38e383d964f220074cf10e0c72c3595cbad3c0c
[samba.git] / source3 / ubi_SplayTree.c
1 /* ========================================================================== **
2  *                              ubi_SplayTree.c
3  *
4  *  Copyright (C) 1993-1995 by Christopher R. Hertel
5  *
6  *  Email: crh@ubiqx.mn.org
7  * -------------------------------------------------------------------------- **
8  *
9  *  This module implements "splay" trees.  Splay trees are binary trees
10  *  that are rearranged (splayed) whenever a node is accessed.  The
11  *  splaying process *tends* to make the tree bushier (improves balance),
12  *  and the nodes that are accessed most frequently *tend* to be closer to
13  *  the top.
14  *
15  *  References: "Self-Adjusting Binary Search Trees", by Daniel Sleator and
16  *              Robert Tarjan.  Journal of the Association for Computing
17  *              Machinery Vol 32, No. 3, July 1985 pp. 652-686
18  *
19  * -------------------------------------------------------------------------- **
20  *
21  *  This library is free software; you can redistribute it and/or
22  *  modify it under the terms of the GNU Library General Public
23  *  License as published by the Free Software Foundation; either
24  *  version 2 of the License, or (at your option) any later version.
25  *
26  *  This library is distributed in the hope that it will be useful,
27  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
28  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
29  *  Library General Public License for more details.
30  *
31  *  You should have received a copy of the GNU Library General Public
32  *  License along with this library; if not, write to the Free
33  *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
34  *
35  * -------------------------------------------------------------------------- **
36  *
37  * $Log: ubi_SplayTree.c,v $
38  * Revision 1.1  1997/10/09 04:09:54  crh
39  * This is my library of lists and trees.  My hope is to replace all of the
40  * hard coded linked lists that are currently used in Samba with calls to
41  * these modules.  This should make the code simpler, smaller, and (I hope)
42  * faster.  The tree code, in particular, should speed up processing where
43  * large lists are involved.
44  *
45  * Chris -)-----
46  *
47  * Revision 2.5  1997/07/26 04:15:42  crh
48  * + Cleaned up a few minor syntax annoyances that gcc discovered for me.
49  * + Changed ubi_TRUE and ubi_FALSE to ubi_trTRUE and ubi_trFALSE.
50  *
51  * Revision 2.4  1997/06/03 04:42:21  crh
52  * Changed TRUE and FALSE to ubi_TRUE and ubi_FALSE to avoid causing
53  * problems.
54  *
55  * Revision 2.3  1995/10/03 22:19:07  CRH
56  * Ubisized!
57  * Also, added the function ubi_sptSplay().
58  *
59  * Revision 2.1  95/03/09  23:54:42  CRH
60  * Added the ModuleID static string and function.  These modules are now
61  * self-identifying.
62  * 
63  * Revision 2.0  95/02/27  22:34:46  CRH
64  * This module was updated to match the interface changes made to the
65  * ubi_BinTree module.  In particular, the interface to the Locate() function
66  * has changed.  See ubi_BinTree for more information on changes and new
67  * functions.
68  *
69  * The revision number was also upped to match ubi_BinTree.
70  *
71  * Revision 1.1  93/10/18  20:35:16  CRH
72  * I removed the hard-coded logical device names from the include file
73  * specifications.  CRH
74  *
75  * Revision 1.0  93/10/15  23:00:15  CRH
76  * With this revision, I have added a set of #define's that provide a single,
77  * standard API to all existing tree modules.  Until now, each of the three
78  * existing modules had a different function and typedef prefix, as follows:
79  *
80  *       Module        Prefix
81  *     ubi_BinTree     ubi_bt
82  *     ubi_AVLtree     ubi_avl
83  *     ubi_SplayTree   ubi_spt
84  *
85  * To further complicate matters, only those portions of the base module
86  * (ubi_BinTree) that were superceeded in the new module had the new names.
87  * For example, if you were using ubi_AVLtree, the AVL node structure was
88  * named "ubi_avlNode", but the root structure was still "ubi_btRoot".  Using
89  * SplayTree, the locate function was called "ubi_sptLocate", but the next
90  * and previous functions remained "ubi_btNext" and "ubi_btPrev".
91  *
92  * This was not too terrible if you were familiar with the modules and knew
93  * exactly which tree model you wanted to use.  If you wanted to be able to
94  * change modules (for speed comparisons, etc), things could get messy very
95  * quickly.
96  *
97  * So, I have added a set of defined names that get redefined in any of the
98  * descendant modules.  To use this standardized interface in your code,
99  * simply replace all occurances of "ubi_bt", "ubi_avl", and "ubi_spt" with
100  * "ubi_tr".  The "ubi_tr" names will resolve to the correct function or
101  * datatype names for the module that you are using.  Just remember to
102  * include the header for that module in your program file.  Because these
103  * names are handled by the preprocessor, there is no added run-time
104  * overhead.
105  *
106  * Note that the original names do still exist, and can be used if you wish
107  * to write code directly to a specific module.  This should probably only be
108  * done if you are planning to implement a new descendant type, such as
109  * red/black trees.  CRH
110  *
111  * Revision 0.1  93/04/25  22:03:32  CRH
112  * Simply changed the <exec/types.h> #include reference the .c file to
113  * use <stdlib.h> instead.  The latter is portable, the former is not.
114  *
115  * Revision 0.0  93/04/21  23:05:52  CRH
116  * Initial version, written by Christopher R. Hertel.
117  * This module implements Splay Trees using the ubi_BinTree module as a basis.
118  *
119  * ========================================================================== **
120  */
121
122 #include <stdlib.h>        /* Defines NULL for us.                */
123 #include "ubi_SplayTree.h" /* Header for THIS module.             */
124
125 /* ========================================================================== **
126  * Static data.
127  */
128
129 static char ModuleID[] = "ubi_SplayTree\n\
130 \t$Revision: 1.1 $\n\
131 \t$Date: 1997/10/09 04:09:54 $\n\
132 \t$Author: crh $\n";
133
134
135 /* ========================================================================== **
136  * Private functions...
137  */
138
139 static void Rotate( ubi_btNodePtr p )
140   /* ------------------------------------------------------------------------ **
141    * This function performs a single rotation, moving node *p up one level
142    * in the tree.
143    *
144    *  Input:    p - a pointer to an ubi_btNode in a tree.
145    *
146    *  Output:   None.
147    *
148    *  Notes:    This implements a single rotation in either direction (left
149    *            or right).  This is the basic building block of all splay
150    *            tree rotations.
151    * ------------------------------------------------------------------------ **
152    */
153   {
154   ubi_btNodePtr parentp;
155   ubi_btNodePtr tmp;
156   char          way;
157   char          revway;
158
159   parentp = p->Link[PARENT];    /* Find parent. */
160
161   if( parentp )                 /* If no parent, then we're already the root. */
162     {
163     way     = p->gender;
164     revway  = RevWay(way);
165     tmp     = p->Link[revway];
166
167     parentp->Link[way]  = tmp;
168     if( tmp )
169       {
170       tmp->Link[PARENT] = parentp;
171       tmp->gender       = way;
172       }
173
174     tmp                 = parentp->Link[PARENT];
175     p->Link[PARENT]     = tmp;
176     p->gender           = parentp->gender;
177     if( tmp )
178       tmp->Link[p->gender] = p;
179
180     parentp->Link[PARENT] = p;
181     parentp->gender       = revway;
182     p->Link[revway]       = parentp;
183     }
184   } /* Rotate */
185
186 static ubi_btNodePtr Splay( ubi_btNodePtr SplayWithMe )
187   /* ------------------------------------------------------------------------ **
188    * Move the node indicated by SplayWithMe to the root of the tree by
189    * splaying the tree.
190    *
191    *  Input:  SplayWithMe - A pointer to an ubi_btNode within a tree.
192    *
193    *  Output: A pointer to the root of the splay tree (i.e., the same as
194    *          SplayWithMe).
195    * ------------------------------------------------------------------------ **
196    */
197   {
198   ubi_btNodePtr parent;
199
200   while( (parent = SplayWithMe->Link[PARENT]) )
201     {
202     if( parent->gender == SplayWithMe->gender )       /* Zig-Zig */
203       Rotate( parent );
204     else
205       {
206       if( EQUAL != parent->gender )                   /* Zig-Zag */
207         Rotate( SplayWithMe );
208       }
209     Rotate( SplayWithMe );                            /* Zig */
210     } /* while */
211   return( SplayWithMe );
212   } /* Splay */
213
214 /* ========================================================================== **
215  * Exported utilities.
216  */
217
218 ubi_trBool ubi_sptInsert( ubi_btRootPtr  RootPtr,
219                           ubi_btNodePtr  NewNode,
220                           ubi_btItemPtr  ItemPtr,
221                           ubi_btNodePtr *OldNode )
222   /* ------------------------------------------------------------------------ **
223    * This function uses a non-recursive algorithm to add a new element to the
224    * splay tree.
225    *
226    *  Input:   RootPtr  -  a pointer to the ubi_btRoot structure that indicates
227    *                       the root of the tree to which NewNode is to be added.
228    *           NewNode  -  a pointer to an ubi_btNode structure that is NOT
229    *                       part of any tree.
230    *           ItemPtr  -  A pointer to the sort key that is stored within
231    *                       *NewNode.  ItemPtr MUST point to information stored
232    *                       in *NewNode or an EXACT DUPLICATE.  The key data
233    *                       indicated by ItemPtr is used to place the new node
234    *                       into the tree.
235    *           OldNode  -  a pointer to an ubi_btNodePtr.  When searching
236    *                       the tree, a duplicate node may be found.  If
237    *                       duplicates are allowed, then the new node will
238    *                       be simply placed into the tree.  If duplicates
239    *                       are not allowed, however, then one of two things
240    *                       may happen.
241    *                       1) if overwritting *is not* allowed, this
242    *                          function will return FALSE (indicating that
243    *                          the new node could not be inserted), and
244    *                          *OldNode will point to the duplicate that is
245    *                          still in the tree.
246    *                       2) if overwritting *is* allowed, then this
247    *                          function will swap **OldNode for *NewNode.
248    *                          In this case, *OldNode will point to the node
249    *                          that was removed (thus allowing you to free
250    *                          the node).
251    *                          **  If you are using overwrite mode, ALWAYS  **
252    *                          ** check the return value of this parameter! **
253    *                 Note: You may pass NULL in this parameter, the
254    *                       function knows how to cope.  If you do this,
255    *                       however, there will be no way to return a
256    *                       pointer to an old (ie. replaced) node (which is
257    *                       a problem if you are using overwrite mode).
258    *
259    *  Output:  a boolean value indicating success or failure.  The function
260    *           will return FALSE if the node could not be added to the tree.
261    *           Such failure will only occur if duplicates are not allowed,
262    *           nodes cannot be overwritten, AND a duplicate key was found
263    *           within the tree.
264    * ------------------------------------------------------------------------ **
265    */
266   {
267   ubi_btNodePtr OtherP;
268
269   if( !(OldNode) )
270     OldNode = &OtherP;
271
272   if( ubi_btInsert( RootPtr, NewNode, ItemPtr, OldNode ) )
273     {
274     RootPtr->root = Splay( NewNode );
275     return( ubi_trTRUE );
276     }
277
278   /* Splay the unreplacable, duplicate keyed, unique, old node. */
279   RootPtr->root = Splay( (*OldNode) );
280   return( ubi_trFALSE );
281   } /* ubi_sptInsert */
282
283 ubi_btNodePtr ubi_sptRemove( ubi_btRootPtr RootPtr, ubi_btNodePtr DeadNode )
284   /* ------------------------------------------------------------------------ **
285    * This function removes the indicated node from the tree.
286    *
287    *  Input:   RootPtr  -  A pointer to the header of the tree that contains
288    *                       the node to be removed.
289    *           DeadNode -  A pointer to the node that will be removed.
290    *
291    *  Output:  This function returns a pointer to the node that was removed
292    *           from the tree (ie. the same as DeadNode).
293    *
294    *  Note:    The node MUST be in the tree indicated by RootPtr.  If not,
295    *           strange and evil things will happen to your trees.
296    * ------------------------------------------------------------------------ **
297    */
298   {
299   ubi_btNodePtr p;
300
301   (void)Splay( DeadNode );                  /* Move dead node to root.        */
302   if( (p = DeadNode->Link[LEFT]) )          /* If left subtree exists...      */
303     {
304     ubi_btNodePtr q = DeadNode->Link[RIGHT];
305
306     p->Link[PARENT] = NULL;                 /* Left subtree node becomes root.*/
307     p->gender       = PARENT;
308     p               = ubi_btLast( p );      /* Find rightmost left tree node..*/
309     p->Link[RIGHT]  = q;                    /* ...attach right tree.          */
310     if( q )
311       q->Link[PARENT] = p;
312     RootPtr->root   = Splay( p );           /* Resplay at p.                  */
313     }
314   else
315     {
316     if( (p = DeadNode->Link[RIGHT]) )       /* No left, but right subtree...  */
317       {                                     /* ...exists...                   */
318       p->Link[PARENT] = NULL;               /* Right subtree root becomes...  */
319       p->gender       = PARENT;             /* ...overall tree root.          */
320       RootPtr->root   = p;
321       }
322     else
323       RootPtr->root = NULL;                 /* No subtrees => empty tree.     */
324     }
325
326   (RootPtr->count)--;                       /* Decrement node count.          */
327   return( DeadNode );                       /* Return pointer to pruned node. */
328   } /* ubi_sptRemove */
329
330 ubi_btNodePtr ubi_sptLocate( ubi_btRootPtr RootPtr,
331                              ubi_btItemPtr FindMe,
332                              ubi_trCompOps CompOp )
333   /* ------------------------------------------------------------------------ **
334    * The purpose of ubi_btLocate() is to find a node or set of nodes given
335    * a target value and a "comparison operator".  The Locate() function is
336    * more flexible and (in the case of trees that may contain dupicate keys)
337    * more precise than the ubi_btFind() function.  The latter is faster,
338    * but it only searches for exact matches and, if the tree contains
339    * duplicates, Find() may return a pointer to any one of the duplicate-
340    * keyed records.
341    *
342    *  Input:
343    *     RootPtr  -  A pointer to the header of the tree to be searched.
344    *     FindMe   -  An ubi_btItemPtr that indicates the key for which to
345    *                 search.
346    *     CompOp   -  One of the following:
347    *                    CompOp     Return a pointer to the node with
348    *                    ------     ---------------------------------
349    *                   ubi_trLT - the last key value that is less
350    *                              than FindMe.
351    *                   ubi_trLE - the first key matching FindMe, or
352    *                              the last key that is less than
353    *                              FindMe.
354    *                   ubi_trEQ - the first key matching FindMe.
355    *                   ubi_trGE - the first key matching FindMe, or the
356    *                              first key greater than FindMe.
357    *                   ubi_trGT - the first key greater than FindMe.
358    *  Output:
359    *     A pointer to the node matching the criteria listed above under
360    *     CompOp, or NULL if no node matched the criteria.
361    *
362    *  Notes:
363    *     In the case of trees with duplicate keys, Locate() will behave as
364    *     follows:
365    *
366    *     Find:  3                       Find: 3
367    *     Keys:  1 2 2 2 3 3 3 3 3 4 4   Keys: 1 1 2 2 2 4 4 5 5 5 6
368    *                  ^ ^         ^                   ^ ^
369    *                 LT EQ        GT                 LE GE
370    *
371    *     That is, when returning a pointer to a node with a key that is LESS
372    *     THAN the target key (FindMe), Locate() will return a pointer to the
373    *     LAST matching node.
374    *     When returning a pointer to a node with a key that is GREATER
375    *     THAN the target key (FindMe), Locate() will return a pointer to the
376    *     FIRST matching node.
377    *
378    *  See Also: ubi_btFind(), ubi_btFirstOf(), ubi_btLastOf().
379    * ------------------------------------------------------------------------ **
380    */
381   {
382   ubi_btNodePtr p;
383
384   p = ubi_btLocate( RootPtr, FindMe, CompOp );
385   if( p )
386     RootPtr->root = Splay( p );
387   return( p );
388   } /* ubi_sptLocate */
389
390 ubi_btNodePtr ubi_sptFind( ubi_btRootPtr RootPtr,
391                            ubi_btItemPtr FindMe )
392   /* ------------------------------------------------------------------------ **
393    * This function performs a non-recursive search of a tree for any node
394    * matching a specific key.
395    *
396    *  Input:
397    *     RootPtr  -  a pointer to the header of the tree to be searched.
398    *     FindMe   -  a pointer to the key value for which to search.
399    *
400    *  Output:
401    *     A pointer to a node with a key that matches the key indicated by
402    *     FindMe, or NULL if no such node was found.
403    *
404    *  Note:   In a tree that allows duplicates, the pointer returned *might
405    *          not* point to the (sequentially) first occurance of the
406    *          desired key.  In such a tree, it may be more useful to use
407    *          ubi_sptLocate().
408    * ------------------------------------------------------------------------ **
409    */
410   {
411   ubi_btNodePtr p;
412
413   p = ubi_btFind( RootPtr, FindMe );
414   if( p )
415     RootPtr->root = Splay( p );
416   return( p );
417   } /* ubi_sptFind */
418
419 void ubi_sptSplay( ubi_btRootPtr RootPtr,
420                    ubi_btNodePtr SplayMe )
421   /* ------------------------------------------------------------------------ **
422    *  This function allows you to splay the tree at a given node, thus moving
423    *  the node to the top of the tree.
424    *
425    *  Input:
426    *     RootPtr  -  a pointer to the header of the tree to be splayed.
427    *     SplayMe  -  a pointer to a node within the tree.  This will become
428    *                 the new root node.
429    *  Output: None.
430    *
431    *  Notes:  This is an uncharacteristic function for this group of modules
432    *          in that it provides access to the internal balancing routines,
433    *          which would normally be hidden.
434    *          Splaying the tree will not damage it (assuming that I've done
435    *          *my* job), but there is overhead involved.  I don't recommend
436    *          that you use this function unless you understand the underlying
437    *          Splay Tree principles involved.
438    * ------------------------------------------------------------------------ **
439    */
440   {
441   RootPtr->root = Splay( SplayMe );
442   } /* ubi_sptSplay */
443
444 int ubi_sptModuleID( int size, char *list[] )
445   /* ------------------------------------------------------------------------ **
446    * Returns a set of strings that identify the module.
447    *
448    *  Input:  size  - The number of elements in the array <list>.
449    *          list  - An array of pointers of type (char *).  This array
450    *                  should, initially, be empty.  This function will fill
451    *                  in the array with pointers to strings.
452    *  Output: The number of elements of <list> that were used.  If this value
453    *          is less than <size>, the values of the remaining elements are
454    *          not guaranteed.
455    *
456    *  Notes:  Please keep in mind that the pointers returned indicate strings
457    *          stored in static memory.  Don't free() them, don't write over
458    *          them, etc.  Just read them.
459    * ------------------------------------------------------------------------ **
460    */
461   {
462   if( size > 0 )
463     {
464     list[0] = ModuleID;
465     if( size > 1 )
466       return( 1 + ubi_btModuleID( --size, &(list[1]) ) );
467     return( 1 );
468     }
469   return( 0 );
470   } /* ubi_sptModuleID */
471
472 /* ================================ The End ================================= */