- Implement cases 2 & 4 of RtlSplayTree
[reactos.git] / reactos / lib / rtl / splaytree.c
1 /*
2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS system libraries
4 * PURPOSE: Splay-Tree implementation
5 * FILE: lib/rtl/splaytree.c
6 * PROGRAMMER:
7 */
8
9 /* INCLUDES *****************************************************************/
10
11 #include <rtl.h>
12
13 #define NDEBUG
14 #include <debug.h>
15
16 /* FUNCTIONS ***************************************************************/
17
18 /*
19 * @unimplemented
20 */
21 PRTL_SPLAY_LINKS
22 NTAPI
23 RtlDelete (
24 PRTL_SPLAY_LINKS Links
25 )
26 {
27 UNIMPLEMENTED;
28 return 0;
29 }
30
31 /*
32 * @unimplemented
33 */
34 VOID
35 NTAPI
36 RtlDeleteNoSplay (
37 PRTL_SPLAY_LINKS Links,
38 PRTL_SPLAY_LINKS *Root
39 )
40 {
41 UNIMPLEMENTED;
42 }
43
44
45 /*
46 * @unimplemented
47 */
48 PRTL_SPLAY_LINKS
49 NTAPI
50 RtlRealPredecessor (
51 PRTL_SPLAY_LINKS Links
52 )
53 {
54 UNIMPLEMENTED;
55 return 0;
56 }
57
58 /*
59 * @unimplemented
60 */
61 PRTL_SPLAY_LINKS
62 NTAPI
63 RtlRealSuccessor (
64 PRTL_SPLAY_LINKS Links
65 )
66 {
67 UNIMPLEMENTED;
68 return 0;
69 }
70
71 /*
72 * @unimplemented
73 */
74 PRTL_SPLAY_LINKS
75 NTAPI
76 RtlSplay(PRTL_SPLAY_LINKS Links)
77 {
78 /*
79 * Implementation Notes (http://en.wikipedia.org/wiki/Splay_tree):
80 *
81 * To do a splay, we carry out a sequence of rotations,
82 * each of which moves the target node N closer to the root.
83 *
84 * Each particular step depends on only two factors:
85 * - Whether N is the left or right child of its parent node, P,
86 * - Whether P is the left or right child of its parent, G (for grandparent node).
87 *
88 * Thus, there are four cases:
89 * - Case 1: N is the left child of P and P is the left child of G.
90 * In this case we perform a double right rotation, so that
91 * P becomes N's right child, and G becomes P's right child.
92 *
93 * - Case 2: N is the right child of P and P is the right child of G.
94 * In this case we perform a double left rotation, so that
95 * P becomes N's left child, and G becomes P's left child.
96 *
97 * - Case 3: N is the left child of P and P is the right child of G.
98 * In this case we perform a rotation so that
99 * G becomes N's left child, and P becomes N's right child.
100 *
101 * - Case 4: N is the right child of P and P is the left child of G.
102 * In this case we perform a rotation so that
103 * P becomes N's left child, and G becomes N's right child.
104 *
105 * Finally, if N doesn't have a grandparent node, we simply perform a
106 * left or right rotation to move it to the root.
107 *
108 * By performing a splay on the node of interest after every operation,
109 * we keep recently accessed nodes near the root and keep the tree
110 * roughly balanced, so that we achieve the desired amortized time bounds.
111 */
112 PRTL_SPLAY_LINKS N, P, G;
113
114 /* N is the item we'll be playing with */
115 N = Links;
116
117 /* Let the algorithm run until N becomes the root entry */
118 while (!RtlIsRoot(N))
119 {
120 /* Now get the parent and grand-parent */
121 P = RtlParent(N);
122 G = RtlParent(P);
123
124 /* Case 1 & 3: N is left child of P */
125 if (RtlIsLeftChild(N))
126 {
127 /* Case 1: P is the left child of G */
128 if (RtlIsLeftChild(P))
129 {
130 /*
131 * N's right-child becomes P's left child and
132 * P's right-child becomes G's left child.
133 */
134 RtlLeftChild(P) = RtlRightChild(N);
135 RtlLeftChild(G) = RtlRightChild(P);
136
137 /*
138 * If they exist, update their parent pointers too,
139 * since they've changed trees.
140 */
141 if (RtlLeftChild(P)) RtlParent(RtlLeftChild(P)) = P;
142 if (RtlLeftChild(G)) RtlParent(RtlLeftChild(G)) = G;
143
144 /*
145 * Now we'll shove N all the way to the top.
146 * Check if G is the root first.
147 */
148 if (RtlIsRoot(G))
149 {
150 /* G doesn't have a parent, so N will become the root! */
151 RtlParent(N) = N;
152 }
153 else
154 {
155 /* G has a parent, so inherit it since we take G's place */
156 RtlParent(N) = RtlParent(G);
157
158 /*
159 * Now find out who was referencing G and have it reference
160 * N instead, since we're taking G's place.
161 */
162 if (RtlIsLeftChild(G))
163 {
164 /*
165 * G was a left child, so change its parent's left
166 * child link to point to N now.
167 */
168 RtlLeftChild(RtlParent(G)) = N;
169 }
170 else
171 {
172 /*
173 * G was a right child, so change its parent's right
174 * child link to point to N now.
175 */
176 RtlLeftChild(RtlParent(G)) = N;
177 }
178 }
179
180 /* Now N is on top, so P has become its child. */
181 RtlRightChild(N) = P;
182 RtlParent(P) = N;
183
184 /* N is on top, P is its child, so G is grandchild. */
185 RtlRightChild(P) = G;
186 RtlParent(G) = P;
187 }
188 /* Case 3: P is the right child of G */
189 else if (RtlIsRightChild(P))
190 {
191 /*
192 * N's left-child becomes G's right child and
193 * N's right-child becomes P's left child.
194 */
195 RtlRightChild(G) = RtlLeftChild(N);
196 RtlLeftChild(P) = RtlRightChild(N);
197
198 /*
199 * If they exist, update their parent pointers too,
200 * since they've changed trees.
201 */
202 if (RtlRightChild(G)) RtlParent(RtlRightChild(G)) = G;
203 if (RtlLeftChild(P)) RtlParent(RtlLeftChild(P)) = P;
204
205 /*
206 * Now we'll shove N all the way to the top.
207 * Check if G is the root first.
208 */
209 if (RtlIsRoot(G))
210 {
211 /* G doesn't have a parent, so N will become the root! */
212 RtlParent(N) = N;
213 }
214 else
215 {
216 /* G has a parent, so inherit it since we take G's place */
217 RtlParent(N) = RtlParent(G);
218
219 /*
220 * Now find out who was referencing G and have it reference
221 * N instead, since we're taking G's place.
222 */
223 if (RtlIsLeftChild(G))
224 {
225 /*
226 * G was a left child, so change its parent's left
227 * child link to point to N now.
228 */
229 RtlLeftChild(RtlParent(G)) = N;
230 }
231 else
232 {
233 /*
234 * G was a right child, so change its parent's right
235 * child link to point to N now.
236 */
237 RtlLeftChild(RtlParent(G)) = N;
238 }
239 }
240
241 /* Now N is on top, so G has become its left child. */
242 RtlLeftChild(N) = G;
243 RtlParent(G) = N;
244
245 /* N is on top, G is its left child, so P is right child. */
246 RtlRightChild(N) = P;
247 RtlParent(P) = N;
248 }
249 /* "Finally" case: N doesn't have a grandparent => P is root */
250 else
251 {
252
253 }
254 }
255 /* Case 2 & 4: N is right child of P */
256 else
257 {
258 /* Case 2: P is the right child of G */
259 if (RtlIsRightChild(P))
260 {
261 /*
262 * P's left-child becomes G's right child and
263 * N's left-child becomes P's right child.
264 */
265 RtlRightChild(G) = RtlLeftChild(P);
266 RtlRightChild(P) = RtlLeftChild(N);
267
268 /*
269 * If they exist, update their parent pointers too,
270 * since they've changed trees.
271 */
272 if (RtlRightChild(G)) RtlParent(RtlRightChild(G)) = G;
273 if (RtlRightChild(P)) RtlParent(RtlRightChild(P)) = P;
274
275 /*
276 * Now we'll shove N all the way to the top.
277 * Check if G is the root first.
278 */
279 if (RtlIsRoot(G))
280 {
281 /* G doesn't have a parent, so N will become the root! */
282 RtlParent(N) = N;
283 }
284 else
285 {
286 /* G has a parent, so inherit it since we take G's place */
287 RtlParent(N) = RtlParent(G);
288
289 /*
290 * Now find out who was referencing G and have it reference
291 * N instead, since we're taking G's place.
292 */
293 if (RtlIsLeftChild(G))
294 {
295 /*
296 * G was a left child, so change its parent's left
297 * child link to point to N now.
298 */
299 RtlLeftChild(RtlParent(G)) = N;
300 }
301 else
302 {
303 /*
304 * G was a right child, so change its parent's right
305 * child link to point to N now.
306 */
307 RtlLeftChild(RtlParent(G)) = N;
308 }
309 }
310
311 /* Now N is on top, so P has become its child. */
312 RtlLeftChild(N) = P;
313 RtlParent(P) = N;
314
315 /* N is on top, P is its child, so G is grandchild. */
316 RtlLeftChild(P) = G;
317 RtlParent(G) = P;
318 }
319 /* Case 4: P is the left child of G */
320 else if (RtlIsLeftChild(P))
321 {
322 /*
323 * N's left-child becomes G's right child and
324 * N's right-child becomes P's left child.
325 */
326 RtlRightChild(P) = RtlLeftChild(N);
327 RtlLeftChild(G) = RtlRightChild(N);
328
329 /*
330 * If they exist, update their parent pointers too,
331 * since they've changed trees.
332 */
333 if (RtlRightChild(P)) RtlParent(RtlRightChild(P)) = P;
334 if (RtlLeftChild(G)) RtlParent(RtlLeftChild(G)) = G;
335
336 /*
337 * Now we'll shove N all the way to the top.
338 * Check if G is the root first.
339 */
340 if (RtlIsRoot(G))
341 {
342 /* G doesn't have a parent, so N will become the root! */
343 RtlParent(N) = N;
344 }
345 else
346 {
347 /* G has a parent, so inherit it since we take G's place */
348 RtlParent(N) = RtlParent(G);
349
350 /*
351 * Now find out who was referencing G and have it reference
352 * N instead, since we're taking G's place.
353 */
354 if (RtlIsLeftChild(G))
355 {
356 /*
357 * G was a left child, so change its parent's left
358 * child link to point to N now.
359 */
360 RtlLeftChild(RtlParent(G)) = N;
361 }
362 else
363 {
364 /*
365 * G was a right child, so change its parent's right
366 * child link to point to N now.
367 */
368 RtlLeftChild(RtlParent(G)) = N;
369 }
370 }
371
372 /* Now N is on top, so P has become its left child. */
373 RtlLeftChild(N) = P;
374 RtlParent(G) = N;
375
376 /* N is on top, P is its left child, so G is right child. */
377 RtlRightChild(N) = G;
378 RtlParent(P) = N;
379 }
380 /* "Finally" case: N doesn't have a grandparent => P is root */
381 else
382 {
383
384 }
385 }
386 }
387
388 /* Return the root entry */
389 return N;
390 }
391
392
393 /*
394 * @implemented
395 */
396 PRTL_SPLAY_LINKS NTAPI
397 RtlSubtreePredecessor (IN PRTL_SPLAY_LINKS Links)
398 {
399 PRTL_SPLAY_LINKS Child;
400
401 Child = Links->RightChild;
402 if (Child == NULL)
403 return NULL;
404
405 if (Child->LeftChild == NULL)
406 return Child;
407
408 /* Get left-most child */
409 while (Child->LeftChild != NULL)
410 Child = Child->LeftChild;
411
412 return Child;
413 }
414
415 /*
416 * @implemented
417 */
418 PRTL_SPLAY_LINKS NTAPI
419 RtlSubtreeSuccessor (IN PRTL_SPLAY_LINKS Links)
420 {
421 PRTL_SPLAY_LINKS Child;
422
423 Child = Links->LeftChild;
424 if (Child == NULL)
425 return NULL;
426
427 if (Child->RightChild == NULL)
428 return Child;
429
430 /* Get right-most child */
431 while (Child->RightChild != NULL)
432 Child = Child->RightChild;
433
434 return Child;
435 }
436
437 /* EOF */