rbtree-ruby 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327862d13e55ed6406023e1d10676e4b5e94541c59400d9205380af08822e4bf
-  data.tar.gz: 465e1a514390286bf0165db4dfa9f25ada4cd3d1410b0115b11eba15b03dcf33
+  metadata.gz: 2145d91a96cc64b7e65c65460716b678301f74d6decdffa2dbd077a914273c21
+  data.tar.gz: 66503c542ce07672a493830afbfcb66ebfea14d8563e67b1b2dd1d5ecd1d9c48
 SHA512:
-  metadata.gz: 1f354523b8fb78b746cf256949887b89184ce1dcd190403a7024949cded391de24ce6f932720a58ae24592b4b453f3901b1896c9904f546aa03fe4b1524698c2
-  data.tar.gz: e1219a20ea771f3fe1ca2fc160d737c787a1a0e81cb5389b63f320dcd1d2ac9d2cc71d9df2b9698d73afc98069f76d39285ca8106691f0025f1d5a5fa8b6bf91
+  metadata.gz: 7befca8277d78b75242a443c2ec155bded73f899222b32330c6416e6ffeaad8ec6bca01e11ce23c6047208871cf71cfb8c6a742732b4ae0b531f54e51a8e424e
+  data.tar.gz: eb77127897b535277717575afe27c47cd087ba15685f59b0df67516c55d393a8d7412cf08d667cea5494978746967c098294bb73e8e9771c2aee363762afcca9

data/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.3] - 2026-01-23
+
+### Optimized
+- **find_successor_node**: Optimized performance for scans starting from the beginning (or before `min_key`) when the `safe: true` option is used. Added a fast-path (short-circuit) when the given key is smaller than `min_key`.
+
+### Fixed
+- **MultiRBTree Aliases**: Fixed `delete`, `get`, and `[]` aliases in `MultiRBTree`. They now correctly point to the overridden methods in the derived class, ensuring correct value handling and size tracking.
+- **enum_for Syntax**: Syntactic corrections for `enum_for` to ensure robust keyword argument handling in enumerators.
+
 ## [0.3.2] - 2026-01-15
 
 ### Added

data/README.ja.md

@@ -6,11 +6,14 @@ Red-Black Tree（赤黒木）データ構造のピュアRuby実装です。挿
 
 ## 特徴
 
-- **自己平衡二分探索木**: 赤黒木の性質により最適なパフォーマンスを維持
-- **順序付き操作**: 効率的な範囲クエリ、最小/最大値の取得、ソート済みイテレーション
-- **複数値サポート**: `MultiRBTree`クラスで同一キーに複数の値を格納可能
-- **ピュアRuby**: C拡張不要、あらゆるRuby実装で動作
-- **充実したドキュメント**: 使用例付きの包括的なRDocドキュメント
+- **自己平衡二分探索木**: 赤黒木の性質により最適なパフォーマンスを維持。挿入・削除・検索がすべてO(log n)。
+- **順序付き操作**: ソート済みイテレーション、範囲クエリ（lt, gt, between）、最小/最大値取得が高速に実行可能。
+- **複数値サポート**: `MultiRBTree`クラスで同一キーに複数の値を格納。値は挿入順に保持され、最初または最後の値を個別にアクセス可能。
+- **ピュアRuby**: C拡張不要。MRI, JRuby, TruffleRubyなどあらゆるRuby実装で動作。
+- **ハイブリッドインデックス**: 内部ハッシュインデックスにより、キー検索と存在確認がO(1)の超高速アクセスを実現。
+- **メモリ効率**: ノードプールによるオブジェクト再利用と自動縮小機能でGC負荷を大幅に削減。長時間実行アプリにも適応。
+- **最近傍検索**: 数値キーに対して、最も近いキーペアをO(log n)で効率的に探索。
+- **安全なイテレーション**: `safe: true`オプションにより、イテレーション中に他の操作（削除・挿入）を安全に実行可能。
 
 ## インストール
 

data/README.md

@@ -6,11 +6,14 @@ A pure Ruby implementation of the Red-Black Tree data structure, providing effic
 
 ## Features
 
-- **Self-Balancing Binary Search Tree**: Maintains optimal performance through red-black tree properties
-- **Ordered Operations**: Efficient range queries, min/max retrieval, and sorted iteration
-- **Multi-Value Support**: `MultiRBTree` class for storing multiple values per key
-- **Pure Ruby**: No C extensions required, works on any Ruby implementation
-- **Well-Documented**: Comprehensive RDoc documentation with examples
+- **Self-Balancing Binary Search Tree**: Maintains optimal performance through red-black tree properties. All insertions, deletions, and lookups run in O(log n).
+- **Ordered Operations**: Efficient sorted iteration, range queries (`lt`, `gt`, `between`), min/max retrieval.
+- **Multi-Value Support**: `MultiRBTree` class stores multiple values per key, with access to first or last value individually.
+- **Pure Ruby**: No C extensions required. Works on MRI, JRuby, TruffleRuby, and all Ruby implementations.
+- **Hybrid Indexing**: Internal hash index enables O(1) key lookup and membership checks — matching standard Hash performance.
+- **Memory Efficiency**: Node recycling with auto-shrinking pool (`AutoShrinkNodePool`) drastically reduces GC pressure in long-running apps.
+- **Nearest Key Search**: Finds the closest numeric key in O(log n) time — ideal for spatial or temporal queries.
+- **Safe Iteration**: Use `safe: true` to safely modify the tree (insert/delete) during iteration.
 
 ## Installation
 

data/lib/rbtree/version.rb

@@ -2,5 +2,5 @@
 
 class RBTree
   # The version of the rbtree-ruby gem
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/rbtree.rb

@@ -432,7 +432,7 @@ class RBTree
   #     tree.delete(k) if k.even?
   #   end
   def keys(reverse: false, safe: false, &block)
-    return enum_for(:keys, reverse: reverse, safe: safe) { @key_count } unless block_given?
+    return enum_for(__method__, reverse: reverse, safe: safe) { @key_count } unless block_given?
     each(reverse: reverse, safe: safe) { |key, _| yield key }
     self
   end
@@ -459,7 +459,7 @@ class RBTree
   #     tree.delete(k) if k.even?
   #   end
   def each(reverse: false, safe: false, &block)
-    return enum_for(:each, reverse: reverse, safe: safe) { size } unless block_given?
+    return enum_for(__method__, reverse: reverse, safe: safe) { size } unless block_given?
     if reverse
       traverse_all_desc(@root, safe: safe, &block)
     else
@@ -488,7 +488,7 @@ class RBTree
   # @return [Enumerator, RBTree] an Enumerator if no block is given, self otherwise
   # @see #each
   def reverse_each(safe: false, &block)
-    return enum_for(:reverse_each, safe: safe) { size } unless block_given?
+    return enum_for(__method__, safe: safe) { size } unless block_given?
     each(reverse: true, safe: safe, &block)
   end
 
@@ -505,7 +505,7 @@ class RBTree
   #   tree.lt(3, reverse: true).first  # => [2, "two"]
   #   tree.lt(3, safe: true) { |k, _| tree.delete(k) if k.even? }  # safe to delete
   def lt(key, reverse: false, safe: false, &block)
-    return enum_for(:lt, key, reverse: reverse, safe: safe) unless block_given?
+    return enum_for(__method__, key, reverse: reverse, safe: safe) unless block_given?
     if reverse
       traverse_lt_desc(@root, key, safe: safe, &block)
     else
@@ -526,7 +526,7 @@ class RBTree
   #   tree.lte(3).to_a  # => [[1, "one"], [2, "two"], [3, "three"]]
   #   tree.lte(3, reverse: true).first  # => [3, "three"]
   def lte(key, reverse: false, safe: false, &block)
-    return enum_for(:lte, key, reverse: reverse, safe: safe) unless block_given?
+    return enum_for(__method__, key, reverse: reverse, safe: safe) unless block_given?
     if reverse
       traverse_lte_desc(@root, key, safe: safe, &block)
     else
@@ -547,7 +547,7 @@ class RBTree
   #   tree.gt(2).to_a  # => [[3, "three"], [4, "four"]]
   #   tree.gt(2, reverse: true).first  # => [4, "four"]
   def gt(key, reverse: false, safe: false, &block)
-    return enum_for(:gt, key, reverse: reverse, safe: safe) unless block_given?
+    return enum_for(__method__, key, reverse: reverse, safe: safe) unless block_given?
     if reverse
       traverse_gt_desc(@root, key, safe: safe, &block)
     else
@@ -568,7 +568,7 @@ class RBTree
   #   tree.gte(2).to_a  # => [[2, "two"], [3, "three"], [4, "four"]]
   #   tree.gte(2, reverse: true).first  # => [4, "four"]
   def gte(key, reverse: false, safe: false, &block)
-    return enum_for(:gte, key, reverse: reverse, safe: safe) unless block_given?
+    return enum_for(__method__, key, reverse: reverse, safe: safe) unless block_given?
     if reverse
       traverse_gte_desc(@root, key, safe: safe, &block)
     else
@@ -592,7 +592,7 @@ class RBTree
   #   tree.between(2, 4).to_a  # => [[2, "two"], [3, "three"], [4, "four"]]
   #   tree.between(2, 4, reverse: true).first  # => [4, "four"]
   def between(min, max, include_min: true, include_max: true, reverse: false, safe: false, &block)
-    return enum_for(:between, min, max, include_min: include_min, include_max: include_max, reverse: reverse, safe: safe) unless block_given?
+    return enum_for(__method__, min, max, include_min: include_min, include_max: include_max, reverse: reverse, safe: safe) unless block_given?
     if reverse
       traverse_between_desc(@root, min, max, include_min, include_max, safe: safe, &block)
     else
@@ -1194,6 +1194,8 @@ class RBTree
   # @param key [Object] the reference key
   # @return [Node] the successor node, or @nil_node if none exists
   def find_successor_node(key)
+    # If key is smaller than min_key, return min_node
+    return @min_node if min_key && key < min_key
     # Check if key exists using O(1) hash lookup
     if (node = @hash_index[key])
       # Key exists: find successor in subtree or ancestors
@@ -1496,6 +1498,8 @@ class MultiRBTree < RBTree
   #   tree.get(1)              # => "first"
   #   tree.get(1, last: true)  # => "second"
   def value(key, last: false) = @hash_index[key]&.value&.send(last ? :last : :first)
+  alias :get :value
+  alias :[] :value
 
   # Retrieves the first value associated with the given key.
   #
@@ -1521,7 +1525,7 @@ class MultiRBTree < RBTree
   #   tree.insert(1, 'second')
   #   tree.values(1).to_a   # => ["first", "second"]
   def values(key, reverse: false)
-    return enum_for(:values, key) { value_count(key) } unless block_given?
+    return enum_for(__method__, key) { value_count(key) } unless block_given?
     @hash_index[key]&.value&.send(reverse ? :reverse_each : :each) { |v| yield v }
   end
   alias :get_all :values
@@ -1622,6 +1626,7 @@ class MultiRBTree < RBTree
     delete_indexed_node(z.key)
     value
   end
+  alias :delete :delete_key
 
   # Removes and returns the first key-value pair.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbtree-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Masahito Suzuki