red-black-tree 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da41036d61ffc0739627740b631dbb00df76ee87a5db6145ad508569552703c3
-  data.tar.gz: 99172cd947f7714788dadd94068ff637bdfa510ae78367a4689a892dc4ad1a05
+  metadata.gz: 291198bed7dd82b504c47b1c6fa047674c9302a7c529d33409d61797a0677929
+  data.tar.gz: ab8b8d513625de270d0126c0c3f1d5d787260b32f1bd0f13927332e9e2640aab
 SHA512:
-  metadata.gz: 96e4b84d481b71cf8f3e45b728d19c1417f50c68ea9a9b8acdbd35a3514c8ab154df42ef7b3542ff0655e45c76a2f39b2a4a7ad6131a2c238fd7b126bddc29bd
-  data.tar.gz: 54a7743f84d5748e830dee7ed27c66f34c9517d4977b496c74cc6aa194b0fbef175f5ad7bd3d7420ce64f68298ff4bf529b9d1664966c94007db5fd1cc76d35d
+  metadata.gz: aed7c4bd38468df481ebf815605f8564bc66ecfb8b7a53ee5babefaad2f68fc0a08994a9e91922f161f628a23d63eff02e57c7418bd7ce80b6db4f95723aa421
+  data.tar.gz: 2ec1c08f09e3ef1ca7bf608032cfb4a28042e57ec357dd40ee1c8951c64e0c7d944f7900db4bf9acc758513070f5533745e4b6a3fa4477567644de73cc62787c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [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

data/README.md

@@ -187,7 +187,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
@@ -138,10 +140,16 @@ 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?
@@ -154,13 +162,6 @@ class RedBlackTree
       node.swap_position_with! LeafNode.new
 
       @root = successor if is_root
-
-      original_node.validate_free!
-
-      decrement_size!
-      update_left_most_node!
-
-      return self
     elsif node.single_child_is_valid?
       is_root = is_root? node
 
@@ -170,13 +171,6 @@ class RedBlackTree
       node.swap_position_with! LeafNode.new
 
       @root = valid_child if is_root
-
-      original_node.validate_free!
-
-      decrement_size!
-      update_left_most_node!
-
-      return self
     elsif node.children_are_leaves?
       if is_root? node
         @root = nil
@@ -226,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.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.7"
 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.7
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-01-01 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies: []
 email:
 - djry1999@gmail.com