min_max 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d739946dcb0939e2e05893222c927f4dea0eda65da5c0a00156402de3e49c29
-  data.tar.gz: 61b4453a94b93bb2ccefd0787a751cef5d3ef380ac0ed591c73c3b0afddc394b
+  metadata.gz: 2b43d258b5b9ccddc81016bb4c69c186df448ab7c51ae712f136ceed6218a145
+  data.tar.gz: 8c22dd5c5ac6ced73a789dc6813f62bc51168e3e48e2e2ca1b689187be7af8ac
 SHA512:
-  metadata.gz: 70dd4402ca82a60cffbc451ea134ca9fc34391f28311d23726d22055bfc01db9ba62002f0d54c76282888993613f2bf5618dcfa7a964da39c6995747401f3a3f
-  data.tar.gz: 31ada4f8ed50624701e389c6a1d50b83b75a585ef703d2f18c6511498dc9373647fa1f88d959ccdcbf56336d38dc550e1ce96710644f65970f2341549f843d53
+  metadata.gz: b02f4bdcbe8d60e8e2dfba61218a7958e8d97dd54a8939a0befcd363c796e049f11b7f7f58e014c8f8ead40773ea4ad9695fc69a89022e0bec6ac738ae4968ac
+  data.tar.gz: b55fc832a26ce35e955e275ea812b64de15f541fea714a57e107f078d287e3436a76a041a6152863ea1b9680282c0864096cb7784f1aaed525cf5b253b989465

data/README.md

@@ -1,8 +1,8 @@
 # MinMax Heap
 
-The MinMax Heap gem provides a high-performance minmax heap implementation for Ruby, written in Rust. 
+The MinMax Heap gem provides a high-performance minmax heap implementation for Ruby, written in Rust.
 The gem wraps the excellent [min-max-heap-rs](https://github.com/tov/min-max-heap-rs) Rust library.
-It allows for the creation of a min-max-heap and supporting operations like pushing and popping multiple items, iterating over heap items, and converting heaps to arrays. 
+It allows for the creation of a min-max-heap and supporting operations like pushing and popping multiple items, iterating over heap items, and converting heaps to arrays.
 
 ## Features
 
@@ -13,9 +13,9 @@ It allows for the creation of a min-max-heap and supporting operations like push
 - Convert heap to array with `#to_a`, `#to_a_asc` and `#to_a_desc`.
 
 ## Prequisites
-- You must have a working Rust compiler installed on your system. 
+- You must have a working Rust compiler installed on your system.
 ```bash
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | 
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs |
 ```
 
 ## Installation
@@ -79,6 +79,21 @@ heap.to_a_desc # => [5, 3, 1]
 heap.to_a # => Heap order
 ```
 
+## Iterate in order
+```ruby
+heap.each_asc   #<Enumerator: ...>
+heap.each_desc  #<Enumerator: ...>
+```
+
+## Peek at min and max items
+```ruby
+heap.peek_min # => 1
+heap.first # => 1
+
+heap.peek_max # => 1
+heap.last # => 1
+```
+
 ## Size
 ```ruby
 heap.size # => 4
@@ -100,3 +115,13 @@ heap.count(item)
 heap.contains?(item)
 ```
 
+## Performance
+You can run the `benchmarks/benchmarks.rb` file inside this repository for comparison to other popular heap libraries:
+* [rb_heap](https://github.com/florian/rb_heap)
+* [algorithms](https://github.com/kanwei/algorithms)
+* [ruby-heap](https://github.com/general-CbIC/ruby-heap)
+* [pqueue](https://github.com/rubyworks/pqueue)
+
+min-max should be the fastest to pop from a large heap, often by a significant margin, while also offering both min and max operations from a single heap.
+Some options are faster at pushing individual items, but the difference is within the same order of magnitude.
+Batch pushing to min-max also significantly increases insert speed.

data/benchmarks/benchmarks.rb

@@ -73,13 +73,13 @@ pqueue = PQueue.new()
 mm_hp = MinMax[]
 
 Benchmark.bm do |x|
-  x.report("push_algos_heap"){ data.each{|d| pqueue.push(d) } }
+  x.report("push_pqueue_heap"){ data.each{|d| pqueue.push(d) } }
   x.report("push_mm_heap"){ data.each{|d| mm_hp.push(d) } }
   x.report("push_mm_heap_batches"){ mm_hp = MinMax[]; data.each_slice(1000){|d| mm_hp.push(*d) } }
 end
 
 Benchmark.bm do |x|
-  x.report("pop_algos_heap"){ 100_000.times{|d| minheap.pop } }
+  x.report("pop_pqueue_heap"){ 100_000.times{|d| pqueue.pop } }
   x.report("pop_mm_heap"){ 100_000.times{|d| mm_hp.pop_min } }
   x.report("pop_mm_heap_batches"){ 1000.times{|d| mm_hp.pop_min(100) } }
 end

data/lib/min_max/version.rb

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

data/lib/min_max.rb

@@ -6,7 +6,7 @@ require_relative "min_max/min_max"
 class MinMax
   class Error < StandardError; end
 
-  attr_reader :priority_blk, :storage, :mtx
+  attr_reader :priority_blk, :storage
 
   def self.[](*args, &blk)
     new(*args, &blk)
@@ -16,8 +16,7 @@ class MinMax
     self._new.tap{|s|
       s.instance_eval{
         @priority_blk = (blk || proc{|x| x.respond_to?(:priority) ? x.priority : x.to_i })
-        @storage = Hash.new{|h,k| h[k] = [0, nil] }
-        @mtx  ||= Mutex.new
+        @storage = Hash.new{|h,k| h[k] = [0, nil] }.compare_by_identity
       }
       s.push(*args)
     }
@@ -25,13 +24,13 @@ class MinMax
 
   def push(*args)
     mapped = args.map do |a|
-      hash = a.hash
-      entry = self.storage[hash]
+      object_id = a.object_id
+      entry = self.storage[object_id]
       entry[0] += 1
       entry[1] ||= a
       [
         (self.priority_blk.call(a) rescue 0),
-        hash
+        object_id
       ]
     end
      _push(mapped)
@@ -51,19 +50,27 @@ class MinMax
     popped.kind_of?(Array) ? popped.map{|p| retrieve(p) } : retrieve(popped)
   end
 
-  def peek_min(*args)
-    peeked = _peek_min(*args)
-    peeked.kind_of?(Array) ? peeked.map{|p| retrieve(p, false) } : retrieve(popped, false)
+  def peek_min
+    retrieve(_peek_min, false)
   end
 
-  def peek_max(*args)
-    peeked = _peek_max(*args)
-    peeked.kind_of?(Array) ? peeked.map{|p| retrieve(p, false) } : retrieve(popped, false)
+  def peek_max
+    retrieve(_peek_max, false)
+  end
+
+  def first
+    peek_min
+  end
+
+  def last
+    peek_max
   end
 
   def each(*args, &blk)
     if block_given?
-      mtx.synchronize { _each(*args).map{|p| blk[retrieve(p, false)] } }
+      _each(*args) do |p|
+        blk[retrieve(p, false)]
+      end
     else
       to_enum(:each, *args)
     end
@@ -74,31 +81,42 @@ class MinMax
   end
 
   def count(val)
-    counts.has_key?(val.hash) ? counts[val.hash] : 0
+    storage.has_key?(val.object_id) ? storage[val.object_id].first : 0
   end
 
   def contains?(val)
-    counts.has_key?(val.hash) && counts[val.hash] > 0
+    storage.has_key?(val.object_id)
   end
 
   def to_a_asc
-    mtx.synchronize { _to_a_asc.map{|p| retrieve(p, false) } }
+    return to_enum(:to_a_asc) unless block_given?
+    _to_a_asc.map{|p| retrieve(p, false) }
   end
 
   def to_a_desc
-    mtx.synchronize { _to_a_desc.map{|p| retrieve(p, false) } }
+    return to_enum(:to_a_desc) unless block_given?
+    _to_a_desc.map{|p| retrieve(p, false) }
+  end
+
+  def each_asc
+    return to_enum(:each_asc) unless block_given?
+    _to_a_asc.each{|p| yield retrieve(p, false) }
+  end
+
+  def each_desc
+    return to_enum(:each_desc) unless block_given?
+    _to_a_desc.map{|p| retrieve(p, false) }
   end
 
   def inspect
-    "MinMax[#{_each.first(10).map{|v| retrieve(v, false).to_s }.join(", ")}#{size > 10 ? ", ..." : ""}]"
+    "MinMax[#{each.first(10).map(&:to_s).join(", ")}#{size > 10 ? ", ..." : ""}]"
   end
 
   private
-  def retrieve(hash, remove=true)
-    entry = self.storage[hash]
-    self.storage.delete(hash) if remove && (entry[0] -= 1) == 0
+  def retrieve(object_id, remove=true)
+    entry = self.storage[object_id]
+    self.storage.delete(object_id) if remove && (entry[0] -= 1) == 0
     entry[1]
   end
 
 end
-

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: min_max
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Wouter Coppieters
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -79,7 +78,6 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/wouterken/min_max
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A min max heap extension for Ruby
 test_files: []