data_structures_rmolinari 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec5653a5bec033196042ad1af1e850877696eb02a1c37a6efdf1c89ce8e726c
-  data.tar.gz: 88893649d4329549fd2d2994f9b643614b46eb1d2d5b541418d6ad183f8f9f02
+  metadata.gz: 1fbafd7af3c7bd2d1eee3303fd8b8a759b0d67fc29bfdca3b7f67b626e9fe175
+  data.tar.gz: 5a870554e38c61b1e1af64d2205bc002cf7cb731e5412606543ffdce014342b4
 SHA512:
-  metadata.gz: 5c2a7ba2ca4630ae925358130d4b85297ea081d37ce032fe0db5e2b13d9c84cbef5be58f9d82027feb63cc476b59200c993d608f48a9db8871594415544aab32
-  data.tar.gz: fc5ad5901038397b7d42eb44ee2b199654612f043c2eeceeb05b380da54c9e4db858612daf3dff7eb8ae580c0af0905ddc237867580f44057a0d9df6e063df6c
+  metadata.gz: fcdaae719324c5b8b7914eb6a982563d58ee10170d52280c58429e8d9b5a7e5224079350ab15ad618b5cacbcdf340c17feec2b34616e17847d5b0e16a7569d50
+  data.tar.gz: 446e2190ff33f65c9cb6cedd6043af506aa6f395f279e54520b2ba1c0c04fbd8504615f1a94e09232edefee9b0cb0d55363aa20b6504467d70f6766b19698464

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [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

@@ -56,14 +56,15 @@ operations:
 - `top`, returning the element with smallest priority
 - `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.
 
 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

@@ -137,6 +137,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.6
 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.