red-black-tree 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f43951dbc99839bcb925622284650c9f5ec3dbe3fa709706fac32345bbe1607
-  data.tar.gz: 8d1d5cdc4420b9e29012ed4a16054f0bede9b9239327605151f97efc123d0636
+  metadata.gz: e609f03254a0ff34b07adf5445e91803cf4f50ffc5ba91b6288c31003218b87a
+  data.tar.gz: e1289ab4cefa28f5ae2eca05be45d5a7dbd2fa13a8a5256c81ac21511bb8e0fb
 SHA512:
-  metadata.gz: b3f59b93fc6d1f5e10081f5f72d9c8346c4e117badc7f3ac5d694bac07308c511fc3ed71cb4b250c5d790fd6d77f13b219fd1d9accbd7120783147862ce52045
-  data.tar.gz: 42d421b0ab688c03ea073ef34d460ed42cb3de4f14b5aa13ec4f243bf71fbc65533da0a2a7ee390ea33fc5828549bc62f514f3a592c0f42d179f3d4a693c6ab2
+  metadata.gz: 514eee78de1f75f5caaa55d285109d5e64a431a95732b3e6cabbee23e523ddd93b8b1e5e996c4ebcebce86e0ac54a15e0b88299a295515ce592254706f905e1a
+  data.tar.gz: '092aaa352db1d9d8d1082393bfff927c35dbb349ffc980720835379c27297f7d47f817edb2eb29a22103bc4beda53c683150b05756444d75b823e673161358e1'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-09-08
+
+- Fix a bunch of issues in `RedBlackTree#insert!` and `RedBlackTree#delete!` algorithms
+- Fix `RedBlackTree::LeafNode`s being marked red
+- Handle comparison with `RedBlackTree::LeafNode` in subclasses of `RedBlackTree::Node`
+- Add `RedBlackTree#include?`
+- Add `RedBlackTree#search`
+- Alias `RedBlackTree#left_most_node` as `RedBlackTree#min`
+
+## [0.1.1] - 2024-08-04
+
+- Update `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` in README
+
 ## [0.1.0] - 2024-08-04
 
 - Initial release

data/README.md

@@ -6,31 +6,28 @@
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add red-black-tree
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install red-black-tree
 
 ## Usage
 
 ```ruby
 Work = Struct.new :min_latency, keyword_init: true
 
+# Needs to be implemented by you
 class WorkNode < RedBlackTree::Node
   def <=> other
-    if other.instance_of? RedBlackTree::LeafNode
-      1
-    else
-      self.data.min_latency <=> other.data.min_latency
-    end
+    self.data.min_latency <=> other.data.min_latency
   end
 end
 
 tree = RedBlackTree.new
 
-tree << WorkNode.new(Work.new min_latency: 1.2)
 tree << WorkNode.new(Work.new min_latency: 0.8)
+tree << WorkNode.new(Work.new min_latency: 1.2)
 tree << WorkNode.new(Work.new min_latency: 0.8)
 tree << WorkNode.new(Work.new min_latency: 0.4)
 
@@ -40,6 +37,17 @@ until tree.empty?
 end
 ```
 
+## WIP Features
+
+- `RedBlackTree#traverse_in_order`
+- `RedBlackTree#traverse_pre_order`
+- `RedBlackTree#traverse_post_order`
+- `RedBlackTree#traverse_level_order`
+- `RedBlackTree#traverse` (default in-order)
+- `RedBlackTree#max`
+- `RedBlackTree#height`
+- `RedBlackTree#clear`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the

data/lib/red-black-tree.rb

@@ -17,6 +17,7 @@ class RedBlackTree
   # @private
   # @return [RedBlackTree::Node, nil] the left most node
   attr_reader :left_most_node
+  alias_method :min, :left_most_node
 
   def initialize
     @size = 0
@@ -41,8 +42,13 @@ class RedBlackTree
   #
   # @return [RedBlackTree::Node, nil] the removed node
   def shift
-    node = @left_most_node
-    delete! node if node
+    return unless @left_most_node
+
+    node = @left_most_node.dup
+    node.colour = node.parent = node.left = node.right = nil
+
+    delete! @left_most_node
+
     node
   end
 
@@ -85,8 +91,6 @@ class RedBlackTree
       raise ArgumentError, "Target parent already has #{direction} child" if (child = target_parent[direction]) && child.valid?
     end
 
-    opp_direction = opposite_direction direction if direction
-
     node.parent = nil
     node.left = LeafNode.new
     node.left.parent = node
@@ -108,17 +112,16 @@ class RedBlackTree
           node.parent.parent.red!
           node = node.parent.parent
         else
-          if node.position == direction
-            node = node.parent
-            rotate_sub_tree! node, opp_direction
+          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!
-
-          if node.parent.parent
-            node.parent.parent.red!
-            rotate_sub_tree! node.parent.parent, direction
-          end
+          node.parent[opp_direction].red!
         end
 
         @root.black!
@@ -140,6 +143,8 @@ class RedBlackTree
   def delete! node
     raise ArgumentError, "cannot delete leaf node" if node.instance_of? LeafNode
 
+    original_node = node
+
     if node.children_are_valid?
       successor = node.left
       successor = successor.left until successor.left.leaf?
@@ -160,19 +165,19 @@ class RedBlackTree
       if is_root? node
         @root = nil
       elsif node.red?
-        leaf = LeafNode.new
-        node.swap_position_with! leaf
+        node.swap_position_with! LeafNode.new
       else
-        direction = node.position
-        opp_direction = opposite_direction direction
-
         loop do
-          if node.sibling.valid? && node.sibling.red?
+          if node.sibling && node.sibling.valid? && node.sibling.red?
             node.parent.red!
             node.sibling.black!
-            rotate_sub_tree! node.parent, direction
+            rotate_sub_tree! node.parent, node.position
+          end
 
-            next
+          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?
@@ -182,35 +187,30 @@ class RedBlackTree
             end
             node.parent.black!
             node.distant_nephew.black!
-            rotate_sub_tree! node.parent, direction
+            rotate_sub_tree! node.parent, node.position
 
             break
           end
 
-          if node.close_nephew && node.close_nephew.valid? && node.close_nephew.red?
-            node.sibling.red!
-            node.close_nephew.black!
-            rotate_sub_tree! node.sibling, opp_direction
+          if node.parent && node.parent.red?
+            node.sibling.red! unless node.sibling.leaf?
+            node.parent.black!
 
-            next
+            break
           end
 
-          if node.parent.red?
+          if node.sibling && !node.sibling.leaf?
             node.sibling.red!
-            node.parent.black!
-
-            break
           end
 
-          break
+          break unless node = node.parent
         end
 
-        leaf = LeafNode.new
-        node.swap_position_with! leaf
+        original_node.swap_position_with! LeafNode.new
       end
     end
 
-    node.validate_free!
+    original_node.validate_free!
 
     decrement_size!
     update_left_most_node!
@@ -218,12 +218,25 @@ class RedBlackTree
     self
   end
 
-  private
+  # Searches for a node which matches the given data/value.
+  #
+  # @param data [any] the data to search for
+  # @return [RedBlackTree::Node, nil] the matching node
+  def search data
+    raise ArgumentError, "data must be provided for search" unless data
 
-  def is_root? node
-    node.object_id == @root.object_id
+    _search data, @root
   end
 
+  # Returns true if there is a node which matches the given data/value, and false if there is not.
+  #
+  # @return [true, false]
+  def include? data
+    !!search(data)
+  end
+
+  private
+
   # Rotates a (sub-)tree starting from the given node in the given direction.
   #
   # @param node [RedBlackTree::Node] the root node of the sub-tree
@@ -250,6 +263,22 @@ class RedBlackTree
     opp_direction_child
   end
 
+  def _search data, current_node
+    return if current_node.nil? || current_node.leaf?
+    return current_node if data == current_node.data
+
+    mock_node = current_node.class.new data
+    if mock_node >= current_node
+      _search data, current_node.right
+    else
+      _search data, current_node.left
+    end
+  end
+
+  def is_root? node
+    node && @root && node.object_id == @root.object_id
+  end
+
   def increment_size!
     @size += 1
   end

data/lib/red_black_tree/node/leaf_node_comparable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class RedBlackTree
+  module LeafNodeComparable # @private
+    def <=> other
+      if other.instance_of? ::RedBlackTree::LeafNode
+        1
+      else
+        super
+      end
+    end
+  end
+end

data/lib/red_black_tree/node.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require_relative "utils"
+require_relative "node/leaf_node_comparable"
 require_relative "node/left_right_element_referencers"
 
 class RedBlackTree
   class Node
+    class << self
+      def inherited subclass
+        subclass.prepend LeafNodeComparable
+      end
+    end
+
     include Comparable
 
     # @return [any] the data/value representing the node
@@ -42,8 +49,8 @@ class RedBlackTree
       RIGHT = "right"
       DIRECTIONS = [LEFT, RIGHT].freeze
 
-      attr_reader :colour
       attr_writer :data
+      attr_accessor :colour
       attr_accessor :tree, :parent
       attr_accessor :left, :right
       include LeftRightElementReferencers
@@ -65,9 +72,9 @@ class RedBlackTree
       def position
         return unless @parent
 
-        case self
-        when @parent.left then LEFT
-        when @parent.right then RIGHT
+        case self.object_id
+        when @parent.left.object_id then LEFT
+        when @parent.right.object_id then RIGHT
         else raise StructuralError, "Disowned by parent"
         end
       end
@@ -140,13 +147,13 @@ class RedBlackTree
         self_position = position
         other_position = other_node.position
 
-        if other_node.parent == self
+        if other_node.parent.object_id == self.object_id
           self[other_position] = other_node[other_position]
           other_node[other_position] = self
 
           other_node.parent = @parent
           @parent = other_node
-        elsif other_node == @parent
+        elsif other_node.object_id == @parent.object_id
           other_node[self_position] = self[self_position]
           self[self_position] = other_node
 

data/lib/red_black_tree/version.rb

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

data/red-black-tree.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
-  spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["documentation_uri"] = "https://joshuay03.github.io/red-black-tree/"
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-black-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Joshua Young
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-03 00:00:00.000000000 Z
+date: 2024-09-14 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -24,6 +24,7 @@ files:
 - lib/red-black-tree.rb
 - lib/red_black_tree/node.rb
 - lib/red_black_tree/node/leaf_node.rb
+- lib/red_black_tree/node/leaf_node_comparable.rb
 - lib/red_black_tree/node/left_right_element_referencers.rb
 - lib/red_black_tree/utils.rb
 - lib/red_black_tree/version.rb
@@ -32,7 +33,6 @@ homepage: https://github.com/joshuay03/red-black-tree
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/joshuay03/red-black-tree
   documentation_uri: https://joshuay03.github.io/red-black-tree/
   source_code_uri: https://github.com/joshuay03/red-black-tree
   changelog_uri: https://github.com/joshuay03/red-black-tree/blob/main/CHANGELOG.md