red-black-tree 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291198bed7dd82b504c47b1c6fa047674c9302a7c529d33409d61797a0677929
-  data.tar.gz: ab8b8d513625de270d0126c0c3f1d5d787260b32f1bd0f13927332e9e2640aab
+  metadata.gz: 06ad66aa31594940e116b62cd872c61dc65ebb90964e097d84b4d540e9eefa2d
+  data.tar.gz: 74ae5eae6622755db6e1df89fe03e598e8c9c3bd22ce20ebe363464c60c6f7f6
 SHA512:
-  metadata.gz: aed7c4bd38468df481ebf815605f8564bc66ecfb8b7a53ee5babefaad2f68fc0a08994a9e91922f161f628a23d63eff02e57c7418bd7ce80b6db4f95723aa421
-  data.tar.gz: 2ec1c08f09e3ef1ca7bf608032cfb4a28042e57ec357dd40ee1c8951c64e0c7d944f7900db4bf9acc758513070f5533745e4b6a3fa4477567644de73cc62787c
+  metadata.gz: a17c8c5c6e2aab3cd53736d00ba3367b402450383b9f8a078669887d2590eed699e4d559dd588c18d90a0ce4fcde64b6a4c9aee8fc6452ab2d663e50c79b11bb
+  data.tar.gz: cfcd5d572e43089fce345cab92d8327c3002f6c282f422316dc16d48020672ac8a62f878b33a67d73f55027498df1f36fa5d1f7526f31a943b0860338a7f00c5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.1.9] - 2026-05-10
+
+- Add `Enumerable` to `RedBlackTree`
+- Fix `RedBlackTree#clear!` not detaching nodes
+- Fix `LeafNodeComparable` being prepended to `LeafNode`
+
+## [0.1.8] - 2025-07-26
+
+- Refactor to slim down and de-duplicate some methods
+
 ## [0.1.7] - 2025-01-05
 
 - Change `RedBlackTree#delete!` return value to the deleted node

data/README.md

@@ -1,5 +1,8 @@
 # RedBlackTree
 
+![Version](https://img.shields.io/gem/v/red-black-tree)
+![Build](https://badge.buildkite.com/6ccbd68c23960899d1deafdb4cfaa96f1e8c04ad6e198e193b.svg)
+
 [Red-black tree](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) data structure for Ruby.
 
 ## Installation
@@ -83,20 +86,20 @@ Benchmark.ips do |x|
   x.compare!
 end
 
-#=> ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +YJIT +PRISM [arm64-darwin24]
+#=> ruby 4.0.3 (2026-04-21 revision 85ddef263a) +YJIT +PRISM [arm64-darwin23]
 #=> Warming up --------------------------------------
 #=>         RedBlackTree     1.000 i/100ms
 #=> Array (gradual sort)     1.000 i/100ms
-#=>  Array (single sort)   100.000 i/100ms
+#=>  Array (single sort)    81.000 i/100ms
 #=> Calculating -------------------------------------
-#=>         RedBlackTree     16.684 (± 6.0%) i/s   (59.94 ms/i) -     84.000 in   5.053688s
-#=> Array (gradual sort)      0.270 (± 0.0%) i/s     (3.71 s/i) -      2.000 in   7.418650s
-#=>  Array (single sort)     1.006k (± 2.4%) i/s  (994.28 μs/i) -      5.100k in   5.073834s
-#=>
+#=>         RedBlackTree     12.170 (± 8.2%) i/s   (82.17 ms/i) -     61.000 in   5.023274s
+#=> Array (gradual sort)      0.208 (± 0.0%) i/s     (4.82 s/i) -      2.000 in   9.632733s
+#=>  Array (single sort)    815.762 (± 1.2%) i/s    (1.23 ms/i) -      4.131k in   5.064788s
+#=> 
 #=> Comparison:
-#=>  Array (single sort):     1005.8 i/s
-#=>         RedBlackTree:       16.7 i/s - 60.28x  slower
-#=> Array (gradual sort):        0.3 i/s - 3729.44x  slower
+#=>  Array (single sort):      815.8 i/s
+#=>         RedBlackTree:       12.2 i/s - 67.03x  slower
+#=> Array (gradual sort):        0.2 i/s - 3928.64x  slower
 ```
 
 ### Sort and search 10,000 elements
@@ -119,7 +122,7 @@ Benchmark.ips do |x|
   x.report("RedBlackTree#search") do
     tree = RedBlackTree.new
     sample_data.each { |work| tree << WorkNode.new(work); }
-    raise unless tree.search search_sample
+    raise unless tree.search { |node| node.data == search_sample }
   end
 
   # 1:1 comparison

data/lib/red-black-tree.rb

@@ -6,6 +6,7 @@ require_relative "red_black_tree/node/leaf_node"
 
 class RedBlackTree
   include Utils
+  include Enumerable
 
   # @return [Integer] the number of valid/non-leaf nodes
   attr_reader :size
@@ -106,27 +107,7 @@ class RedBlackTree
       node.parent = target_parent
       node.red!
 
-      while node.parent && node.parent.red? do
-        if node.parent.sibling && node.parent.sibling.red?
-          node.parent.black!
-          node.parent.sibling.black!
-          node.parent.parent.red!
-          node = node.parent.parent
-        else
-          opp_direction = node.opposite_position
-          if node.parent.position == opp_direction
-            rotate_sub_tree! node.parent, opp_direction
-            node = node[opp_direction]
-          end
-
-          opp_direction = node.opposite_position
-          rotate_sub_tree! node.parent.parent, opp_direction
-          node.parent.black!
-          node.parent[opp_direction].red!
-        end
-
-        @root.black!
-      end
+      rebalance_after_insertion! node
     end
 
     node.validate! @root == node
@@ -153,71 +134,11 @@ class RedBlackTree
     original_node = node
 
     if node.children_are_valid?
-      is_root = is_root? node
-
-      successor = node.left
-      successor = successor.left until successor.left.leaf?
-      node.swap_colour_with! successor
-      node.swap_position_with! successor
-      node.swap_position_with! LeafNode.new
-
-      @root = successor if is_root
+      delete_node_with_two_children! node
     elsif node.single_child_is_valid?
-      is_root = is_root? node
-
-      valid_child = node.children.find(&:valid?)
-      valid_child.black!
-      node.swap_position_with! valid_child
-      node.swap_position_with! LeafNode.new
-
-      @root = valid_child if is_root
+      delete_node_with_one_child! node
     elsif node.children_are_leaves?
-      if is_root? node
-        @root = nil
-      elsif node.red?
-        node.swap_position_with! LeafNode.new
-      else
-        loop do
-          if node.sibling && node.sibling.valid? && node.sibling.red?
-            node.parent.red!
-            node.sibling.black!
-            rotate_sub_tree! node.parent, node.position
-          end
-
-          if node.close_nephew && node.close_nephew.valid? && node.close_nephew.red?
-            node.sibling.red! unless node.sibling.leaf?
-            node.close_nephew.black!
-            rotate_sub_tree! node.sibling, node.opposite_position
-          end
-
-          if node.distant_nephew && node.distant_nephew.valid? && node.distant_nephew.red?
-            case node.parent.colour
-            when Node::RED then node.sibling.red!
-            when Node::BLACK then node.sibling.black!
-            end
-            node.parent.black!
-            node.distant_nephew.black!
-            rotate_sub_tree! node.parent, node.position
-
-            break
-          end
-
-          if node.parent && node.parent.red?
-            node.sibling.red! unless node.sibling.leaf?
-            node.parent.black!
-
-            break
-          end
-
-          if node.sibling && !node.sibling.leaf?
-            node.sibling.red!
-          end
-
-          break unless node = node.parent
-        end
-
-        original_node.swap_position_with! LeafNode.new
-      end
+      delete_leaf_node! node, original_node
     end
 
     original_node.tree = nil
@@ -233,6 +154,11 @@ class RedBlackTree
   #
   # @return [RedBlackTree] self
   def clear!
+    traverse_post_order do |node|
+      node.tree = nil
+      node.colour = node.parent = node.left = node.right = nil
+    end
+
     @root = nil
     @size = 0
     @left_most_node = nil
@@ -259,7 +185,7 @@ class RedBlackTree
   alias_method :find, :search
 
   def select &block
-    raise ArgumentError, "block must be provided for select" unless block
+    raise ArgumentError, "block must be provided for select" unless block_given?
 
     _select_by_block block, @root
   end
@@ -270,7 +196,18 @@ class RedBlackTree
   #
   # @return [true, false]
   def include? data
-    !!search(data)
+    !search(data).nil?
+  end
+
+  # Traverses the tree in in-order and yields each node.
+  # When called without a block, returns an {Enumerator}.
+  #
+  # @yield [RedBlackTree::Node] the block to be executed for each node
+  # @return [void, Enumerator]
+  def each &block
+    return enum_for(:each) unless block_given?
+
+    traverse_in_order(&block)
   end
 
   # Traverses the tree in pre-order and yields each node.
@@ -323,16 +260,37 @@ class RedBlackTree
     queue = [@root]
     until queue.empty?
       node = queue.shift
-      next if node.nil? || node.leaf?
-
       block.call node
-      queue << node.left
-      queue << node.right
+      queue << node.left unless node.left.leaf?
+      queue << node.right unless node.right.leaf?
     end
   end
 
   private
 
+  def is_root? node
+    node && @root && node.object_id == @root.object_id
+  end
+
+  def increment_size!
+    @size += 1
+  end
+
+  def decrement_size!
+    @size -= 1
+  end
+
+  def update_left_most_node!
+    unless @root
+      @left_most_node = nil
+      return
+    end
+
+    current = @root
+    current = current.left until current.left.leaf?
+    @left_most_node = current
+  end
+
   # Rotates a (sub-)tree starting from the given node in the given direction.
   #
   # @param node [RedBlackTree::Node] the root node of the sub-tree
@@ -359,12 +317,111 @@ class RedBlackTree
     opp_direction_child
   end
 
+  def rebalance_after_insertion! node
+    while node.parent && node.parent.red? do
+      if node.parent.sibling && node.parent.sibling.red?
+        node.parent.black!
+        node.parent.sibling.black!
+        node.parent.parent.red!
+        node = node.parent.parent
+      else
+        opp_direction = node.opposite_position
+        if node.parent.position == opp_direction
+          rotate_sub_tree! node.parent, opp_direction
+          node = node[opp_direction]
+        end
+
+        opp_direction = node.opposite_position
+        rotate_sub_tree! node.parent.parent, opp_direction
+        node.parent.black!
+        node.parent[opp_direction].red!
+      end
+
+      @root.black!
+    end
+  end
+
+  def delete_node_with_two_children! node
+    is_root = is_root? node
+
+    predecessor = node.left
+    predecessor = predecessor.right until predecessor.right.leaf?
+    node.swap_colour_with! predecessor
+    node.swap_position_with! predecessor
+    node.swap_position_with! LeafNode.new
+
+    @root = predecessor if is_root
+  end
+
+  def delete_node_with_one_child! node
+    is_root = is_root? node
+
+    valid_child = node.children.find(&:valid?)
+    valid_child.black!
+    node.swap_position_with! valid_child
+    node.swap_position_with! LeafNode.new
+
+    @root = valid_child if is_root
+  end
+
+  def delete_leaf_node! node, original_node
+    if is_root? node
+      @root = nil
+    elsif node.red?
+      node.swap_position_with! LeafNode.new
+    else
+      rebalance_after_deletion! node
+      original_node.swap_position_with! LeafNode.new
+    end
+  end
+
+  def rebalance_after_deletion! node
+    loop do
+      if node.sibling && node.sibling.valid? && node.sibling.red?
+        node.parent.red!
+        node.sibling.black!
+        rotate_sub_tree! node.parent, node.position
+      end
+
+      if node.close_nephew && node.close_nephew.valid? && node.close_nephew.red?
+        node.sibling.red! unless node.sibling.leaf?
+        node.close_nephew.black!
+        rotate_sub_tree! node.sibling, node.opposite_position
+      end
+
+      if node.distant_nephew && node.distant_nephew.valid? && node.distant_nephew.red?
+        case node.parent.colour
+        when Node::RED then node.sibling.red!
+        when Node::BLACK then node.sibling.black!
+        end
+        node.parent.black!
+        node.distant_nephew.black!
+        rotate_sub_tree! node.parent, node.position
+
+        break
+      end
+
+      if node.parent && node.parent.red?
+        node.sibling.red! unless node.sibling.leaf?
+        node.parent.black!
+
+        break
+      end
+
+      if node.sibling && !node.sibling.leaf?
+        node.sibling.red!
+      end
+
+      break unless node = node.parent
+    end
+  end
+
   def _search_by_data data, node
     return if node.nil? || node.leaf?
     return node if data == node.data
 
-    mock_node = node.class.new data
-    if mock_node >= node
+    comparison = data <=> node.data
+    if comparison && comparison >= 0
       _search_by_data data, node.right
     else
       _search_by_data data, node.left
@@ -388,27 +445,4 @@ class RedBlackTree
       end
     end
   end
-
-  def is_root? node
-    node && @root && node.object_id == @root.object_id
-  end
-
-  def increment_size!
-    @size += 1
-  end
-
-  def decrement_size!
-    @size -= 1
-  end
-
-  def update_left_most_node!
-    unless @root
-      @left_most_node = nil
-      return
-    end
-
-    current = @root
-    current = current.left until current.left.leaf?
-    @left_most_node = current
-  end
 end

data/lib/red_black_tree/node/left_right_element_referencers.rb

@@ -4,20 +4,27 @@ class RedBlackTree
   class Node
     module LeftRightElementReferencers # @private
       def [] direction
+        validate_direction! direction
         case direction
         when Node::LEFT then @left
         when Node::RIGHT then @right
-        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}, got #{direction}"
         end
       end
 
       def []= direction, node
+        validate_direction! direction
         case direction
         when Node::LEFT then @left = node
         when Node::RIGHT then @right = node
-        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}, got #{direction}"
         end
       end
+
+      private
+
+      def validate_direction! direction
+        return if [Node::LEFT, Node::RIGHT].include?(direction)
+        raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}, got #{direction}"
+      end
     end
   end
 end

data/lib/red_black_tree/node.rb

@@ -9,7 +9,7 @@ class RedBlackTree
   class Node
     class << self
       def inherited subclass
-        subclass.prepend LeafNodeComparable
+        subclass.prepend LeafNodeComparable unless subclass == ::RedBlackTree::LeafNode
       end
     end
 

data/lib/red_black_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedBlackTree
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: red-black-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 email:
 - djry1999@gmail.com
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Red-Black Tree Data Structure for Ruby
 test_files: []