red-black-tree 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90594d4e04c47851ed0eaa18f0f517c37081a9c52c21ae5d4af66b142e2fdb1
-  data.tar.gz: de26391d21001786ee4f39859ef248985bbb5ca9750187f069219b3fdd72813e
+  metadata.gz: 291198bed7dd82b504c47b1c6fa047674c9302a7c529d33409d61797a0677929
+  data.tar.gz: ab8b8d513625de270d0126c0c3f1d5d787260b32f1bd0f13927332e9e2640aab
 SHA512:
-  metadata.gz: df049ff727c8918d99e255e44977281e378269620d04dbb16e3d6d1990e72416d85c1c42c7815de67d0c2f1366c68db463587d4cdfe56213cc6f45e4476f6648
-  data.tar.gz: dea0e150ee92555bff5af6e81cf81e4df9f75326a3c7e8bfa907c24b17dfa42f13548f113d9ec0b3448127a92794a0059701136eda88cd7c6fe0c44f5a75bfe9
+  metadata.gz: aed7c4bd38468df481ebf815605f8564bc66ecfb8b7a53ee5babefaad2f68fc0a08994a9e91922f161f628a23d63eff02e57c7418bd7ce80b6db4f95723aa421
+  data.tar.gz: 2ec1c08f09e3ef1ca7bf608032cfb4a28042e57ec357dd40ee1c8951c64e0c7d944f7900db4bf9acc758513070f5533745e4b6a3fa4477567644de73cc62787c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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
+
 ## [0.1.5] - 2024-10-28
 
 - Alias `RedBlackTree#search` as `RedBlackTree#find`

data/README.md

@@ -83,20 +83,20 @@ Benchmark.ips do |x|
   x.compare!
 end
 
-#=> ruby 3.3.5 (2024-09-03 revision ef084cc8f4) [arm64-darwin24]
+#=> ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +YJIT +PRISM [arm64-darwin24]
 #=> Warming up --------------------------------------
 #=>         RedBlackTree     1.000 i/100ms
 #=> Array (gradual sort)     1.000 i/100ms
-#=>  Array (single sort)    78.000 i/100ms
+#=>  Array (single sort)   100.000 i/100ms
 #=> Calculating -------------------------------------
-#=>         RedBlackTree      5.417 (± 0.0%) i/s  (184.61 ms/i) -     28.000 in   5.172532s
-#=> Array (gradual sort)      0.268 (± 0.0%) i/s     (3.74 s/i) -      2.000 in   7.473005s
-#=>  Array (single sort)    768.691 (± 2.2%) i/s    (1.30 ms/i) -      3.900k in   5.076337s
+#=>         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
 #=>
 #=> Comparison:
-#=>  Array (single sort):      768.7 i/s
-#=>         RedBlackTree:        5.4 i/s - 141.91x  slower
-#=> Array (gradual sort):        0.3 i/s - 2872.03x  slower
+#=>  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
 ```
 
 ### Sort and search 10,000 elements
@@ -153,41 +153,40 @@ Benchmark.ips do |x|
   x.compare!
 end
 
-#=> ruby 3.3.5 (2024-09-03 revision ef084cc8f4) [arm64-darwin24]
+#=> ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +YJIT +PRISM [arm64-darwin24]
 #=> Warming up --------------------------------------
-#=>  RedBlackTree#search     1.000 i/100ms
+#=>  RedBlackTree#search     3.000 i/100ms
 #=> Array#find (gradual sort)
 #=>                          1.000 i/100ms
 #=> Array#find (single sort)
-#=>                         69.000 i/100ms
+#=>                         95.000 i/100ms
 #=> Array#bsearch (gradual sort)
 #=>                          1.000 i/100ms
 #=> Array#bsearch (single sort)
-#=>                         89.000 i/100ms
+#=>                        108.000 i/100ms
 #=> Calculating -------------------------------------
-#=>  RedBlackTree#search     12.926 (± 0.0%) i/s   (77.36 ms/i) -     65.000 in   5.030736s
+#=>  RedBlackTree#search     42.850 (± 4.7%) i/s   (23.34 ms/i) -    216.000 in   5.049896s
 #=> Array#find (gradual sort)
-#=>                           0.262 (± 0.0%) i/s     (3.81 s/i) -      2.000 in   7.623953s
+#=>                           0.274 (± 0.0%) i/s     (3.65 s/i) -      2.000 in   7.302412s
 #=> Array#find (single sort)
-#=>                         690.631 (± 1.0%) i/s    (1.45 ms/i) -      3.519k in   5.095823s
+#=>                         935.492 (± 2.7%) i/s    (1.07 ms/i) -      4.750k in   5.081415s
 #=> Array#bsearch (gradual sort)
-#=>                           0.267 (± 0.0%) i/s     (3.75 s/i) -      2.000 in   7.492482s
+#=>                           0.275 (± 0.0%) i/s     (3.63 s/i) -      2.000 in   7.269027s
 #=> Array#bsearch (single sort)
-#=>                         895.413 (± 1.7%) i/s    (1.12 ms/i) -      4.539k in   5.070590s
+#=>                          1.104k (± 2.0%) i/s  (905.52 μs/i) -      5.616k in   5.087395s
 #=>
 #=> Comparison:
-#=> Array#bsearch (single sort):      895.4 i/s
-#=> Array#find (single sort):         690.6 i/s - 1.30x  slower
-#=> RedBlackTree#search:               12.9 i/s - 69.27x  slower
-#=> Array#bsearch (gradual sort):       0.3 i/s - 3354.39x  slower
-#=> Array#find (gradual sort):          0.3 i/s - 3412.57x  slower
+#=>  Array#bsearch (single sort):     1104.3 i/s
+#=>     Array#find (single sort):      935.5 i/s - 1.18x  slower
+#=>          RedBlackTree#search:       42.9 i/s - 25.77x  slower
+#=> Array#bsearch (gradual sort):        0.3 i/s - 4013.67x  slower
+#=>    Array#find (gradual sort):        0.3 i/s - 4031.85x  slower
 ```
 
 ## WIP Features
 
 - `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
@@ -138,28 +140,37 @@ 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_data_with! successor
+      node.swap_colour_with! successor
+      node.swap_position_with! successor
+      node.swap_position_with! LeafNode.new
 
-      return delete! successor
+      @root = successor if is_root
     elsif node.single_child_is_valid?
       is_root = is_root? node
 
       valid_child = node.children.find(&:valid?)
-      node.swap_data_with! valid_child
-      node.black!
-
-      @root = node if is_root
+      valid_child.black!
+      node.swap_position_with! valid_child
+      node.swap_position_with! LeafNode.new
 
-      return delete! valid_child
+      @root = valid_child if is_root
     elsif node.children_are_leaves?
       if is_root? node
         @root = nil
@@ -209,11 +220,23 @@ class RedBlackTree
       end
     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
 

data/lib/red_black_tree/node/left_right_element_referencers.rb

@@ -7,7 +7,7 @@ class RedBlackTree
         case direction
         when Node::LEFT then @left
         when Node::RIGHT then @right
-        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}"
+        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}, got #{direction}"
         end
       end
 
@@ -15,7 +15,7 @@ class RedBlackTree
         case direction
         when Node::LEFT then @left = node
         when Node::RIGHT then @right = node
-        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}"
+        else raise ArgumentError, "Direction must be one of #{Implementation::DIRECTIONS}, got #{direction}"
         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?
@@ -125,12 +128,6 @@ class RedBlackTree
         raise StructuralError, "Node is still chained to #{anchors.join(", ")}"
       end
 
-      def swap_data_with! other_node
-        temp_data = @data
-        @data = other_node.data
-        other_node.data = temp_data
-      end
-
       def swap_colour_with! other_node
         temp_colour = @colour
 
@@ -148,27 +145,47 @@ class RedBlackTree
       def swap_position_with! other_node
         self_position = position
         other_position = other_node.position
+        opp_other_position = opposite_direction other_position if other_position
 
         if other_node.parent.object_id == self.object_id
           self[other_position] = other_node[other_position]
           other_node[other_position] = self
 
+          self[other_position].parent = self
           other_node.parent = @parent
+
+          @parent[self_position] = other_node if self_position
           @parent = other_node
-        elsif other_node.object_id == @parent.object_id
-          other_node[self_position] = self[self_position]
-          self[self_position] = other_node
 
-          temp_parent = other_node.parent
-          other_node.parent = self
-          @parent = temp_parent
+          temp_node = self[opp_other_position]
+          self[opp_other_position] = other_node[opp_other_position]
+          other_node[opp_other_position] = temp_node
+
+          self[opp_other_position].parent = self
+          other_node[opp_other_position].parent = other_node
+        elsif other_node.object_id == @parent.object_id
+          other_node.swap_position_with! self
         else
           other_node.parent[other_position] = self if other_node.parent
           @parent[self_position] = other_node if @parent
 
-          temp_parent = other_node.parent
+          temp_node = other_node.parent
           other_node.parent = @parent
-          @parent = temp_parent
+          @parent = temp_node
+
+          temp_node = other_node.left
+          other_node.left = @left
+          @left = temp_node
+
+          @left.parent = self if @left
+          other_node.left.parent = other_node if other_node.left
+
+          temp_node = other_node.right
+          other_node.right = @right
+          @right = temp_node
+
+          @right.parent = self if @right
+          other_node.right.parent = other_node if other_node.right
         end
       end
     end

data/lib/red_black_tree/version.rb

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

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: red-black-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Joshua Young
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - djry1999@gmail.com
 executables: []
@@ -37,7 +35,6 @@ metadata:
   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
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Red-Black Tree Data Structure for Ruby
 test_files: []