pairing_heap 0.3.0 → 1.0.0

data/lib/pairing_heap/version.rb

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

data/lib/pairing_heap.rb

@@ -8,18 +8,21 @@ module PairingHeap
       return heaps if heaps.next_sibling.nil?
 
       # [H1, H2, H3, H4, H5, H6, H7] => [H1H2, H3H4, H5H6, H7]
-      stack = []
-      current = heaps
-      while current
-        prev = current
-        current = current.next_sibling
-        unless current
-          stack << prev
+      pairs = nil
+      left = heaps
+      while left
+        right = left.next_sibling
+        unless right
+          left.next_sibling = pairs
+          pairs = left
           break
         end
-        next_val = current.next_sibling
-        stack << meld(prev, current)
-        current = next_val
+        next_val = right.next_sibling
+        right = meld(left, right)
+        right.next_sibling = pairs
+        pairs = right
+
+        left = next_val
       end
 
       # [H1H2, H3H4, H5H6, H7]
@@ -27,13 +30,14 @@ module PairingHeap
       # [H1H2, H3H45H67]
       # [H1H2H3H45H67]
       # return H1H2H3H45H67
-      while true
-        right = stack.pop
-        return right if stack.empty?
-
-        left = stack.pop
-        stack << meld(left, right)
+      left = pairs
+      right = pairs.next_sibling
+      while right
+        next_val = right.next_sibling
+        left = meld(left, right)
+        right = next_val
       end
+      left
     end
   end
   private_constant :MergePairs
@@ -43,13 +47,13 @@ module PairingHeap
   class PairingHeap
     class Node
       attr_accessor :elem, :priority, :subheaps, :parent, :prev_sibling, :next_sibling
-      def initialize(elem, priority, subheaps, parent, prev_sibling, next_sibling)
+      def initialize(elem, priority)
         @elem = elem
         @priority = priority
-        @subheaps = subheaps
-        @parent = parent
-        @prev_sibling = prev_sibling
-        @next_sibling = next_sibling
+        @subheaps = nil
+        @parent = nil
+        @prev_sibling = nil
+        @next_sibling = nil
       end
 
       def remove_from_parents_list!
@@ -82,12 +86,17 @@ module PairingHeap
     def push(elem, priority)
       raise ArgumentError, "Element already in the heap" if @nodes.key?(elem)
 
-      node = Node.new(elem, priority, nil, nil, nil, nil)
+      node = Node.new(elem, priority)
       @nodes[elem] = node
-      @root = meld(@root, node)
+      if @root
+        @root = meld(@root, node)
+      else
+        @root = node
+      end
       self
     end
     alias enqueue push
+    alias offer push
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
@@ -96,6 +105,10 @@ module PairingHeap
     end
 
     def peek_priority
+      @root&.priority
+    end
+
+    def peek_with_priority
       [@root&.elem, @root&.priority]
     end
 
@@ -118,11 +131,10 @@ module PairingHeap
     end
     alias length size
 
-    # Removes element from the top of the heap
+    # 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 [PairingHeap]
+    # @raise [ArgumentError] if the heap is empty
     def pop
       raise ArgumentError, "Cannot remove from an empty heap" if @root.nil?
 
@@ -149,7 +161,7 @@ module PairingHeap
     #   Amortized Time Complexity: o(log(N))
     # @param elem Element
     # @param priority New priority
-    # @raise [ArgumentError] if the element heap is not in heap or the new priority is less prioritary
+    # @raise [ArgumentError] if the element is not in the heap or the new priority is less prioritary
     # @return [PairingHeap]
     def change_priority(elem, priority)
       node = @nodes[elem]
@@ -171,7 +183,7 @@ module PairingHeap
     # Removes element from the heap
     #   Time Complexity: O(N)
     #   Amortized Time Complexity: O(log(N))
-    # @raise [ArgumentError] if the element heap is not in heap
+    # @raise [ArgumentError] if the element is not in the heap
     # @return [PairingHeap]
     def delete(elem)
       node = @nodes[elem]
@@ -180,26 +192,37 @@ module PairingHeap
       @nodes.delete(elem)
       if node.parent.nil?
         @root = merge_pairs(node.subheaps)
+        if @root
+          @root.parent = nil
+          @root.prev_sibling = nil
+          @root.next_sibling = nil
+        end
       else
         node.remove_from_parents_list!
         new_heap = merge_pairs(node.subheaps)
         if new_heap
-          new_heap.prev_sibling = nil
-          new_heap.next_sibling = nil
+          @root = meld(new_heap, @root)
+          @root.parent = nil
+          @root.prev_sibling = nil
+          @root.next_sibling = nil
         end
-        @root = meld(new_heap, @root)
       end
-      @root&.parent = nil
       self
     end
 
+    # Returns priority of the provided element
+    #   Time Complexity: O(1)
+    # @raise [ArgumentError] if the element is not in the heap
+    def get_priority(elem)
+      node = @nodes[elem]
+      raise ArgumentError, "Provided element is not in heap" if node.nil?
+      node.priority
+    end
+
     private
     include MergePairs
 
     def meld(left, right)
-      return right if left.nil?
-      return left if right.nil?
-
       if @order[left.priority, right.priority]
         parent = left
         child = right
@@ -219,11 +242,11 @@ module PairingHeap
   class SimplePairingHeap
     class Node
       attr_accessor :elem, :priority, :subheaps, :next_sibling
-      def initialize(elem, priority, subheaps, next_sibling)
+      def initialize(elem, priority)
         @elem = elem
         @priority = priority
-        @subheaps = subheaps
-        @next_sibling = next_sibling
+        @subheaps = nil
+        @next_sibling = nil
       end
     end
     private_constant :Node
@@ -239,15 +262,19 @@ module PairingHeap
     #   Time Complexity: O(1)
     # @param elem Element to be pushed
     # @param priority Priority of the element
-    # @raise [ArgumentError] if the element is already in the heap
     # @return [PairingHeap]
     def push(elem, priority)
-      node = Node.new(elem, priority, nil, nil)
-      @root = meld(@root, node)
+      node = Node.new(elem, priority)
+      if @root
+        @root = meld(@root, node)
+      else
+        @root = node
+      end
       @size += 1
       self
     end
     alias enqueue push
+    alias offer push
 
     # Returns the element at the top of the heap
     #   Time Complexity: O(1)
@@ -256,6 +283,10 @@ module PairingHeap
     end
 
     def peek_priority
+      @root&.priority
+    end
+
+    def peek_with_priority
       [@root&.elem, @root&.priority]
     end
 
@@ -278,25 +309,29 @@ module PairingHeap
     end
     alias length size
 
-    # Removes element from the top of the heap
+    # 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 [PairingHeap]
     def pop
       raise ArgumentError, "Cannot remove from an empty heap" if @root.nil?
       @size -= 1
 
       elem = @root.elem
       @root = merge_pairs(@root.subheaps)
-      if @root
-        @root.next_sibling = nil
-      end
+      @root&.next_sibling = nil
+
       elem
     end
     alias dequeue pop
 
     def pop_priority
+      node = @root
+      pop
+      node.priority
+    end
+
+    def pop_with_priority
       node = @root
       pop
       [node.elem, node.priority]
@@ -306,9 +341,6 @@ module PairingHeap
     include MergePairs
 
     def meld(left, right)
-      return right if left.nil?
-      return left if right.nil?
-
       if @order[left.priority, right.priority]
         parent = left
         child = right
@@ -350,7 +382,7 @@ module PairingHeap
     # Changes a priority of the element to a more prioritary one
     #   Time Complexity: O(N)
     #   Amortized Time Complexity: O(log(N))
-    # @raise [ArgumentError] if the element heap is not in the heap
+    # @raise [ArgumentError] if the element is not in the heap
     # @return [PairingHeap]
     def change_priority(elem, priority)
       raise ArgumentError, "Provided element is not in heap" unless @nodes.key?(elem)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pairing_heap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Marcin Henryk Bartkowiak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest