pairing_heap 3.1.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95d383584e208d1239f310d3e3bab5c727b4d721405b6b2b34eeb2a684b7ef0
-  data.tar.gz: 3d1faf97fae0312ffcd3491bd70cddc1acc40a280c2d7af446742094456007bb
+  metadata.gz: 0c7122d09fdfbcda744f2824df424af7634b2497594ecda22ec08a24b1372a91
+  data.tar.gz: 6e2a075da8593426c0bd893594d01bc3434036af94ca607cd6c1613fc9900272
 SHA512:
-  metadata.gz: 2ad6b8a6410b9bebcf0b1b10fa29fe79ef8799faff50e043c600faa47fe965efcb949cdd725ce0b612fe7f8f1b8432c1c3e04604c3424c3084ef4396e670eb1e
-  data.tar.gz: 935a061846b27ed77f2af4f92f59b1080fddf83fe8949732ea23ca26e33e5d185cae232f9765edb5b7f850ac9970304a6872d504703342bc5b7601eb17c477e2
+  metadata.gz: b24f2b9386d50527877e19f1de73dfef77258ff2f9051704c33c7d3a93610322b67f7467ae85113870ce45246e63d282e97102bd98ce10978f0297858c2fd50e
+  data.tar.gz: abf622d8f59d67cdcf65fd6e96564877929e9a8979df5f98d417141ce2d3040d41a483f2f4abedb86e4bbcee832260714131f07f665563a035cfb18b33c1ff3e

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ['3.2', '3.3', '3.4', '3.5', '4.0', jruby, truffleruby]
+        ruby: ['3.3', '3.4', '3.5', '4.0', jruby, truffleruby]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pairing_heap (3.1.1)
+    pairing_heap (3.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -9,10 +9,12 @@ GEM
     ast (2.4.3)
     docile (1.4.1)
     drb (2.2.3)
-    json (2.18.0)
-    json (2.18.0-java)
+    jar-dependencies (0.6.1-java)
+    json (2.21.2)
+    json (2.21.2-java)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
     minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
@@ -20,11 +22,20 @@ GEM
     parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    prism (1.7.0)
+    prism (1.9.0)
     racc (1.8.1)
     racc (1.8.1-java)
     rainbow (3.1.1)
     rake (13.3.1)
+    rbs (4.2.0)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rbs (4.2.0-java)
+      jar-dependencies (>= 0.1.7)
+      logger
+      prism (>= 1.6.0)
+      tsort
     regexp_parser (2.11.3)
     rubocop (1.87.0)
       json (~> 2.3)
@@ -63,6 +74,7 @@ GEM
     standard-performance (1.9.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.26.0)
+    tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
@@ -75,6 +87,7 @@ DEPENDENCIES
   minitest (~> 6.0)
   pairing_heap!
   rake (~> 13.3)
+  rbs (~> 4.2)
   simplecov (~> 0.22.0)
   standard (~> 1.55)
 
@@ -82,19 +95,23 @@ CHECKSUMS
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
   docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
-  json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505
-  json (2.18.0-java) sha256=74706f684baeb1a40351ed26fc8fe6e958afa861320d1c28ff4eb7073b29c7aa
+  jar-dependencies (0.6.1-java) sha256=2746643482d139fd9cecb524b57df63b71d9b5d734c7275171701201e3164f23
+  json (2.21.2) sha256=1f1d3b7cf2b3ba1a69beca0bb6db13d5438b80bff3cd54cdaaa620b9b07c1c6a
+  json (2.21.2-java) sha256=f01521cd90639cc26b63040fb00d2b949f18f41ecaab5c82b02fb31d0b8b736c
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   minitest (6.0.6) sha256=153ea36d1d987a62942382b61075745042a2b3123b1cd48f4c3675af9cc7d6f1
-  pairing_heap (3.1.1)
+  pairing_heap (3.1.3)
   parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
   parser (3.3.10.0) sha256=ce3587fa5cc55a88c4ba5b2b37621b3329aadf5728f9eafa36bbd121462aabd6
-  prism (1.7.0) sha256=10062f734bf7985c8424c44fac382ac04a58124ea3d220ec3ba9fe4f2da65103
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
   racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
   racc (1.8.1-java) sha256=54f2e6d1e1b91c154013277d986f52a90e5ececbe91465d29172e49342732b98
   rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
   rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  rbs (4.2.0) sha256=51f7b886dcc05bc09e10b901daa6a81829f6adc03101d6ca9ea4aac6103e0674
+  rbs (4.2.0-java) sha256=a19282d89c307dd6d33c6a72cc60f75b10d6d35a5996796e864789c903cddb3c
   regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
   rubocop (1.87.0) sha256=b9d9ddf55116a513f8ef2c7ae660662d8b49301f118d3f0df61865b33a5c188d
   rubocop-ast (1.49.0) sha256=49c3676d3123a0923d333e20c6c2dbaaae2d2287b475273fddee0c61da9f71fd
@@ -106,6 +123,7 @@ CHECKSUMS
   standard (1.55.0) sha256=8a8f2c3e681a4db3aafde1b301561b0f3d7c5f06c160167cb744a4d7baf0426e
   standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
   standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
+  tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
   unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
   unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
 

data/Rakefile

@@ -12,4 +12,8 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: %i[test standard]
+task :rbs do
+  sh "rbs -I sig validate"
+end
+
+task default: %i[test standard rbs]

data/lib/pairing_heap/version.rb

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

data/pairing_heap.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "rbs", "~> 4.2"
   spec.add_development_dependency "minitest", "~> 6.0"
   spec.add_development_dependency "rake", "~> 13.3"
   spec.add_development_dependency "simplecov", "~> 0.22.0"

data/sig/pairing_heap.rbs

@@ -0,0 +1,175 @@
+module PairingHeap
+  VERSION: String
+
+  # Pairing heap data structure implementation
+  # @see https://en.wikipedia.org/wiki/Pairing_heap
+  class PairingHeap[Elem, Priority]
+    # @yield [l_priority, r_priority] Optional heap property priority comparator. `<=.to_proc` by default
+    # @yieldreturn [bool] if `l_priority` is more prioritary than `r_priority`, or the priorities are equal
+    def initialize: () ?{ (Priority, Priority) -> boolish } -> void
+
+    # Pushes element to the heap.
+    #   Time Complexity: O(1)
+    # @raise [ArgumentError] if the element is already in the heap
+    def push: (Elem elem, ?Priority priority) -> self
+    alias enqueue push
+    alias offer push
+
+    # Returns the element at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek: () -> Elem?
+
+    # Returns the priority of the element at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek_priority: () -> Priority?
+
+    # Returns the element and its priority at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek_with_priority: () -> ([Elem, Priority] | [nil, nil])
+
+    # Time Complexity: O(1)
+    def empty?: () -> bool
+
+    # Time Complexity: O(1)
+    def any?: () -> bool
+
+    # Time Complexity: O(1)
+    def size: () -> Integer
+    alias length size
+
+    # Removes element from the top of the heap and returns it.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop: () -> Elem?
+    alias dequeue pop
+
+    # Removes element from the top of the heap and returns its priority.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop_priority: () -> Priority?
+
+    # Removes element from the top of the heap and returns it along with its priority.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop_with_priority: () -> ([Elem, Priority] | [nil, nil])
+
+    # Changes a priority of element to a more prioritary one.
+    #   Time Complexity: O(1), Amortized: O(log N)
+    # @param elem Element
+    # @param priority New priority
+    # @raise [ArgumentError] if the element is not in the heap or the new priority is less prioritary
+    def change_priority: (Elem elem, Priority priority) -> self
+
+    # Removes element from the heap.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    # @raise [ArgumentError] if the element is not in the heap
+    def delete: (Elem elem) -> self
+
+    # Check if element is in the heap.
+    #   Time Complexity: O(1)
+    def include?: (Elem key) -> bool
+    alias exists? include?
+
+    # Returns priority of the provided element.
+    #   Time Complexity: O(1)
+    def get_priority: (Elem elem) -> Priority?
+
+    # Returns [false, nil] if the element is not in heap, [true, priority] if it is.
+    #   Time Complexity: O(1)
+    def get_priority_if_exists: (Elem elem) -> ([false, nil] | [true, Priority])
+
+    # Yields each element in the heap. No order guarantees.
+    def each: () { (Elem) -> void } -> void
+            | () -> Enumerator[Elem, void]
+
+    # Yields each [element, priority] pair in the heap. No order guarantees.
+    def each_with_priority: () { ([Elem, Priority]) -> void } -> void
+                          | () -> Enumerator[[Elem, Priority], void]
+  end
+
+  class SimplePairingHeap[Elem, Priority]
+    # @yield [l_priority, r_priority] Optional heap property priority comparator. `<=.to_proc` by default
+    # @yieldreturn [bool] if `l_priority` is more prioritary than `r_priority`, or the priorities are equal
+    def initialize: () ?{ (Priority, Priority) -> boolish } -> void
+
+    # Pushes element to the heap.
+    #   Time Complexity: O(1)
+    def push: (Elem elem, ?Priority priority) -> self
+    alias enqueue push
+    alias offer push
+
+    # Returns the element at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek: () -> Elem?
+
+    # Returns the priority of the element at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek_priority: () -> Priority?
+
+    # Returns the element and its priority at the top of the heap.
+    #   Time Complexity: O(1)
+    def peek_with_priority: () -> ([Elem, Priority] | [nil, nil])
+
+    # Time Complexity: O(1)
+    def empty?: () -> bool
+
+    # Time Complexity: O(1)
+    def any?: () -> bool
+
+    # Time Complexity: O(1)
+    attr_reader size: Integer
+    alias length size
+
+    # Removes element from the top of the heap and returns it.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop: () -> Elem?
+    alias dequeue pop
+
+    # Removes element from the top of the heap and returns its priority.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop_priority: () -> Priority?
+
+    # Removes element from the top of the heap and returns it along with its priority.
+    #   Time Complexity: O(N), Amortized: O(log N)
+    def pop_with_priority: () -> ([Elem, Priority] | [nil, nil])
+
+    # Yields each element in the heap. No order guarantees.
+    def each: () { (Elem) -> void } -> void
+            | () -> Enumerator[Elem, void]
+
+    # Yields each [element, priority] pair in the heap. No order guarantees.
+    def each_with_priority: () { ([Elem, Priority]) -> void } -> void
+                          | () -> Enumerator[[Elem, Priority], void]
+
+    # Merges provided heap into self.
+    #   Time Complexity: O(1)
+    # @raise [ArgumentError] if the provided argument is self
+    # @note Modifies the argument (clears it)
+    def merge: (SimplePairingHeap[Elem, Priority] other) -> self
+  end
+
+  # Priority queue where the smallest priority is the most prioritary
+  class MinPriorityQueue[Elem, Priority < Comparable] < PairingHeap[Elem, Priority]
+    def initialize: () -> void
+
+    alias decrease_key change_priority
+    alias min peek
+    alias extract_min dequeue
+  end
+
+  # Priority queue where the highest priority is the most prioritary
+  class MaxPriorityQueue[Elem, Priority < Comparable] < PairingHeap[Elem, Priority]
+    def initialize: () -> void
+
+    alias increase_key change_priority
+    alias max peek
+    alias extract_max dequeue
+  end
+
+  # Priority queue with change_priority that accepts changing to a less prioritary priority
+  class SafeChangePriorityQueue[Elem, Priority] < PairingHeap[Elem, Priority]
+    # Changes a priority of the element (accepts any direction).
+    #   Time Complexity: O(N), Amortized: O(log N)
+    # @param elem Element
+    # @param priority New priority
+    # @raise [ArgumentError] if the element is not in the heap
+    def change_priority: (Elem elem, Priority priority) -> self
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pairing_heap
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Marcin Henryk Bartkowiak
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,7 @@ files:
 - lib/pairing_heap.rb
 - lib/pairing_heap/version.rb
 - pairing_heap.gemspec
+- sig/pairing_heap.rbs
 homepage: https://github.com/mhib/pairing_heap
 licenses:
 - MIT
@@ -108,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Performant priority queue in pure ruby with support for changing priority
 test_files: []