pairing_heap 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afe0b373b7c015091b7d7f19ba3d8d0004d1f7c257aad0fe678cf235dc288541
-  data.tar.gz: d3b93b4741c9255b67f0ca232cb881a32fa965b4390c903c4eda96b992961176
+  metadata.gz: eb8c2535dddd1392b4d868d5d5c48e7aec6d3de835b5ea780823a367b12d4a6f
+  data.tar.gz: 8dda83047006373651250a522ca1e1aa114987bf17b110d0b25d1147acf3a053
 SHA512:
-  metadata.gz: d039d5f4a3b996a5f7b1f3193be96291ffa8d53537e45fa4fb6d61fbb83e9a1b897156c64918da8f08b3f0c78e905ef5e4588598495e3c655319e84a201bb037
-  data.tar.gz: 29669debc6da2984b31e986c63ae36776bd48ccf6febab79d0a8f74b304c1242d65aabeba2b2ff7362476448722c4c52bb6c170a8ebbd857d1c3e930e41a79c4
+  metadata.gz: 39cb442615fa8da23e1d4fd1743b937dc9d8410014a2b7f2610de3cb3cad9dc3f3d9cf851e70cb943a81e658efaa70f7d588f29db4a2851a803dfafdbb6e19bb
+  data.tar.gz: bf9d597bbc03ebbf4aeae439ad18f04922fac7247b3046ec63afe89728020811f317e704955bbcdecefd82587de0c5152334f14e307beb9b1be024fb03234a07

data/.github/workflows/main.yml

@@ -12,10 +12,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
+    - name: Set up ruby
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: |
-        gem install bundler -v 2.3.6
-        bundle install
-        bundle exec rake
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.standard.yml

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

data/Gemfile.lock

@@ -1,16 +1,15 @@
 PATH
   remote: .
   specs:
-    pairing_heap (2.0.0)
+    pairing_heap (3.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)
+    json (2.6.3-java)
     language_server-protocol (3.17.0.2)
     minitest (5.15.0)
     parallel (1.22.1)
@@ -36,7 +35,7 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -49,14 +48,17 @@ GEM
     unicode-display_width (2.3.0)
 
 PLATFORMS
+  universal-java-17
+  x86_64-darwin-19
   x86_64-darwin-21
   x86_64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
-  codecov (= 0.6.0)
   minitest (~> 5.0)
   pairing_heap!
   rake (~> 13.0)
+  simplecov (~> 0.22.0)
   standard (~> 1.20)
 
 BUNDLED WITH

data/lib/pairing_heap/version.rb

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

data/lib/pairing_heap.rb

@@ -83,7 +83,7 @@ module PairingHeap
     # @param elem Element to be pushed
     # @param priority Priority of the element
     # @raise [ArgumentError] if the element is already in the heap
-    # @return [PairingHeap]
+    # @return [self]
     def push(elem, priority = elem)
       raise ArgumentError, "Element already in the heap" if @nodes.key?(elem)
 
@@ -101,16 +101,20 @@ module PairingHeap
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
+    # @return [Object]
+    # @return [nil] if the heap is empty
     def peek
       @root&.elem
     end
 
     # @return [Object]
+    # @return [nil] if the heap is empty
     def peek_priority
       @root&.priority
     end
 
     # @return [Array(Object, Object)]
+    # @return [Array(nil, nil)] if the heap is empty
     def peek_with_priority
       [@root&.elem, @root&.priority]
     end
@@ -137,9 +141,10 @@ module PairingHeap
     # Removes 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
+    # @return [Object] The top element
+    # @return [nil] If the heap is empty
     def pop
-      raise ArgumentError, "Cannot remove from an empty heap" if @root.nil?
+      return nil if @root.nil?
 
       elem = @root.elem
       @nodes.delete(elem)
@@ -153,18 +158,22 @@ module PairingHeap
     end
     alias_method :dequeue, :pop
 
+    # @see #pop
     # @return [Object]
+    # @return [nil] if the heap is empty
     def pop_priority
       node = @root
       pop
-      node.priority
+      node&.priority
     end
 
+    # @see #pop
     # @return [Array(Object, Object)]
+    # @return [Array(nil, nil)] If the heap is empty
     def pop_with_priority
       node = @root
       pop
-      [node.elem, node.priority]
+      [node&.elem, node&.priority]
     end
 
     # Changes a priority of element to a more prioritary one
@@ -173,7 +182,7 @@ module PairingHeap
     # @param elem Element
     # @param priority New priority
     # @raise [ArgumentError] if the element is not in the heap or the new priority is less prioritary
-    # @return [PairingHeap]
+    # @return [self]
     def change_priority(elem, priority)
       node = @nodes[elem]
       raise ArgumentError, "Provided element is not in heap" if node.nil?
@@ -195,7 +204,7 @@ module PairingHeap
     #   Time Complexity: O(N)
     #   Amortized Time Complexity: O(log(N))
     # @raise [ArgumentError] if the element is not in the heap
-    # @return [PairingHeap]
+    # @return [self]
     def delete(elem)
       node = @nodes[elem]
       raise ArgumentError, "Provided element is not in heap" if node.nil?
@@ -221,14 +230,21 @@ module PairingHeap
       self
     end
 
+    # Check if element is in the heap
+    #   Time Complexity: O(1)
+    # @return [Boolean]
+    def include?(key)
+      @nodes.key?(key)
+    end
+    alias_method :exists?, :include?
+
     # Returns priority of the provided element
     #   Time Complexity: O(1)
-    # @raise [ArgumentError] if the element is not in the heap
     # @return [Object]
+    # @return [nil] If element does not exist
     def get_priority(elem)
       node = @nodes[elem]
-      raise ArgumentError, "Provided element is not in heap" if node.nil?
-      node.priority
+      node&.priority
     end
 
     # Returns a pair where first element is success flag, and second element is priority
@@ -242,11 +258,22 @@ module PairingHeap
       [true, node.priority]
     end
 
-    # Returns enumerator of elements. No order guarantees are provided.
-    # @return [Enumerator]
+    # Returns enumerator of elements.
+    # @note There are no order guarantees.
+    # @yieldparam [Object] element Element in the heap
+    # @return [Enumerator<Object>]
     def each
       return to_enum(__method__) { size } unless block_given?
-      NodeVisitor.visit_node(@root) { |x| yield x.elem }
+      @nodes.each_value { |node| yield node.elem }
+    end
+
+    # Returns enumerator of elements.
+    # @note There are no order guarantees.
+    # @return [Enumerator<Array(Object, Object)>] if no block given
+    # @yieldparam [Array(Object, Object)] element Element in the heap with its priority
+    def each_with_priority
+      return to_enum(__method__) { size } unless block_given?
+      @nodes.each_value { |node| yield [node.elem, node.priority] }
     end
 
     private
@@ -294,7 +321,7 @@ module PairingHeap
     #   Time Complexity: O(1)
     # @param elem Element to be pushed
     # @param priority Priority of the element
-    # @return [PairingHeap]
+    # @return [self]
     def push(elem, priority = elem)
       node = Node.new(elem, priority)
       @root = if @root
@@ -310,16 +337,20 @@ module PairingHeap
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
+    # @return [Object]
+    # @return [nil] If the heap is empty
     def peek
       @root&.elem
     end
 
     # @return [Object]
+    # @return [nil] If the heap is empty
     def peek_priority
       @root&.priority
     end
 
     # @return [Array(Object, Object)]
+    # @return [Array(nil, nil)] If the heap is empty
     def peek_with_priority
       [@root&.elem, @root&.priority]
     end
@@ -344,9 +375,10 @@ module PairingHeap
     # 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
+    # @return [Object] The top element
+    # @return [nil] If the heap is empty
     def pop
-      raise ArgumentError, "Cannot remove from an empty heap" if @root.nil?
+      return nil if @root.nil?
       @size -= 1
 
       elem = @root.elem
@@ -357,27 +389,42 @@ module PairingHeap
     end
     alias_method :dequeue, :pop
 
+    # @see #pop
     # @return [Object]
+    # @return [nil] If the heap is empty
     def pop_priority
       node = @root
       pop
-      node.priority
+      node&.priority
     end
 
+    # @see #pop
     # @return [Array(Object, Object)]
+    # @return [Array(nil, nil)] If the heap is empty
     def pop_with_priority
       node = @root
       pop
-      [node.elem, node.priority]
+      [node&.elem, node&.priority]
     end
 
-    # Returns enumerator of elements. No order guarantees are provided.
-    # @return [Enumerator]
+    # Returns enumerator of elements.
+    # @note There are no order guarantees.
+    # @yieldparam [Object] element element in the heap
+    # @return [Enumerator<Object>] if no block given
     def each
       return to_enum(__method__) { size } unless block_given?
       NodeVisitor.visit_node(@root) { |x| yield x.elem }
     end
 
+    # @return [Enumerator<Array(Object, Object)>] if no block given
+    # @yieldparam [Array(Object, Object)] element Element in the heap with its priority
+    # Returns enumerator of elements.
+    # @note There are no order guarantees.
+    def each_with_priority
+      return to_enum(__method__) { size } unless block_given?
+      NodeVisitor.visit_node(@root) { |x| yield [x.elem, x.priority] }
+    end
+
     private
 
     include MergePairs
@@ -424,7 +471,7 @@ module PairingHeap
     #   Time Complexity: O(N)
     #   Amortized Time Complexity: O(log(N))
     # @raise [ArgumentError] if the element is not in the heap
-    # @return [PairingHeap]
+    # @return [self]
     def change_priority(elem, priority)
       raise ArgumentError, "Provided element is not in heap" unless @nodes.key?(elem)
       if !@order[priority, @nodes[elem].priority]

data/pairing_heap.gemspec

@@ -32,7 +32,7 @@ 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 "simplecov", "~> 0.22.0"
   spec.add_development_dependency "standard", "~> 1.20"
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pairing_heap
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Marcin Henryk Bartkowiak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement