data_structures_rmolinari 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec5653a5bec033196042ad1af1e850877696eb02a1c37a6efdf1c89ce8e726c
-  data.tar.gz: 88893649d4329549fd2d2994f9b643614b46eb1d2d5b541418d6ad183f8f9f02
+  metadata.gz: 02563eb882aace27085e0db092d5a266c413c1864fe3c74d23d9c2af194f2d87
+  data.tar.gz: 2153f481d92569fbee02caea9df2177d9f7465d18e39d3764c4e92fc65a7cae6
 SHA512:
-  metadata.gz: 5c2a7ba2ca4630ae925358130d4b85297ea081d37ce032fe0db5e2b13d9c84cbef5be58f9d82027feb63cc476b59200c993d608f48a9db8871594415544aab32
-  data.tar.gz: fc5ad5901038397b7d42eb44ee2b199654612f043c2eeceeb05b380da54c9e4db858612daf3dff7eb8ae580c0af0905ddc237867580f44057a0d9df6e063df6c
+  metadata.gz: dbe47a34b03026dd0f82e5a3ba75a31c2a24a03b1d4d32fe94c0b9760e53c9171a964bec7fa04a7cc675bd980c938781c75e4f09817f4cac6b866f1aebf2483a
+  data.tar.gz: 9a80a2984dd8ed2caa63393b0a363c3e3e7414a79217bbb5daf1015a9c17b0842ff534d366eef05adb311ed7ef889a171140af282e3aee71619be3d9483e93c7

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [0.5.7] 2024-01-04
+
+- Heap
+  - addd top_priority method
+
+## [0.5.6] 2024-01-04
+
+- Heap
+  - add update_by_delta method
+
 ## [0.5.5] 2023-12-19
 
 Support Ruby v3.2.

data/README.md

@@ -53,17 +53,19 @@ operations:
 
 - `insert(item, priority)`, insert the given item with the stated priority.
   - By default, items must be distinct.
-- `top`, returning the element with smallest priority
+- `top`, return the element with smallest priority
+- `top_priority`, return the _priority_ of the top element
 - `pop`, return the element with smallest priority and remove it from the structure
 - `update(item, priority)`, update the priority of the given item, which must already be in the heap
+- `update_by_delta(item, delta)`, update the priorityof the given item by adding delta to the priority; the item must already be in the heap
 
-`top` is O(1). The others are O(log n) where n is the number of items in the heap.
+`top` and `top_priority` are O(1). The others are O(log n) where n is the number of items in the heap.
 
 By default we have a min-heap: the top element is the one with smallest priority. A configuration parameter at construction can make
 it a max-heap.
 
-Another configuration parameter allows the creation of a "non-addressable" heap. This makes it impossible to call `update`, but
-allows the insertion of duplicate items (which is sometimes useful) and slightly faster operation overall.
+Another configuration parameter allows the creation of a "non-addressable" heap. This makes it impossible to call `update` or
+`update_by_delta`, but allows the insertion of duplicate items (which is sometimes useful) and slightly faster operation overall.
 
 See https://en.wikipedia.org/wiki/Binary_heap and the paper by Edelkamp, Elmasry, and Katajainen [[EEK2017]](#references).
 

data/lib/data_structures_rmolinari/heap.rb

@@ -101,6 +101,13 @@ class DataStructuresRMolinari::Heap
     @data[root].item
   end
 
+  # Return the priority of the item at the top of the heap
+  def top_priority
+    raise 'Heap is empty!' unless @size.positive?
+
+    @data[root].priority
+  end
+
   # Return the top of the heap and remove it, updating the structure to maintain the necessary properties.
   # @return (see #top)
   def pop
@@ -137,6 +144,21 @@ class DataStructuresRMolinari::Heap
     check_heap_property if @debug
   end
 
+  # Update the priority of the given element by changing the priority by the given amount.
+  #
+  # @param element the item whose priority we are updating. It is an error to update the priority of an element not already in the
+  #   heap
+  # @param the amount by which to change the priority. The existing priority must respond sensibly to += with this value
+  def update_by_delta(element, delta)
+    raise LogicError, 'Cannot update priorities in a non-addressable heap' unless @addressable
+    raise DataError, "Cannot update priority for value #{element} not already in the heap" unless contains?(element)
+
+    idx = @index_of[element]
+    old = @data[idx].priority
+
+    update(element, old + delta)
+  end
+
   # Filter the value at index up to its correct location. Algorithm from Edelkamp et. al.
   private def sift_up(idx)
     return if idx == root

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_structures_rmolinari
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.7
 platform: ruby
 authors:
 - Rory Molinari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: must_be
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Several miscellaneous data structures I have implemented to learn about them.