red-black-tree 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da41036d61ffc0739627740b631dbb00df76ee87a5db6145ad508569552703c3
-  data.tar.gz: 99172cd947f7714788dadd94068ff637bdfa510ae78367a4689a892dc4ad1a05
+  metadata.gz: e7cc7e3138c1b0ceea2d6b5a2f91620323f75ebe346288bc69761d77d95eb5c4
+  data.tar.gz: 057d9d283d5312f6c5f8e155e3c039c342d036b779d115738c7afbc57ca419f4
 SHA512:
-  metadata.gz: 96e4b84d481b71cf8f3e45b728d19c1417f50c68ea9a9b8acdbd35a3514c8ab154df42ef7b3542ff0655e45c76a2f39b2a4a7ad6131a2c238fd7b126bddc29bd
-  data.tar.gz: 54a7743f84d5748e830dee7ed27c66f34c9517d4977b496c74cc6aa194b0fbef175f5ad7bd3d7420ce64f68298ff4bf529b9d1664966c94007db5fd1cc76d35d
+  metadata.gz: 61f4a9a44d3949b3c2072de4fbca1507cf78306adc32dae8bad26ec5a71171ae952cb81effddf41990a8e2b6dc0e06d39a121389e5bc4c3438eca981dc2a0b59
+  data.tar.gz: c9bced3565a3ec9439c1c08dca09676d1c3966cb18a97507c1f815e938b73419f9f3bce0e4d13d06e97dc59a92f845a3b9b4f094841aa900bde3b004959baeca

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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
+- Add `RedBlackTree#clear!`
+
 ## [0.1.6] - 2025-01-01
 
 - Prefer node deletion over data swapping

data/README.md

@@ -1,5 +1,8 @@
 # RedBlackTree
 
+![Version](https://img.shields.io/gem/v/red-black-tree)
+![Build](https://img.shields.io/github/actions/workflow/status/joshuay03/red-black-tree/.github/workflows/tests.yml?branch=main)
+
 [Red-black tree](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) data structure for Ruby.
 
 ## Installation
@@ -187,7 +190,6 @@ end
 
 - `RedBlackTree#max`
 - `RedBlackTree#height`
-- `RedBlackTree#clear`
 
 ## Development
 

data/lib/red-black-tree.rb

@@ -20,6 +20,7 @@ class RedBlackTree
 
   def initialize
     @size = 0
+    @root = nil
     @left_most_node = nil
   end
 
@@ -90,6 +91,7 @@ class RedBlackTree
       raise ArgumentError, "Target parent already has #{direction} child" if (child = target_parent[direction]) && child.valid?
     end
 
+    node.tree = self
     node.parent = nil
     node.left = LeafNode.new
     node.left.parent = node
@@ -104,27 +106,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
@@ -138,99 +120,43 @@ class RedBlackTree
   # Removes the given node from the tree.
   #
   # @param node [RedBlackTree::Node] the node to be removed
-  # @return [RedBlackTree] self
+  # @return [RedBlackTree::Node, nil] the removed node
   def delete! node
     raise ArgumentError, "cannot delete leaf node" if node.instance_of? LeafNode
 
+    if node.tree.nil?
+      return
+    elsif node.tree != self
+      raise ArgumentError, "node does not belong to this tree"
+    end
+
     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
-
-      original_node.validate_free!
-
-      decrement_size!
-      update_left_most_node!
-
-      return self
+      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
-
-      original_node.validate_free!
-
-      decrement_size!
-      update_left_most_node!
-
-      return self
+      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
     original_node.validate_free!
 
     decrement_size!
     update_left_most_node!
 
+    original_node
+  end
+
+  # Removes all nodes from the tree.
+  #
+  # @return [RedBlackTree] self
+  def clear!
+    @root = nil
+    @size = 0
+    @left_most_node = nil
+
     self
   end
 
@@ -264,7 +190,7 @@ class RedBlackTree
   #
   # @return [true, false]
   def include? data
-    !!search(data)
+    !search(data).nil?
   end
 
   # Traverses the tree in pre-order and yields each node.
@@ -327,6 +253,29 @@ class RedBlackTree
 
   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
@@ -353,12 +302,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
+
+    successor = node.left
+    successor = successor.right until successor.right.leaf?
+    node.swap_colour_with! successor
+    node.swap_position_with! successor
+    node.swap_position_with! LeafNode.new
+
+    @root = successor 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
@@ -382,27 +430,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

@@ -19,6 +19,9 @@ class RedBlackTree
     # @return [any] the data/value representing the node
     attr_reader :data
 
+    # @return [RedBlackTree::Node, nil] the tree this node belongs to
+    attr_reader :tree
+
     # @param data [any] a non-nil data/value representing the node
     # @return [Node] a new instance of Node
     def initialize data
@@ -51,10 +54,8 @@ class RedBlackTree
       RIGHT = "right"
       DIRECTIONS = [LEFT, RIGHT].freeze
 
-      attr_writer :data
-      attr_accessor :colour
-      attr_accessor :tree, :parent
-      attr_accessor :left, :right
+      attr_writer :data, :tree
+      attr_accessor :colour, :parent, :left, :right
       include LeftRightElementReferencers
 
       def red? = @colour == RED
@@ -116,6 +117,8 @@ class RedBlackTree
       end
 
       def validate_free!
+        raise StructuralError, "Node is still chained to a tree" if @tree
+
         anchors = []
         anchors << "parent" if @parent
         anchors << "left child" if @left && @left.valid?

data/lib/red_black_tree/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: red-black-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-01-01 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: 3.6.9
 specification_version: 4
 summary: Red-Black Tree Data Structure for Ruby
 test_files: []