pairing_heap 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90dd09750c4fddd39d50f8cc84425b7c88faa7a31912a23e828525dfe1987f1f
-  data.tar.gz: 4710ff54026a0f62b6f8f535a48b3683277534c319832ea4e08de8e122467fd2
+  metadata.gz: afe0b373b7c015091b7d7f19ba3d8d0004d1f7c257aad0fe678cf235dc288541
+  data.tar.gz: d3b93b4741c9255b67f0ca232cb881a32fa965b4390c903c4eda96b992961176
 SHA512:
-  metadata.gz: 9aaf8a8b4a665fa53cc6a1f725e8a743a2bd7a9752ad0e0b0d0f8f7a6efb970693276b7731c778ef3785653595d3cfdd22afbad43511aa3f3dd093739ea74f67
-  data.tar.gz: 495d1219cd93cabefaba75956729f18dbb0a69eb4af9cee4122920e9b260fb0fa3b6d66170c86eb1f398c71049f34f622f75346ade10a0f9ef7093c5ddffeefd
+  metadata.gz: d039d5f4a3b996a5f7b1f3193be96291ffa8d53537e45fa4fb6d61fbb83e9a1b897156c64918da8f08b3f0c78e905ef5e4588598495e3c655319e84a201bb037
+  data.tar.gz: 29669debc6da2984b31e986c63ae36776bd48ccf6febab79d0a8f74b304c1242d65aabeba2b2ff7362476448722c4c52bb6c170a8ebbd857d1c3e930e41a79c4

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['2.3', '2.7', '3.0', '3.1', head, jruby, jruby-head, truffleruby, truffleruby-head]
+        ruby: ['2.7', '3.0', '3.1', '3.2', head, jruby, jruby-head, truffleruby, truffleruby-head]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
@@ -16,6 +16,6 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: |
-        gem install bundler -v 2.2.3
+        gem install bundler -v 2.3.6
         bundle install
         bundle exec rake

data/.standard.yml

@@ -0,0 +1,3 @@
+ruby_version: 3.2.0
+ignore:
+  - 'test/fib.rb'

data/Gemfile.lock

@@ -1,21 +1,63 @@
 PATH
   remote: .
   specs:
-    pairing_heap (0.2.0)
+    pairing_heap (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    docile (1.4.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
     minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.20.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.40.0)
+      rubocop-performance (= 1.15.1)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-darwin-22
 
 DEPENDENCIES
+  codecov (= 0.6.0)
   minitest (~> 5.0)
   pairing_heap!
   rake (~> 13.0)
+  standard (~> 1.20)
 
 BUNDLED WITH
    2.3.6

data/README.md

@@ -1,4 +1,5 @@
 # PairingHeap
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 PairingHeap is a pure Ruby priority queue implementation using a pairing heap as the underlying data structure. While a pairing heap is asymptotically less efficient than the Fibonacci heap, it is usually faster in practice. This makes it a popular choice for Prim's MST or Dijkstra's algorithm implementations.
 
@@ -36,8 +37,8 @@ simple_heap.push(:a, 1)
 simple_heap.push(:b, 2)
 simple_heap.push(:c, 3)
 simple_heap.peek # => :a
-simple_heap.peek_priority # => [:a, 1]
-simple_heap.pop_priority # => [:a, 1]
+simple_heap.peek_priority # => 1
+simple_heap.pop_with_priority # => [:a, 1]
 simple_heap.pop # => :b
 
 # Min priority queue
@@ -930,14 +931,14 @@ Heaps that support change_priority operation use it. Heaps that do not support i
     <td>pairing_heap (PairingHeap)</td>
     <td>1.359x slower</td>
   </tr>
-  <tr>
-    <td>lazy_priority_queue</td>
-    <td>2.115x slower</td>
-  </tr>
   <tr>
     <td>Fibonacci</td>
     <td>1.824x slower</td>
   </tr>
+  <tr>
+    <td>lazy_priority_queue</td>
+    <td>2.115x slower</td>
+  </tr>
   <tr>
     <th colspan="4">truffleruby 22.2.0, like ruby 3.0.3, GraalVM CE JVM [x86_64-darwin]</th>
   </tr>

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: %i[test]
+task default: %i[test standard]

data/lib/pairing_heap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PairingHeap
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/pairing_heap.rb

@@ -57,12 +57,12 @@ module PairingHeap
       end
 
       def remove_from_parents_list!
-        if self.prev_sibling
-          self.prev_sibling.next_sibling = self.next_sibling
-          self.next_sibling.prev_sibling = self.prev_sibling if self.next_sibling
-        elsif self.parent.subheaps.equal?(self)
-          self.parent.subheaps = self.next_sibling
-          self.next_sibling.prev_sibling = nil if self.next_sibling
+        if prev_sibling
+          prev_sibling.next_sibling = next_sibling
+          next_sibling.prev_sibling = prev_sibling if next_sibling
+        else # parent.subheaps must equal self
+          parent.subheaps = next_sibling
+          next_sibling.prev_sibling = nil if next_sibling
         end
         self.prev_sibling = nil
         self.next_sibling = nil
@@ -70,7 +70,8 @@ module PairingHeap
     end
     private_constant :Node
 
-    # @param &block Optional heap property priority comparator. `<:=.to_proc` by default
+    # @yield [l_priority, r_priority] Optional heap property priority comparator. `<:=.to_proc` by default
+    # @yieldreturn [boolean] if `l_priority` is more prioritary than `r_priority`, or the priorities are equal
     def initialize(&block)
       @root = nil
       @nodes = {}
@@ -83,20 +84,20 @@ module PairingHeap
     # @param priority Priority of the element
     # @raise [ArgumentError] if the element is already in the heap
     # @return [PairingHeap]
-    def push(elem, priority)
+    def push(elem, priority = elem)
       raise ArgumentError, "Element already in the heap" if @nodes.key?(elem)
 
       node = Node.new(elem, priority)
       @nodes[elem] = node
-      if @root
-        @root = meld(@root, node)
+      @root = if @root
+        meld(@root, node)
       else
-        @root = node
+        node
       end
       self
     end
-    alias enqueue push
-    alias offer push
+    alias_method :enqueue, :push
+    alias_method :offer, :push
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
@@ -104,10 +105,12 @@ module PairingHeap
       @root&.elem
     end
 
+    # @return [Object]
     def peek_priority
       @root&.priority
     end
 
+    # @return [Array(Object, Object)]
     def peek_with_priority
       [@root&.elem, @root&.priority]
     end
@@ -129,7 +132,7 @@ module PairingHeap
     def size
       @nodes.size
     end
-    alias length size
+    alias_method :length, :size
 
     # Removes element from the top of the heap and returns it
     #   Time Complexity: O(N)
@@ -148,9 +151,17 @@ module PairingHeap
       end
       elem
     end
-    alias dequeue pop
+    alias_method :dequeue, :pop
 
+    # @return [Object]
     def pop_priority
+      node = @root
+      pop
+      node.priority
+    end
+
+    # @return [Array(Object, Object)]
+    def pop_with_priority
       node = @root
       pop
       [node.elem, node.priority]
@@ -213,13 +224,33 @@ module PairingHeap
     # Returns priority of the provided element
     #   Time Complexity: O(1)
     # @raise [ArgumentError] if the element is not in the heap
+    # @return [Object]
     def get_priority(elem)
       node = @nodes[elem]
       raise ArgumentError, "Provided element is not in heap" if node.nil?
       node.priority
     end
 
+    # Returns a pair where first element is success flag, and second element is priority
+    #   Time Complexity: O(1)
+    # @return [Array(false, nil)] if the element is not in heap
+    # @return [Array(true, Object)] if the element is in heap;
+    #  second element of returned tuple is the priority
+    def get_priority_if_exists(elem)
+      node = @nodes[elem]
+      return [false, nil] if node.nil?
+      [true, node.priority]
+    end
+
+    # Returns enumerator of elements. No order guarantees are provided.
+    # @return [Enumerator]
+    def each
+      return to_enum(__method__) { size } unless block_given?
+      NodeVisitor.visit_node(@root) { |x| yield x.elem }
+    end
+
     private
+
     include MergePairs
 
     def meld(left, right)
@@ -251,7 +282,8 @@ module PairingHeap
     end
     private_constant :Node
 
-    # @param &block Optional heap property priority comparator. `<:=.to_proc` by default
+    # @yield [l_priority, r_priority] Optional heap property priority comparator. `<:=.to_proc` by default
+    # @yieldreturn [boolean] if `l_priority` is more prioritary than `r_priority`, or the priorities are equal
     def initialize(&block)
       @root = nil
       @order = block || :<=.to_proc
@@ -263,18 +295,18 @@ module PairingHeap
     # @param elem Element to be pushed
     # @param priority Priority of the element
     # @return [PairingHeap]
-    def push(elem, priority)
+    def push(elem, priority = elem)
       node = Node.new(elem, priority)
-      if @root
-        @root = meld(@root, node)
+      @root = if @root
+        meld(@root, node)
       else
-        @root = node
+        node
       end
       @size += 1
       self
     end
-    alias enqueue push
-    alias offer push
+    alias_method :enqueue, :push
+    alias_method :offer, :push
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
@@ -282,10 +314,12 @@ module PairingHeap
       @root&.elem
     end
 
+    # @return [Object]
     def peek_priority
       @root&.priority
     end
 
+    # @return [Array(Object, Object)]
     def peek_with_priority
       [@root&.elem, @root&.priority]
     end
@@ -304,15 +338,13 @@ module PairingHeap
 
     # Time Complexity: O(1)
     # @return [Integer]
-    def size
-      @size
-    end
-    alias length size
+    attr_reader :size
+    alias_method :length, :size
 
-    # Removes element from the top of the heap and returns it
+    # Removes an element from the top of the heap and returns it
     #   Time Complexity: O(N)
     #   Amortized time Complexity: O(log(N))
-    # @raise [ArgumEntError] if the heap is empty
+    # @raise [ArgumentError] if the heap is empty
     def pop
       raise ArgumentError, "Cannot remove from an empty heap" if @root.nil?
       @size -= 1
@@ -323,21 +355,31 @@ module PairingHeap
 
       elem
     end
-    alias dequeue pop
+    alias_method :dequeue, :pop
 
+    # @return [Object]
     def pop_priority
       node = @root
       pop
       node.priority
     end
 
+    # @return [Array(Object, Object)]
     def pop_with_priority
       node = @root
       pop
       [node.elem, node.priority]
     end
 
+    # Returns enumerator of elements. No order guarantees are provided.
+    # @return [Enumerator]
+    def each
+      return to_enum(__method__) { size } unless block_given?
+      NodeVisitor.visit_node(@root) { |x| yield x.elem }
+    end
+
     private
+
     include MergePairs
 
     def meld(left, right)
@@ -354,16 +396,15 @@ module PairingHeap
     end
   end
 
-
   # Priority queue where the smallest priority is the most prioritary
   class MinPriorityQueue < PairingHeap
     def initialize
       super(&:<=)
     end
 
-    alias decrease_key change_priority
-    alias min peek
-    alias extract_min dequeue
+    alias_method :decrease_key, :change_priority
+    alias_method :min, :peek
+    alias_method :extract_min, :dequeue
   end
 
   # Priority queue where the highest priority is the most prioritary
@@ -372,14 +413,14 @@ module PairingHeap
       super(&:>=)
     end
 
-    alias increase_key change_priority
-    alias max peek
-    alias extract_max dequeue
+    alias_method :increase_key, :change_priority
+    alias_method :max, :peek
+    alias_method :extract_max, :dequeue
   end
 
   # Priority queue with change_priority, that accepts changing to a less prioritary priority
   class SafeChangePriorityQueue < PairingHeap
-    # Changes a priority of the element to a more prioritary one
+    # Changes a priority of the element
     #   Time Complexity: O(N)
     #   Amortized Time Complexity: O(log(N))
     # @raise [ArgumentError] if the element is not in the heap
@@ -394,4 +435,22 @@ module PairingHeap
       end
     end
   end
+
+  module NodeVisitor
+    extend self
+
+    def visit_node(node, &block)
+      return unless node
+
+      block.call(node)
+
+      if node.subheaps
+        visit_node(node.subheaps, &block)
+      end
+      if node.next_sibling
+        visit_node(node.next_sibling, &block)
+      end
+    end
+  end
+  private_constant :NodeVisitor
 end

data/pairing_heap.gemspec

@@ -3,19 +3,19 @@
 require_relative "lib/pairing_heap/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "pairing_heap"
-  spec.version       = PairingHeap::VERSION
-  spec.authors       = ["Marcin Henryk Bartkowiak"]
-  spec.email         = ["mhbartkowiak@gmail.com"]
-
-  spec.summary       = "Performant priority queue in pure ruby with support for changing priority"
-  spec.description   = "Performant priority queue in pure ruby with support for changing priority using pairing heap data structure"
-  spec.homepage      = "https://github.com/mhib/pairing_heap"
-  spec.license       = "MIT"
+  spec.name = "pairing_heap"
+  spec.version = PairingHeap::VERSION
+  spec.authors = ["Marcin Henryk Bartkowiak"]
+  spec.email = ["mhbartkowiak@gmail.com"]
+
+  spec.summary = "Performant priority queue in pure ruby with support for changing priority"
+  spec.description = "Performant priority queue in pure ruby with support for changing priority using pairing heap data structure"
+  spec.homepage = "https://github.com/mhib/pairing_heap"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.metadata["homepage_uri"]      = spec.homepage
-  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/pairing_heap"
 
   # Specify which files should be added to the gem when it is released.
@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "codecov", "0.6.0"
+  spec.add_development_dependency "standard", "~> 1.20"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pairing_heap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcin Henryk Bartkowiak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-04 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
 description: Performant priority queue in pure ruby with support for changing priority
   using pairing heap data structure
 email:
@@ -48,7 +76,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
-- ".rubocop.yml"
+- ".standard.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -81,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Performant priority queue in pure ruby with support for changing priority

data/.rubocop.yml

@@ -1,17 +0,0 @@
-AllCops:
-  Exclude:
-    - 'test/fib.rb'
-
-Style/InfiniteLoop:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120