1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
|
package scala.collection.mutable
import scala.annotation.tailrec
import scala.collection.Iterator
/**
* An object containing the red-black tree implementation used by mutable `TreeMaps`.
*
* The trees implemented in this object are *not* thread safe.
*
* @author Rui Gonçalves
* @version 2.12
* @since 2.12
*/
private[collection] object RedBlackTree {
// ---- class structure ----
// For performance reasons, this implementation uses `null` references to represent leaves instead of a sentinel node.
// Currently, the internal nodes do not store their subtree size - only the tree object keeps track of their size.
// Therefore, while obtaining the size of the whole tree is O(1), knowing the number of entries inside a range is O(n)
// on the size of the range.
@SerialVersionUID(21575944040195605L)
final class Tree[A, B](var root: Node[A, B], var size: Int) extends Serializable
@SerialVersionUID(1950599696441054720L)
final class Node[A, B](var key: A, var value: B, var red: Boolean,
var left: Node[A, B], var right: Node[A, B], var parent: Node[A, B]) extends Serializable {
override def toString: String = "Node(" + key + ", " + value + ", " + red + ", " + left + ", " + right + ")"
}
object Tree {
def empty[A, B]: Tree[A, B] = new Tree(null, 0)
}
object Node {
@inline def apply[A, B](key: A, value: B, red: Boolean,
left: Node[A, B], right: Node[A, B], parent: Node[A, B]): Node[A, B] =
new Node(key, value, red, left, right, parent)
@inline def leaf[A, B](key: A, value: B, red: Boolean, parent: Node[A, B]): Node[A, B] =
new Node(key, value, red, null, null, parent)
def unapply[A, B](t: Node[A, B]) = Some((t.key, t.value, t.left, t.right, t.parent))
}
// ---- getters ----
def isRed(node: Node[_, _]) = (node ne null) && node.red
def isBlack(node: Node[_, _]) = (node eq null) || !node.red
// ---- size ----
def size(node: Node[_, _]): Int = if (node eq null) 0 else 1 + size(node.left) + size(node.right)
def size(tree: Tree[_, _]): Int = tree.size
def isEmpty(tree: Tree[_, _]) = tree.root eq null
def clear(tree: Tree[_, _]): Unit = { tree.root = null; tree.size = 0 }
// ---- search ----
def get[A: Ordering, B](tree: Tree[A, B], key: A): Option[B] = getNode(tree.root, key) match {
case null => None
case node => Some(node.value)
}
@tailrec private[this] def getNode[A, B](node: Node[A, B], key: A)(implicit ord: Ordering[A]): Node[A, B] =
if (node eq null) null
else {
val cmp = ord.compare(key, node.key)
if (cmp < 0) getNode(node.left, key)
else if (cmp > 0) getNode(node.right, key)
else node
}
def contains[A: Ordering](tree: Tree[A, _], key: A) = getNode(tree.root, key) ne null
def min[A, B](tree: Tree[A, B]): Option[(A, B)] = minNode(tree.root) match {
case null => None
case node => Some((node.key, node.value))
}
def minKey[A](tree: Tree[A, _]): Option[A] = minNode(tree.root) match {
case null => None
case node => Some(node.key)
}
private def minNode[A, B](node: Node[A, B]): Node[A, B] =
if (node eq null) null else minNodeNonNull(node)
@tailrec def minNodeNonNull[A, B](node: Node[A, B]): Node[A, B] =
if (node.left eq null) node else minNodeNonNull(node.left)
def max[A, B](tree: Tree[A, B]): Option[(A, B)] = maxNode(tree.root) match {
case null => None
case node => Some((node.key, node.value))
}
def maxKey[A](tree: Tree[A, _]): Option[A] = maxNode(tree.root) match {
case null => None
case node => Some(node.key)
}
private def maxNode[A, B](node: Node[A, B]): Node[A, B] =
if (node eq null) null else maxNodeNonNull(node)
@tailrec def maxNodeNonNull[A, B](node: Node[A, B]): Node[A, B] =
if (node.right eq null) node else maxNodeNonNull(node.right)
/**
* Returns the first (lowest) map entry with a key equal or greater than `key`. Returns `None` if there is no such
* node.
*/
def minAfter[A, B](tree: Tree[A, B], key: A)(implicit ord: Ordering[A]): Option[(A, B)] =
minNodeAfter(tree.root, key) match {
case null => None
case node => Some((node.key, node.value))
}
def minKeyAfter[A](tree: Tree[A, _], key: A)(implicit ord: Ordering[A]): Option[A] =
minNodeAfter(tree.root, key) match {
case null => None
case node => Some(node.key)
}
private[this] def minNodeAfter[A, B](node: Node[A, B], key: A)(implicit ord: Ordering[A]): Node[A, B] = {
if (node eq null) null
else {
var y: Node[A, B] = null
var x = node
var cmp = 1
while ((x ne null) && cmp != 0) {
y = x
cmp = ord.compare(key, x.key)
x = if (cmp < 0) x.left else x.right
}
if (cmp <= 0) y else successor(y)
}
}
/**
* Returns the last (highest) map entry with a key smaller than `key`. Returns `None` if there is no such node.
*/
def maxBefore[A, B](tree: Tree[A, B], key: A)(implicit ord: Ordering[A]): Option[(A, B)] =
maxNodeBefore(tree.root, key) match {
case null => None
case node => Some((node.key, node.value))
}
def maxKeyBefore[A](tree: Tree[A, _], key: A)(implicit ord: Ordering[A]): Option[A] =
maxNodeBefore(tree.root, key) match {
case null => None
case node => Some(node.key)
}
private[this] def maxNodeBefore[A, B](node: Node[A, B], key: A)(implicit ord: Ordering[A]): Node[A, B] = {
if (node eq null) null
else {
var y: Node[A, B] = null
var x = node
var cmp = 1
while ((x ne null) && cmp != 0) {
y = x
cmp = ord.compare(key, x.key)
x = if (cmp < 0) x.left else x.right
}
if (cmp > 0) y else predecessor(y)
}
}
// ---- insertion ----
def insert[A, B](tree: Tree[A, B], key: A, value: B)(implicit ord: Ordering[A]): Unit = {
var y: Node[A, B] = null
var x = tree.root
var cmp = 1
while ((x ne null) && cmp != 0) {
y = x
cmp = ord.compare(key, x.key)
x = if (cmp < 0) x.left else x.right
}
if (cmp == 0) y.value = value
else {
val z = Node.leaf(key, value, red = true, y)
if (y eq null) tree.root = z
else if (cmp < 0) y.left = z
else y.right = z
fixAfterInsert(tree, z)
tree.size += 1
}
}
private[this] def fixAfterInsert[A, B](tree: Tree[A, B], node: Node[A, B]): Unit = {
var z = node
while (isRed(z.parent)) {
if (z.parent eq z.parent.parent.left) {
val y = z.parent.parent.right
if (isRed(y)) {
z.parent.red = false
y.red = false
z.parent.parent.red = true
z = z.parent.parent
} else {
if (z eq z.parent.right) {
z = z.parent
rotateLeft(tree, z)
}
z.parent.red = false
z.parent.parent.red = true
rotateRight(tree, z.parent.parent)
}
} else { // symmetric cases
val y = z.parent.parent.left
if (isRed(y)) {
z.parent.red = false
y.red = false
z.parent.parent.red = true
z = z.parent.parent
} else {
if (z eq z.parent.left) {
z = z.parent
rotateRight(tree, z)
}
z.parent.red = false
z.parent.parent.red = true
rotateLeft(tree, z.parent.parent)
}
}
}
tree.root.red = false
}
// ---- deletion ----
def delete[A, B](tree: Tree[A, B], key: A)(implicit ord: Ordering[A]): Unit = {
val z = getNode(tree.root, key)
if (z ne null) {
var y = z
var yIsRed = y.red
var x: Node[A, B] = null
var xParent: Node[A, B] = null
if (z.left eq null) {
x = z.right
transplant(tree, z, z.right)
xParent = z.parent
}
else if (z.right eq null) {
x = z.left
transplant(tree, z, z.left)
xParent = z.parent
}
else {
y = minNodeNonNull(z.right)
yIsRed = y.red
x = y.right
if (y.parent eq z) xParent = y
else {
xParent = y.parent
transplant(tree, y, y.right)
y.right = z.right
y.right.parent = y
}
transplant(tree, z, y)
y.left = z.left
y.left.parent = y
y.red = z.red
}
if (!yIsRed) fixAfterDelete(tree, x, xParent)
tree.size -= 1
}
}
private[this] def fixAfterDelete[A, B](tree: Tree[A, B], node: Node[A, B], parent: Node[A, B]): Unit = {
var x = node
var xParent = parent
while ((x ne tree.root) && isBlack(x)) {
if (x eq xParent.left) {
var w = xParent.right
// assert(w ne null)
if (w.red) {
w.red = false
xParent.red = true
rotateLeft(tree, xParent)
w = xParent.right
}
if (isBlack(w.left) && isBlack(w.right)) {
w.red = true
x = xParent
} else {
if (isBlack(w.right)) {
w.left.red = false
w.red = true
rotateRight(tree, w)
w = xParent.right
}
w.red = xParent.red
xParent.red = false
w.right.red = false
rotateLeft(tree, xParent)
x = tree.root
}
} else { // symmetric cases
var w = xParent.left
// assert(w ne null)
if (w.red) {
w.red = false
xParent.red = true
rotateRight(tree, xParent)
w = xParent.left
}
if (isBlack(w.right) && isBlack(w.left)) {
w.red = true
x = xParent
} else {
if (isBlack(w.left)) {
w.right.red = false
w.red = true
rotateLeft(tree, w)
w = xParent.left
}
w.red = xParent.red
xParent.red = false
w.left.red = false
rotateRight(tree, xParent)
x = tree.root
}
}
xParent = x.parent
}
if (x ne null) x.red = false
}
// ---- helpers ----
/**
* Returns the node that follows `node` in an in-order tree traversal. If `node` has the maximum key (and is,
* therefore, the last node), this method returns `null`.
*/
private[this] def successor[A, B](node: Node[A, B]): Node[A, B] = {
if (node.right ne null) minNodeNonNull(node.right)
else {
var x = node
var y = x.parent
while ((y ne null) && (x eq y.right)) {
x = y
y = y.parent
}
y
}
}
/**
* Returns the node that precedes `node` in an in-order tree traversal. If `node` has the minimum key (and is,
* therefore, the first node), this method returns `null`.
*/
private[this] def predecessor[A, B](node: Node[A, B]): Node[A, B] = {
if (node.left ne null) maxNodeNonNull(node.left)
else {
var x = node
var y = x.parent
while ((y ne null) && (x eq y.left)) {
x = y
y = y.parent
}
y
}
}
private[this] def rotateLeft[A, B](tree: Tree[A, B], x: Node[A, B]): Unit = if (x ne null) {
// assert(x.right ne null)
val y = x.right
x.right = y.left
if (y.left ne null) y.left.parent = x
y.parent = x.parent
if (x.parent eq null) tree.root = y
else if (x eq x.parent.left) x.parent.left = y
else x.parent.right = y
y.left = x
x.parent = y
}
private[this] def rotateRight[A, B](tree: Tree[A, B], x: Node[A, B]): Unit = if (x ne null) {
// assert(x.left ne null)
val y = x.left
x.left = y.right
if (y.right ne null) y.right.parent = x
y.parent = x.parent
if (x.parent eq null) tree.root = y
else if (x eq x.parent.right) x.parent.right = y
else x.parent.left = y
y.right = x
x.parent = y
}
/**
* Transplant the node `from` to the place of node `to`. This is done by setting `from` as a child of `to`'s previous
* parent and setting `from`'s parent to the `to`'s previous parent. The children of `from` are left unchanged.
*/
private[this] def transplant[A, B](tree: Tree[A, B], to: Node[A, B], from: Node[A, B]): Unit = {
if (to.parent eq null) tree.root = from
else if (to eq to.parent.left) to.parent.left = from
else to.parent.right = from
if (from ne null) from.parent = to.parent
}
// ---- tree traversal ----
def foreach[A, B, U](tree: Tree[A, B], f: ((A, B)) => U): Unit = foreachNode(tree.root, f)
private[this] def foreachNode[A, B, U](node: Node[A, B], f: ((A, B)) => U): Unit =
if (node ne null) foreachNodeNonNull(node, f)
private[this] def foreachNodeNonNull[A, B, U](node: Node[A, B], f: ((A, B)) => U): Unit = {
if (node.left ne null) foreachNodeNonNull(node.left, f)
f((node.key, node.value))
if (node.right ne null) foreachNodeNonNull(node.right, f)
}
def foreachKey[A, U](tree: Tree[A, _], f: A => U): Unit = foreachNodeKey(tree.root, f)
private[this] def foreachNodeKey[A, U](node: Node[A, _], f: A => U): Unit =
if (node ne null) foreachNodeKeyNonNull(node, f)
private[this] def foreachNodeKeyNonNull[A, U](node: Node[A, _], f: A => U): Unit = {
if (node.left ne null) foreachNodeKeyNonNull(node.left, f)
f(node.key)
if (node.right ne null) foreachNodeKeyNonNull(node.right, f)
}
def transform[A, B](tree: Tree[A, B], f: (A, B) => B): Unit = transformNode(tree.root, f)
private[this] def transformNode[A, B, U](node: Node[A, B], f: (A, B) => B): Unit =
if (node ne null) transformNodeNonNull(node, f)
private[this] def transformNodeNonNull[A, B, U](node: Node[A, B], f: (A, B) => B): Unit = {
if (node.left ne null) transformNodeNonNull(node.left, f)
node.value = f(node.key, node.value)
if (node.right ne null) transformNodeNonNull(node.right, f)
}
def iterator[A: Ordering, B](tree: Tree[A, B], start: Option[A] = None, end: Option[A] = None): Iterator[(A, B)] =
new EntriesIterator(tree, start, end)
def keysIterator[A: Ordering](tree: Tree[A, _], start: Option[A] = None, end: Option[A] = None): Iterator[A] =
new KeysIterator(tree, start, end)
def valuesIterator[A: Ordering, B](tree: Tree[A, B], start: Option[A] = None, end: Option[A] = None): Iterator[B] =
new ValuesIterator(tree, start, end)
private[this] abstract class TreeIterator[A, B, R](tree: Tree[A, B], start: Option[A], end: Option[A])
(implicit ord: Ordering[A]) extends Iterator[R] {
protected[this] def nextResult(node: Node[A, B]): R
def hasNext: Boolean = nextNode ne null
def next(): R = nextNode match {
case null => throw new NoSuchElementException("next on empty iterator")
case node =>
nextNode = successor(node)
setNullIfAfterEnd()
nextResult(node)
}
private[this] var nextNode: Node[A, B] = start match {
case None => minNode(tree.root)
case Some(from) => minNodeAfter(tree.root, from)
}
private[this] def setNullIfAfterEnd(): Unit =
if (end.isDefined && (nextNode ne null) && ord.compare(nextNode.key, end.get) >= 0)
nextNode = null
setNullIfAfterEnd()
}
private[this] final class EntriesIterator[A: Ordering, B](tree: Tree[A, B], start: Option[A], end: Option[A])
extends TreeIterator[A, B, (A, B)](tree, start, end) {
def nextResult(node: Node[A, B]) = (node.key, node.value)
}
private[this] final class KeysIterator[A: Ordering, B](tree: Tree[A, B], start: Option[A], end: Option[A])
extends TreeIterator[A, B, A](tree, start, end) {
def nextResult(node: Node[A, B]) = node.key
}
private[this] final class ValuesIterator[A: Ordering, B](tree: Tree[A, B], start: Option[A], end: Option[A])
extends TreeIterator[A, B, B](tree, start, end) {
def nextResult(node: Node[A, B]) = node.value
}
// ---- debugging ----
/**
* Checks if the tree is in a valid state. That happens if:
* - It is a valid binary search tree;
* - All red-black properties are satisfied;
* - All non-null nodes have their `parent` reference correct;
* - The size variable in `tree` corresponds to the actual size of the tree.
*/
def isValid[A: Ordering, B](tree: Tree[A, B]): Boolean =
isValidBST(tree.root) && hasProperParentRefs(tree) && isValidRedBlackTree(tree) && size(tree.root) == tree.size
/**
* Returns true if all non-null nodes have their `parent` reference correct.
*/
private[this] def hasProperParentRefs[A, B](tree: Tree[A, B]): Boolean = {
def hasProperParentRefs(node: Node[A, B]): Boolean = {
if (node eq null) true
else {
if ((node.left ne null) && (node.left.parent ne node) ||
(node.right ne null) && (node.right.parent ne node)) false
else hasProperParentRefs(node.left) && hasProperParentRefs(node.right)
}
}
if(tree.root eq null) true
else (tree.root.parent eq null) && hasProperParentRefs(tree.root)
}
/**
* Returns true if this node follows the properties of a binary search tree.
*/
private[this] def isValidBST[A, B](node: Node[A, B])(implicit ord: Ordering[A]): Boolean = {
if (node eq null) true
else {
if ((node.left ne null) && (ord.compare(node.key, node.left.key) <= 0) ||
(node.right ne null) && (ord.compare(node.key, node.right.key) >= 0)) false
else isValidBST(node.left) && isValidBST(node.right)
}
}
/**
* Returns true if the tree has all the red-black tree properties: if the root node is black, if all children of red
* nodes are black and if the path from any node to any of its null children has the same number of black nodes.
*/
private[this] def isValidRedBlackTree[A, B](tree: Tree[A, B]): Boolean = {
def noRedAfterRed(node: Node[A, B]): Boolean = {
if (node eq null) true
else if (node.red && (isRed(node.left) || isRed(node.right))) false
else noRedAfterRed(node.left) && noRedAfterRed(node.right)
}
def blackHeight(node: Node[A, B]): Int = {
if (node eq null) 1
else {
val lh = blackHeight(node.left)
val rh = blackHeight(node.right)
if (lh == -1 || lh != rh) -1
else if (isRed(node)) lh
else lh + 1
}
}
isBlack(tree.root) && noRedAfterRed(tree.root) && blackHeight(tree.root) >= 0
}
}
|