File: red_black_tree.rb

package info (click to toggle)
ruby-avl-tree 1.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 184 kB
  • sloc: ruby: 2,179; makefile: 4
file content (848 lines) | stat: -rw-r--r-- 19,548 bytes parent folder | download
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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
require 'atomic'

class RedBlackTree
  include Enumerable

  class Node
    UNDEFINED = Object.new

    attr_reader :key, :value, :color
    attr_reader :left, :right

    def initialize(key, value, left, right, color = :RED)
      @key = key
      @value = value
      @left = left
      @right = right
      # new node is added as RED
      @color = color
    end

    def set_root
      @color = :BLACK
    end

    def red?
      @color == :RED
    end

    def black?
      @color == :BLACK
    end

    def empty?
      false
    end

    def size
      @left.size + 1 + @right.size
    end

    # inorder
    def each(&block)
      @left.each(&block)
      yield [@key, @value]
      @right.each(&block)
    end

    def each_key
      each do |k, v|
        yield k
      end
    end

    def each_value
      each do |k, v|
        yield v
      end
    end

    def keys
      collect { |k, v| k }
    end

    def values
      collect { |k, v| v }
    end

    # returns new_root
    def insert(key, value)
      ret = self
      case key <=> @key
      when -1
        @left = @left.insert(key, value)
        if black? and @right.black? and @left.red? and !@left.children_color?(:BLACK)
          ret = rebalance_for_left_insert
        end
      when 0
        @value = value
      when 1
        @right = @right.insert(key, value)
        if black? and @left.black? and @right.red? and !@right.children_color?(:BLACK)
          ret = rebalance_for_right_insert
        end
      else
        raise TypeError, "cannot compare #{key} and #{@key} with <=>"
      end
      ret.pullup_red
    end

    # returns value
    def retrieve(key)
      case key <=> @key
      when -1
        @left.retrieve(key)
      when 0
        @value
      when 1
        @right.retrieve(key)
      else
        nil
      end
    end

    # returns [deleted_node, new_root, is_rebalance_needed]
    def delete(key)
      ret = self
      case key <=> @key
      when -1
        deleted, @left, rebalance = @left.delete(key)
        if rebalance
          ret, rebalance = rebalance_for_left_delete
        end
      when 0
        deleted = self
        ret, rebalance = delete_node
      when 1
        deleted, @right, rebalance = @right.delete(key)
        if rebalance
          ret, rebalance = rebalance_for_right_delete
        end
      else
        raise TypeError, "cannot compare #{key} and #{@key} with <=>"
      end
      [deleted, ret, rebalance]
    end

    def dump_tree(io, indent = '')
      @right.dump_tree(io, indent + '  ')
      io << indent << sprintf("#<%s:0x%010x %s %s> => %s", self.class.name, __id__, @color, @key.inspect, @value.inspect) << $/
      @left.dump_tree(io, indent + '  ')
    end

    def dump_sexp
      left = @left.dump_sexp
      right = @right.dump_sexp
      if left or right
        '(' + [@key, left || '-', right].compact.join(' ') + ')'
      else
        @key
      end
    end

    # for debugging
    def check_height
      lh = @left.nil?  || @left.empty? ? 0 : @left.check_height
      rh = @right.nil? || @right.empty? ? 0 : @right.check_height
      if red?
        if @left.red? or @right.red?
          puts dump_tree(STDERR)
          raise 'red/red assertion failed'
        end
      else
        if lh != rh
          puts dump_tree(STDERR)
          raise "black height unbalanced: #{lh} #{rh}"
        end
      end
      (lh > rh ? lh : rh) + (black? ? 1 : 0)
    end

  protected

    def children_color?(color)
      @right.color == @left.color && @right.color == color
    end

    def color=(color)
      @color = color
    end

    def left=(left)
      @left = left
    end

    def right=(right)
      @right = right
    end

    def color_flip(other)
      @color, other.color = other.color, @color
    end

    def delete_min
      if @left.empty?
        [self, *delete_node]
      else
        ret = self
        deleted, @left, rebalance = @left.delete_min
        if rebalance
          ret, rebalance = rebalance_for_left_delete
        end
        [deleted, ret, rebalance]
      end
    end

    # trying to rebalance when the left sub-tree is 1 level lower than the right
    def rebalance_for_left_delete
      ret = self
      rebalance = false
      if black?
        if @right.black?
          if @right.children_color?(:BLACK)
            # make whole sub-tree 1 level lower and ask rebalance
            @right.color = :RED
            rebalance = true
          else
            # move 1 black from the right to the left by single/double rotation
            ret = balanced_rotate_left
          end
        else
          # flip this sub-tree into another type of 3-children node
          ret = rotate_left
          # try to rebalance in sub-tree
          ret.left, rebalance = ret.left.rebalance_for_left_delete
          raise 'should not happen' if rebalance
        end
      else # red
        if @right.children_color?(:BLACK)
          # make right sub-tree 1 level lower
          color_flip(@right)
        else
          # move 1 black from the right to the left by single/double rotation
          ret = balanced_rotate_left
        end
      end
      [ret, rebalance]
    end

    # trying to rebalance when the right sub-tree is 1 level lower than the left
    # See rebalance_for_left_delete.
    def rebalance_for_right_delete
      ret = self
      rebalance = false
      if black?
        if @left.black?
          if @left.children_color?(:BLACK)
            @left.color = :RED
            rebalance = true
          else
            ret = balanced_rotate_right
          end
        else
          ret = rotate_right
          ret.right, rebalance = ret.right.rebalance_for_right_delete
          raise 'should not happen' if rebalance
        end
      else # red
        if @left.children_color?(:BLACK)
          color_flip(@left)
        else
          ret = balanced_rotate_right
        end
      end
      [ret, rebalance]
    end

    # move 1 black from the right to the left by single/double rotation
    def balanced_rotate_left
      if @right.left.red? and @right.right.black?
        @right = @right.rotate_right
      end
      ret = rotate_left
      ret.right.color = ret.left.color = :BLACK
      ret
    end

    # move 1 black from the left to the right by single/double rotation
    def balanced_rotate_right
      if @left.right.red? and @left.left.black?
        @left = @left.rotate_left
      end
      ret = rotate_right
      ret.right.color = ret.left.color = :BLACK
      ret
    end

    # Right single rotation
    # (b a (D c E)) where D and E are RED --> (d (B a c) E)
    #
    #   b              d
    #  / \            / \
    # a   D    ->    B   E
    #    / \        / \
    #   c   E      a   c
    #
    def rotate_left
      root = @right
      @right = root.left
      root.left = self
      root.color_flip(root.left)
      root
    end

    # Left single rotation
    # (d (B A c) e) where A and B are RED --> (b A (D c e))
    #
    #     d          b
    #    / \        / \
    #   B   e  ->  A   D
    #  / \            / \
    # A   c          c   e
    #
    def rotate_right
      root = @left
      @left = root.right
      root.right = self
      root.color_flip(root.right)
      root
    end

    # Pull up red nodes
    # (b (A C)) where A and C are RED --> (B (a c))
    #
    #   b          B
    #  / \   ->   / \
    # A   C      a   c
    #
    def pullup_red
      if black? and children_color?(:RED)
        @left.color = @right.color = :BLACK
        self.color = :RED
      end
      self
    end

  private

    # trying to rebalance when the left sub-tree is 1 level higher than the right
    # precondition: self is black and @left is red
    def rebalance_for_left_insert
      # move 1 black from the left to the right by single/double rotation
      if @left.right.red?
        @left = @left.rotate_left
      end
      rotate_right
    end

    # trying to rebalance when the right sub-tree is 1 level higher than the left
    # See rebalance_for_left_insert.
    def rebalance_for_right_insert
      if @right.left.red?
        @right = @right.rotate_right
      end
      rotate_left
    end

    def delete_node
      rebalance = false
      if @left.empty? and @right.empty?
        # just remove this node and ask rebalance to the parent
        new_root = EMPTY
        if black?
          rebalance = true
        end
      elsif @left.empty? or @right.empty?
        # pick the single children
        new_root = @left.empty? ? @right : @left
        if black?
          # keep the color black
          raise 'should not happen' unless new_root.red?
          color_flip(new_root)
        else
          # just remove the red node
        end
      else
        # pick the minimum node from the right sub-tree and replace self with it
        deleted, @right, rebalance = @right.delete_min
        new_root = Node.new(deleted.key, deleted.value, @left, @right, @color)
        if rebalance
          new_root, rebalance = new_root.rebalance_for_right_delete
        end
      end
      [new_root, rebalance]
    end

    def collect
      pool = []
      each do |key, value|
        pool << yield(key, value)
      end
      pool
    end

    class EmptyNode < Node
      def initialize
        @value = nil
        @color = :BLACK
      end

      def empty?
        true
      end

      def size
        0
      end

      def each(&block)
        # intentionally blank
      end

      # returns new_root
      def insert(key, value)
        Node.new(key, value, self, self)
      end

      # returns value
      def retrieve(key)
        UNDEFINED
      end

      # returns [deleted_node, new_root, is_rebalance_needed]
      def delete(key)
        [self, self, false]
      end

      def dump_tree(io, indent = '')
        # intentionally blank
      end

      def dump_sexp
        # intentionally blank
      end
    end
    EMPTY = Node::EmptyNode.new.freeze
  end

  DEFAULT = Object.new

  attr_accessor :default
  attr_reader :default_proc

  def initialize(default = DEFAULT, &block)
    if block && default != DEFAULT
      raise ArgumentError, 'wrong number of arguments'
    end
    @root = Node::EMPTY
    @default = default
    @default_proc = block
  end

  def root
    @root
  end

  def empty?
    root == Node::EMPTY
  end

  def size
    root.size
  end
  alias length size

  def each(&block)
    if block_given?
      root.each(&block)
      self
    else
      root.to_enum
    end
  end
  alias each_pair each

  def each_key
    if block_given?
      root.each do |k, v|
        yield k
      end
      self
    else
      root.to_enum(method = :each_key)
    end
  end

  def each_value
    if block_given?
      root.each do |k, v|
        yield v
      end
      self
    else
      root.to_enum(method = :each_value)
    end
  end

  def keys
    root.keys
  end

  def values
    root.values
  end

  def clear
    @root = Node::EMPTY
  end

  def []=(key, value)
    @root = @root.insert(key, value)
    @root.set_root
    @root.check_height if $DEBUG
  end
  alias insert []=

  def key?(key)
    root.retrieve(key) != Node::UNDEFINED
  end
  alias has_key? key?

  def [](key)
    value = @root.retrieve(key)
    if value == Node::UNDEFINED
      default_value
    else
      value
    end
  end

  def delete(key)
    deleted, @root, rebalance = @root.delete(key)
    unless empty?
      @root.set_root
      @root.check_height if $DEBUG
    end
    deleted.value
  end

  def dump_tree(io = '')
    root.dump_tree(io)
    io << $/
    io
  end

  def dump_sexp
    root.dump_sexp || ''
  end

  def to_hash
    inject({}) { |r, (k, v)| r[k] = v; r }
  end

private

  def default_value
    if @default != DEFAULT
      @default
    elsif @default_proc
      @default_proc.call
    else
      nil
    end
  end
end

class ConcurrentRedBlackTree < RedBlackTree
  class ConcurrentNode < Node
    # direction: ~LEFT == RIGHT, ~RIGHT == LEFT
    LEFT = -1
    RIGHT = 0

    # @Overrides
    def insert(key, value)
      case key <=> @key
      when -1
        dir = LEFT
      when 0
        node = new_value(value)
      when 1
        dir = RIGHT
      else
        raise TypeError, "cannot compare #{key} and #{@key} with <=>"
      end
      if dir
        target = child(dir).insert(key, value)
        node = new_child(dir, target)
        if black? and child(~dir).black? and target.red? and !target.children_color?(:BLACK)
          node = node.rebalance_for_insert(dir)
        end
      end
      node.pullup_red
    end

    # @Overrides
    def retrieve(key)
      case key <=> @key
      when -1
        @left.retrieve(key)
      when 0
        @value
      when 1
        @right.retrieve(key)
      else
        nil
      end
    end

    # @Overrides
    def delete(key)
      case key <=> @key
      when -1
        dir = LEFT
      when 0
        deleted = self
        node, rebalance = delete_node
      when 1
        dir = RIGHT
      else
        raise TypeError, "cannot compare #{key} and #{@key} with <=>"
      end
      if dir
        deleted, target, rebalance = child(dir).delete(key)
        node = new_child(dir, target)
        if rebalance
          node, rebalance = node.rebalance_for_delete(dir)
        end
      end
      [deleted, node, rebalance]
    end

  protected

    def new_children(dir, node, other, color = @color)
      dir == LEFT ? 
        ConcurrentNode.new(@key, @value, node, other, color) :
        ConcurrentNode.new(@key, @value, other, node, color)
    end

    def new_child(dir, node, color = @color)
      dir == LEFT ? 
        ConcurrentNode.new(@key, @value, node, @right, color) :
        ConcurrentNode.new(@key, @value, @left, node, color)
    end

    def new_color(color)
      ConcurrentNode.new(@key, @value, @left, @right, color)
    end

    def new_value(value)
      ConcurrentNode.new(@key, value, @left, @right, @color)
    end

    def child(dir)
      dir == LEFT ? @left : @right
    end

    # @Overrides
    def delete_min
      if @left.empty?
        [self, *delete_node]
      else
        deleted, left, rebalance = @left.delete_min
        node = new_child(LEFT, left)
        if rebalance
          node, rebalance = node.rebalance_for_delete(LEFT)
        end
        [deleted, node, rebalance]
      end
    end

    # rebalance when the left/right sub-tree is 1 level lower than the right/left
    def rebalance_for_delete(dir)
      target = child(~dir)
      rebalance = false
      if black?
        if target.black?
          if target.children_color?(:BLACK)
            # make whole sub-tree 1 level lower and ask rebalance
            node = new_child(~dir, target.new_color(:RED))
            rebalance = true
          else
            # move 1 black from the right to the left by single/double rotation
            node = balanced_rotate(dir)
          end
        else
          # flip this sub-tree into another type of 3-children node
          node = rotate(dir)
          # try to rebalance in sub-tree
          target, rebalance = node.child(dir).rebalance_for_delete(dir)
          raise 'should not happen' if rebalance
          node = node.new_children(dir, target, node.child(~dir))
        end
      else # red
        if target.children_color?(:BLACK)
          # make right sub-tree 1 level lower
          node = new_child(~dir, target.new_color(@color), target.color)
        else
          # move 1 black from the right to the left by single/double rotation
          node = balanced_rotate(dir)
        end
      end
      [node, rebalance]
    end

    # move 1 black from the right/left to the left/right by single/double rotation
    def balanced_rotate(dir)
      target = child(~dir)
      if target.child(dir).red? and target.child(~dir).black?
        node = new_child(~dir, target.rotate(~dir))
      else
        node = self
      end
      node = node.rotate(dir)
      node.new_children(dir, node.child(dir).new_color(:BLACK), node.child(~dir).new_color(:BLACK))
    end

    # Right single rotation
    # (b a (D c E)) where D and E are RED --> (d (B a c) E)
    #
    #   b              d
    #  / \            / \
    # a   D    ->    B   E
    #    / \        / \
    #   c   E      a   c
    #
    # Left single rotation
    # (d (B A c) e) where A and B are RED --> (b A (D c e))
    #
    #     d          b
    #    / \        / \
    #   B   e  ->  A   D
    #  / \            / \
    # A   c          c   e
    #
    def rotate(dir)
      new_root = child(~dir)
      node = new_child(~dir, new_root.child(dir), new_root.color)
      new_root.new_children(dir, node, new_root.child(~dir), @color)
    end

    # Pull up red nodes
    # (b (A C)) where A and C are RED --> (B (a c))
    #
    #   b          B
    #  / \   ->   / \
    # A   C      a   c
    #
    # @Overrides
    def pullup_red
      if black? and @left.red? and @right.red?
        new_children(LEFT, @left.new_color(:BLACK), @right.new_color(:BLACK), :RED)
      else
        self
      end
    end

    # rebalance when the left/right sub-tree is 1 level higher than the right/left
    # move 1 black from the left to the right by single/double rotation
    #
    # precondition: self is black and @left/@right is red
    def rebalance_for_insert(dir)
      node = self
      if child(dir).child(~dir).red?
        node = new_child(dir, child(dir).rotate(dir))
      end
      node.rotate(~dir)
    end

  private

    # @Overrides
    def delete_node
      rebalance = false
      if @left.empty? and @right.empty?
        # just remove this node and ask rebalance to the parent
        new_node = EMPTY_CONCURRENT
        if black?
          rebalance = true
        end
      elsif @left.empty? or @right.empty?
        # pick the single children
        new_node = @left.empty? ? @right : @left
        if black?
          # keep the color black
          raise 'should not happen' unless new_node.red?
          new_node = new_node.new_color(@color)
        else
          # just remove the red node
        end
      else
        # pick the minimum node from the right sub-tree and replace self with it
        deleted, right, rebalance = @right.delete_min
        new_node = deleted.new_children(LEFT, @left, right, @color)
        if rebalance
          new_node, rebalance = new_node.rebalance_for_delete(RIGHT)
        end
      end
      [new_node, rebalance]
    end

    class EmptyConcurrentNode < EmptyNode
      # @Overrides
      def insert(key, value)
        ConcurrentNode.new(key, value, self, self)
      end
    end
    EMPTY_CONCURRENT = ConcurrentNode::EmptyConcurrentNode.new.freeze
  end

  def initialize(default = DEFAULT, &block)
    super
    @root = Atomic.new(ConcurrentNode::EMPTY_CONCURRENT)
  end

  def root
    @root.get
  end

  def empty?
    root == ConcurrentNode::EMPTY_CONCURRENT
  end

  def clear
    @root.set(ConcurrentNode::EMPTY_CONCURRENT)
  end

  def []=(key, value)
    @root.update { |root|
      root = root.insert(key, value)
      root.set_root
      root.check_height if $DEBUG
      root
    }
  end
  alias insert []=

  def [](key)
    value = @root.get.retrieve(key)
    if value == Node::UNDEFINED
      default_value
    else
      value
    end
  end

  def delete(key)
    deleted = nil
    @root.update { |root|
      deleted, root, rebalance = root.delete(key)
      unless root == ConcurrentNode::EMPTY_CONCURRENT
        root.set_root
        root.check_height if $DEBUG
      end
      root
    }
    deleted.value
  end
end