data_structures_rmolinari 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3765b8df91fcc62eb885e32ff5ad4b0b4678bba6f322cb5c8282657052aed8c6
-  data.tar.gz: 845bea3649dc51dab697927132c0fc2f62dcacf5c25e1c717b99e57819b52286
+  metadata.gz: 9f006234ee3b216d5607e9b10bb1958a6107ccfa0cc8c359f98383dc7fde14ee
+  data.tar.gz: f281ab0768e24e7c983cd046ba7b185dab8fd972fb3065fd73ff575782bf5486
 SHA512:
-  metadata.gz: 23687561ec6ddb12369ca5e75db33ffd710295097cd0c91b72fb278fea3b11b23152867bb4aea6a4fd17b2f95184fb5433c9ff009db92a5c4bab78686ae472de
-  data.tar.gz: d930a674f85aa0a57030ed59f2b39979c7dbb8d8f74e0a9718d44112c1efe05657e0d55773b623c3724f040054e2fedf453de30b72d5631404642081455406f9
+  metadata.gz: e274a97f177fad44bad20ecf24ecca1385fee3c217e7e42aac076c24377970c6444dfdbadc6fd3e1e201555177429c9f8eddaee211e463dd60f6b36e74004eec
+  data.tar.gz: 293fc0b2973a8d851c27f4e64177dbf7b9a25b2bb7eb9efb4b33abdb07c4e006f80f4450996ef99da7e8bb1516ca8aa89ab893258960d9127d101995906254ed

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.3.0] 2023-01-06
+
+### Added
+
+- Start this file
+- `Heap` can be constructed as "non-addressable"
+  - `update` is not possible but duplicates can be inserted and overall performance is a little better.
+
+### Changed
+
+- `LogicError` gets a subclassed `InternalLogicError` for issues inside the library.
+- `Shared::Pair` becomes `Shared::Point`
+  - this doesn't change the API of `MaxPrioritySearchTree` because of ducktyping. But client code (of which there is none) might be
+    using the `Pair` name.

data/lib/data_structures_rmolinari/disjoint_union.rb

@@ -4,7 +4,7 @@
 # The data structure provides efficient actions to merge two disjoint subsets, i.e., replace them by their union, and determine if
 # two elements are in the same subset.
 #
-# The elements of the set must be 0, 1, ..., n-1, where n is the size of the universe. Client code can map its data to these
+# The elements of the set are 0, 1, ..., n-1, where n is the size of the universe. Client code can map its data to these
 # representatives.
 #
 # See https://en.wikipedia.org/wiki/Disjoint-set_data_structure for a good introduction.
@@ -60,7 +60,7 @@ class DataStructuresRMolinari::DisjointUnion
   end
 
   private def check_value(v)
-    raise "Value must be given and be in (0..#{@size - 1})" unless v && v.between?(0, @size - 1)
+    raise DataError, "Value must be given and be in (0..#{@size - 1})" unless v && v.between?(0, @size - 1)
   end
 
   private def link(e, f)

data/lib/data_structures_rmolinari/generic_segment_tree.rb

@@ -13,7 +13,7 @@ require_relative 'shared'
 # Ruby.
 #
 # This is a generic implementation, intended to allow easy configuration for concrete instances. See the parameters to the
-# initializer and the defintiaons concrete realisations like MaxValSegmentTree.
+# initializer and the definitions of concrete realisations like MaxValSegmentTree.
 #
 # We do O(n) work to build the internal data structure at initialization. Then we answer queries in O(log n) time.
 class DataStructuresRMolinari::GenericSegmentTree
@@ -24,14 +24,14 @@ class DataStructuresRMolinari::GenericSegmentTree
   #   - For example, if we are calculating sums over subintervals, combine.call(a, b) = a + b, while if we are doing maxima we will
   #     return max(a, b).
   #   - Things get more complicated when we are calculating, say, the _index_ of the maximal value in a subinterval. Now it is not
-  #     enough simple to store that index at each tree node, because to combine the indices from two child nodes we need to know
+  #     enough simply to store that index at each tree node, because to combine the indices from two child nodes we need to know
   #     both the index of the maximal element in each child node's interval, but also the maximal values themselves, so we know
   #     which one "wins" for the parent node. This affects the sort of work we need to do when combining and the value provided by
   #     the +single_cell_array_val+ lambda.
   # @param single_cell_array_val a lambda that takes an index i and returns the value we need to store in the #build
   #     operation for the subinterval i..i.
-  #     - This is often simply be the value data[i], but in some cases it will be something else. For example, when we are
-  #       calculating the index of the maximal value on each subinterval we will retern the pair [i, data[i]] here.
+  #     - This will often simply be the value data[i], but in some cases it will be something else. For example, when we are
+  #       calculating the index of the maximal value on each subinterval we need [i, data[i]] here.
   #     - If +update_at+ is called later, this lambda must close over the underlying data in a way that captures the updated value.
   # @param size the size of the underlying data array, used in certain internal arithmetic.
   # @param identity the value to return when we are querying on an empty interval
@@ -96,7 +96,7 @@ class DataStructuresRMolinari::GenericSegmentTree
   private def update_val_at(idx, tree_idx, tree_l, tree_r)
     if tree_l == tree_r
       # We have found the spot!
-      raise LogicError, 'tree_l == tree_r, but they do not agree with the idx holding the updated value' unless tree_l == idx
+      raise InternalLogicError, 'tree_l == tree_r, but they do not agree with the idx holding the updated value' unless tree_l == idx
 
       @tree[tree_idx] = @single_cell_array_val.call(tree_l)
     else

data/lib/data_structures_rmolinari/heap.rb

@@ -13,8 +13,8 @@ require_relative 'shared'
 # - +empty?+
 #   - is the heap empty?
 #   - O(1)
-# - +insert+
-#   - add a new element to the heap with an associated priority
+# - +insert(item, priority)+
+#   - add a new item to the heap with an associated priority
 #   - O(log N)
 # - +top+
 #   - return the lowest-priority element, which is the element at the root of the tree. In a max-heap this is the highest-priority
@@ -23,12 +23,18 @@ require_relative 'shared'
 # - +pop+
 #   - removes and returns the item that would be returned by +top+
 #   - O(log N)
-# - +update+
+# - +update(item, priority)+
 #   - tell the heap that the priority of a particular item has changed
 #   - O(log N)
 #
 # Here N is the number of elements in the heap.
 #
+# The internal requirements needed to implement +update+ have several consequences.
+# - Items added to the heap must be distinct. Otherwise we would not know which occurrence to update
+# - There is some bookkeeping overhead.
+# If client code doesn't need to call +update+ then we can create a "non-addressable" heap that allows for the insertion of
+# duplicate items and has slightly faster runtime overall. See the arguments to the initializer.
+#
 # References:
 #
 # - https://en.wikipedia.org/wiki/Binary_heap
@@ -36,31 +42,31 @@ require_relative 'shared'
 #   DOI 10.1007/s00224-017-9760-2
 #
 # @todo
-#   - allow for priorities comparable only via +<=>+, like arrays
-#     - this requires different handling for max-heaps, as we can't just negate the priorities and use min-heap logic
-#   - relax the requirement that priorities must be comparable vai +<+ and respond to negation. Instead, allow comparison via +<=>+
-#     and handle max-heaps differently.
-#     - this will allow priorities to be arrays for tie-breakers and similar.
-#   - offer a non-addressable version that doesn't support +update+
-#     - configure through the initializer
-#     - other operations will be a little quicker, and we can add the same item more than once. The paper by Chen et al. referenced
-#       in the Wikipedia article for Pairing Heaps suggests that using such a priority queue for Dijkstra's algorithm and inserting
-#       multiple copies of a key rather than updating its priority is faster in practice than other approaches that have better
-#       theoretical performance.
+#   - let caller see the priority of the top element. Maybe this is useful sometimes.
 class DataStructuresRMolinari::Heap
+  include Shared
   include Shared::BinaryTreeArithmetic
 
+  # The number of items currently in the heap
   attr_reader :size
 
-  Pair = Struct.new(:priority, :item)
+  # An (item, priority) pair
+  InternalPair = Struct.new(:item, :priority)
+  private_constant :InternalPair
 
   # @param max_heap when truthy, make a max-heap rather than a min-heap
-  # @param debug when truthy, verify the heap property after each update than might violate it. This makes operations much slower.
-  def initialize(max_heap: false, debug: false)
+  # @param addressable when truthy, the heap is _addressable_. This means that
+  #   - item priorities are updatable with +update(item, p)+, and
+  #   - items added to the heap must be distinct.
+  #   When falsy, priorities are not updateable but items may be inserted multiple times. Operations are slightly faster because
+  #   there is less internal bookkeeping.
+  # @param debug when truthy, verify the heap property after each change that might violate it. This makes operations much slower.
+  def initialize(max_heap: false, addressable: true, debug: false)
     @data = []
     @size = 0
     @max_heap = max_heap
-    @index_of = {}
+    @addressable = addressable
+    @index_of = {} # used in addressable heaps
     @debug = debug
   end
 
@@ -70,26 +76,24 @@ class DataStructuresRMolinari::Heap
   end
 
   # Insert a new element into the heap with the given priority.
-  # @param value the item to be inserted. It is an error to insert an item that is already present in the heap, though we don't
-  #   check for this.
-  # @param priority the priority to use for new item. The values used as priorities ust be totally ordered via +<+ and, if +self+ is
-  #   a max-heap, must respond to negation +@-+ in the natural order-respecting way.
-  # @todo
-  #   - check for duplicate
+  # @param value the item to be inserted.
+  #   - If the heap is addressible (the default) it is an error to insert an item that is already present in the heap.
+  # @param priority the priority to use for new item. The values used as priorities must be totally ordered via +<=>+.
   def insert(value, priority)
-    priority *= -1 if @max_heap
+    raise DataError, "Heap already contains #{value}" if @addressable && contains?(value)
 
     @size += 1
 
-    d = Pair.new(priority, value)
+    d = InternalPair.new(value, priority)
     assign(d, @size)
 
     sift_up(@size)
   end
 
   # Return the top of the heap without removing it
-  # @return the value with minimal (maximal for max-heaps) priority. Strictly speaking, it returns the item at the root of the
-  #   binary tree; this element has minimal priority, but there may be other elements with the same priority.
+  # @return a value with minimal priority (maximal for max-heaps). Strictly speaking, it returns the item at the root of the
+  #   binary tree; this element has minimal priority, but there may be other elements with the same priority and they do not appear
+  #   at the top of the heap in any guaranteed order.
   def top
     raise 'Heap is empty!' unless @size.positive?
 
@@ -100,12 +104,11 @@ class DataStructuresRMolinari::Heap
   # @return (see #top)
   def pop
     result = top
-    @index_of.delete(result)
-
     assign(@data[@size], root)
 
     @data[@size] = nil
     @size -= 1
+    @index_of.delete(result) if @addressable
 
     sift_down(root) if @size.positive?
 
@@ -113,21 +116,20 @@ class DataStructuresRMolinari::Heap
   end
 
   # Update the priority of the given element and maintain the necessary heap properties.
+  #
   # @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 priority the new priority
-  #
-  # @todo
-  #   - check that the element is in the heap
   def update(element, priority)
-    priority *= -1 if @max_heap
+    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
     @data[idx].priority = priority
-    if priority > old
+    if less_than_priority?(old, priority)
       sift_down(idx)
-    elsif priority < old
+    elsif less_than_priority?(priority, old)
       sift_up(idx)
     end
 
@@ -141,7 +143,7 @@ class DataStructuresRMolinari::Heap
     x = @data[idx]
     while idx != root
       i = parent(idx)
-      break unless x.priority < @data[i].priority
+      break unless less_than?(x, @data[i])
 
       assign(@data[i], idx)
       idx = i
@@ -156,9 +158,9 @@ class DataStructuresRMolinari::Heap
     x = @data[idx]
 
     while (j = left(idx)) <= @size
-      j += 1 if j + 1 <= @size && @data[j + 1].priority < @data[j].priority
+      j += 1 if j + 1 <= @size && less_than?(@data[j + 1], @data[j])
 
-      break unless @data[j].priority < x.priority
+      break unless less_than?(@data[j], x)
 
       assign(@data[j], idx)
       idx = j
@@ -171,7 +173,27 @@ class DataStructuresRMolinari::Heap
   # Put the pair in the given heap location
   private def assign(pair, idx)
     @data[idx] = pair
-    @index_of[pair.item] = idx
+    @index_of[pair.item] = idx if @addressable
+  end
+
+  # Compare the priorities of two items with <=> and return truthy exactly when the result is -1.
+  #
+  # If this is a max-heap return truthy exactly when the result of <=> is 1.
+  #
+  # The arguments can also be the priorities themselves.
+  private def less_than?(p1, p2)
+    less_than_priority?(p1.priority, p2.priority)
+  end
+
+  # Direct comparison of priorities
+  private def less_than_priority?(priority1, priority2)
+    return (priority1 <=> priority2) == 1 if @max_heap
+
+    (priority1 <=> priority2) == -1
+  end
+
+  private def contains?(item)
+    !!@index_of[item]
   end
 
   # For debugging
@@ -180,8 +202,8 @@ class DataStructuresRMolinari::Heap
       left = left(idx)
       right = right(idx)
 
-      raise "Heap property violated by left child of index #{idx}" if left <= @size && @data[idx].priority >= @data[left].priority
-      raise "Heap property violated by right child of index #{idx}" if right <= @size && @data[idx].priority >= @data[right].priority
+      raise InternalLogicError, "Heap property violated by left child of index #{idx}" if left <= @size && less_than?(@data[left], @data[idx])
+      raise InternalLogicError, "Heap property violated by right child of index #{idx}" if right <= @size && less_than?(@data[right], @data[idx])
     end
   end
 end

data/lib/data_structures_rmolinari/max_priority_search_tree.rb

@@ -1,13 +1,9 @@
 require 'set'
 require_relative 'shared'
 
-
-# A priority search tree (PST) stores a set, P, of two-dimensional points (x,y) in a way that allows efficient answes to certain
+# A priority search tree (PST) stores a set, P, of two-dimensional points (x,y) in a way that allows efficient answers to certain
 # questions about P.
 #
-# (In the current implementation no two points can share an x-value and no two points can share a y-value. This (rather severe)
-# restriction can be relaxed with some more complicated code.)
-#
 # The data structure was introduced in 1985 by Edward McCreight. Later, De, Maheshwari, Nandy, and Smid showed how to construct a
 # PST in-place (using only O(1) extra memory), at the expense of some slightly more complicated code for the various supported
 # operations. It is their approach that we have implemented.
@@ -33,11 +29,15 @@ require_relative 'shared'
 #
 # The final operation (enumerate) takes O(m + log n) time, where m is the number of points that are enumerated.
 #
+# In the current implementation no two points can share an x-value and no two points can share a y-value. This (rather severe)
+# restriction can be relaxed with some more complicated code.
+#
+#
 # There is a related data structure called the Min-max priority search tree so we have called this a "Max priority search tree", or
 # MaxPST.
 #
 # References:
-# * E.M. McCreight, _Priority search trees_, SIAM J. Comput., 14(2):257-276, 1985.  Later, De,
+# * E.M. McCreight, _Priority search trees_, SIAM J. Comput., 14(2):257-276, 1985.
 # * M. De, A. Maheshwari, S. C. Nandy, M. Smid, _An In-Place Priority Search Tree_, 23rd Canadian Conference on Computational
 #   Geometry, 2011
 class DataStructuresRMolinari::MaxPrioritySearchTree
@@ -113,12 +113,12 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
 
     p = root
     if quadrant == :ne
-      best = Pair.new(INFINITY, -INFINITY)
+      best = Point.new(INFINITY, -INFINITY)
       preferred_child = ->(n) { right(n) }
       nonpreferred_child = ->(n) { left(n) }
       sufficient_x = ->(x) { x >= x0 }
     else
-      best = Pair.new(-INFINITY, -INFINITY)
+      best = Point.new(-INFINITY, -INFINITY)
       preferred_child = ->(n) { left(n) }
       nonpreferred_child = ->(n) { right(n) }
       sufficient_x = ->(x) { x <= x0 }
@@ -228,10 +228,10 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
 
     if quadrant == :ne
       sign = 1
-      best = Pair.new(INFINITY, INFINITY)
+      best = Point.new(INFINITY, INFINITY)
     else
       sign = -1
-      best = Pair.new(-INFINITY, INFINITY)
+      best = Point.new(-INFINITY, INFINITY)
     end
 
     p = q = root
@@ -373,7 +373,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
     #
     # Sometimes we don't have a relevant node to the left or right of Q. The booleans L and R (which we call left and right) track
     # whether p and q are defined at the moment.
-    best = Pair.new(INFINITY, -INFINITY)
+    best = Point.new(INFINITY, -INFINITY)
     p = q = left = right = nil
 
     x_range = (x0..x1)
@@ -641,7 +641,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
           end
           current = parent(current)
         else
-          raise LogicError, "Explore(t) state is somehow #{state} rather than 0, 1, or 2."
+          raise InternalLogicError, "Explore(t) state is somehow #{state} rather than 0, 1, or 2."
         end
       end
     end
@@ -786,7 +786,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
             p_in = right(p_in)
             left = true
           else
-            raise LogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
+            raise InternalLogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
 
             p = left(p_in)
             q = right(p_in)
@@ -796,7 +796,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
           end
         elsif left_val.x <= x1
           if right_val.x > x1
-            raise LogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
+            raise InternalLogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
 
             q = right(p_in)
             p_in = left(p_in)
@@ -810,7 +810,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
             right_in = true
           end
         else
-          raise LogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
+          raise InternalLogicError, 'q_in cannot be active, by the value in the right child of p_in!' if right_in
 
           q = left(p_in)
           deactivate_p_in.call
@@ -846,8 +846,8 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
 
       # q has two children. Cases!
       if @data[left(q)].x < x0
-        raise LogicError, 'p_in should not be active, based on the value at left(q)' if left_in
-        raise LogicError, 'q_in should not be active, based on the value at left(q)' if right_in
+        raise InternalLogicError, 'p_in should not be active, based on the value at left(q)' if left_in
+        raise InternalLogicError, 'q_in should not be active, based on the value at left(q)' if right_in
 
         left = true
         if @data[right(q)].x < x0
@@ -878,7 +878,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
 
     # Given: q' is active and satisfied x0 <= x(q') <= x1
     enumerate_right_in = lambda do
-      raise LogicError, 'right_in should be true if we call enumerate_right_in' unless right_in
+      raise InternalLogicError, 'right_in should be true if we call enumerate_right_in' unless right_in
 
       if @data[q_in].y >= y0
         report.call(q_in)
@@ -910,7 +910,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
       # q' has two children
       right_val = @data[right(q_in)]
       if left_val.x < x0
-        raise LogicError, 'p_in cannot be active, by the value in the left child of q_in' if left_in
+        raise InternalLogicError, 'p_in cannot be active, by the value in the left child of q_in' if left_in
 
         if right_val.x < x0
           p = right(q_in)
@@ -970,7 +970,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
 
     while left || left_in || right_in || right
       # byebug if $do_it
-      raise LogicError, 'It should not be that q_in is active but p_in is not' if right_in && !left_in
+      raise InternalLogicError, 'It should not be that q_in is active but p_in is not' if right_in && !left_in
 
       set_i = []
       set_i << :left if left
@@ -988,7 +988,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
       when :right
         enumerate_right.call
       else
-        raise LogicError, "bad symbol #{z}"
+        raise InternalLogicError, "bad symbol #{z}"
       end
     end
     return result unless block_given?
@@ -1134,7 +1134,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
   private def verify_properties
     # It's a max-heap in y
     (2..@size).each do |node|
-      raise LogicError, "Heap property violated at child #{node}" unless @data[node].y < @data[parent(node)].y
+      raise InternalLogicError, "Heap property violated at child #{node}" unless @data[node].y < @data[parent(node)].y
     end
 
     # Left subtree has x values less than all of the right subtree
@@ -1144,7 +1144,7 @@ class DataStructuresRMolinari::MaxPrioritySearchTree
       left_max = max_x_in_subtree(left(node))
       right_min = min_x_in_subtree(right(node))
 
-      raise LogicError, "Left-right property of x-values violated at #{node}" unless left_max < right_min
+      raise InternalLogicError, "Left-right property of x-values violated at #{node}" unless left_max < right_min
     end
   end
 

data/lib/data_structures_rmolinari/minmax_priority_search_tree.rb

@@ -2,15 +2,13 @@ require 'must_be'
 
 require_relative 'shared'
 
+# THIS CLASS IS INCOMPLETE AND NOT USABLE
+#
 # A priority search tree (PST) stores points in two dimensions (x,y) and can efficiently answer certain questions about the set of
 # point.
 #
 # The structure was introduced by McCreight [1].
 #
-# It is a binary search tree which is a max-heap by the y-coordinate, and, for a non-leaf node N storing (x, y), all the nodes in
-# the left subtree of N have smaller x values than any of the nodes in the right subtree of N. Note, though, that the x-value at N
-# has no particular property relative to the x values in its subtree. It is thus _almost_ a binary search tree in the x coordinate.
-#
 # See more: https://en.wikipedia.org/wiki/Priority_search_tree
 #
 # It is possible to build such a tree in place, given an array of pairs. See [2]. In a follow-up paper, [3], the authors show how to
@@ -45,7 +43,7 @@ class DataStructuresRMolinari::MinmaxPrioritySearchTree
 
   # The array of pairs is turned into a minmax PST in-place without cloning. So clone before passing it in, if you care.
   #
-  # Each element must respond to #x and #y. Use Pair (above) if you like.
+  # Each element must respond to #x and #y. Use Point (above) if you like.
   def initialize(data, verify: false)
     @data = data
     @size = @data.size
@@ -75,7 +73,7 @@ class DataStructuresRMolinari::MinmaxPrioritySearchTree
   #
   # Here T(x) is the subtree rooted at x
   def leftmost_ne(x0, y0)
-    best = Pair.new(INFINITY, INFINITY)
+    best = Point.new(INFINITY, INFINITY)
     p = q = root
 
     in_q = ->(pair) { pair.x >= x0 && pair.y >= y0 }
@@ -284,7 +282,7 @@ class DataStructuresRMolinari::MinmaxPrioritySearchTree
   #
   # This method returns p*
   # def highest_3_sided_up(x0, x1, y0)
-  #   best = Pair.new(INFINITY, -INFINITY)
+  #   best = Point.new(INFINITY, -INFINITY)
 
   #   in_q = lambda do |pair|
   #     pair.x >= x0 && pair.x <= x1 && pair.y >= y0
@@ -407,7 +405,7 @@ class DataStructuresRMolinari::MinmaxPrioritySearchTree
     #     - If Q intersect P is empty then p* = best
     #
     # Here, P is the set of points in our data structure and T_p is the subtree rooted at p
-    best = Pair.new(INFINITY, -INFINITY)
+    best = Point.new(INFINITY, -INFINITY)
     p = root # root of the whole tree AND the pair stored there
 
     in_q = lambda do |pair|

data/lib/data_structures_rmolinari/shared.rb

@@ -1,11 +1,19 @@
 # Some odds and ends shared by other classes
 module Shared
+  # Infinity without having to put a +Float::+ prefix every time
   INFINITY = Float::INFINITY
 
-  Pair = Struct.new(:x, :y)
+  # An (x, y) coordinate pair.
+  Point = Struct.new(:x, :y)
 
   # @private
+
+  # Used for errors related to logic errors in client code
   class LogicError < StandardError; end
+  # Used for errors related to logic errors in library code
+  class InternalLogicError < LogicError; end
+
+  # Used for errors related to data, such as duplicated elements where they must be distinct.
   class DataError < StandardError; end
 
   # @private

data/lib/data_structures_rmolinari.rb

@@ -1,7 +1,8 @@
 require_relative 'data_structures_rmolinari/shared'
 
 module DataStructuresRMolinari
-  Pair = Shared::Pair
+  # A struct responding to +.x+ and +.y+.
+  Point = Shared::Point
 end
 
 # These define classes inside module DataStructuresRMolinari
@@ -11,13 +12,15 @@ require_relative 'data_structures_rmolinari/heap'
 require_relative 'data_structures_rmolinari/max_priority_search_tree'
 require_relative 'data_structures_rmolinari/minmax_priority_search_tree'
 
+# A namespace to hold the provided classes. We want to avoid polluting the global namespace with names like "Heap"
 module DataStructuresRMolinari
   ########################################
   # Concrete instances of Segment Tree
   #
   # @todo consider moving these into generic_segment_tree.rb
 
-  # Takes an array A(0...n) and tells us what the maximum value is on a subinterval A(i..j) in O(log n) time.
+  # A segment tree that for an array A(0...n) answers questions of the form "what is the maximum value in the subinterval A(i..j)?"
+  # in O(log n) time.
   class MaxValSegmentTree
     extend Forwardable
 
@@ -25,28 +28,27 @@ module DataStructuresRMolinari
     def_delegator :@structure, :update_at
 
     # @param data an object that contains values at integer indices based at 0, via +data[i]+.
-    #   - The usual use case will be an Array, but it could also be a hash or a proc of some sort.
+    #   - This will usually be an Array, but it could also be a hash or a proc.
     def initialize(data)
       @structure = GenericSegmentTree.new(
         combine:               ->(a, b) { [a, b].max },
         single_cell_array_val: ->(i) { data[i] },
         size:                  data.size,
-        identity:              -Float::INFINITY
+        identity:              -Shared::INFINITY
       )
     end
 
-    # The maximum value in A(i..j)
+    # The maximum value in A(i..j).
     #
     # The arguments must be integers in 0...(A.size)
-    # @return the largest value in A(i..j).
-    #   - Return +nil+ if i > j
+    # @return the largest value in A(i..j) or -Infinity if i > j.
     def max_on(i, j)
       @structure.query_on(i, j)
     end
   end
 
-  # A segment tree that for an array A(0...n) efficiently answers questions of the form "what is the index of the maximal value in
-  # a subinterval A(i..j) in O(log n) time.
+  # A segment tree that for an array A(0...n) answers questions of the form "what is the index of the maximal value in the
+  # subinterval A(i..j)?" in O(log n) time.
   class IndexOfMaxValSegmentTree
     extend Forwardable
 
@@ -66,7 +68,7 @@ module DataStructuresRMolinari
     # The index of the maximum value in A(i..j)
     #
     # The arguments must be integers in 0...(A.size)
-    # @return (Integer, nil) the index of the largest value in A(i..j).
+    # @return (Integer, nil) the index of the largest value in A(i..j) or +nil+ if i > j.
     #   - If there is more than one entry with that value, return one the indices. There is no guarantee as to which one.
     #   - Return +nil+ if i > j
     def index_of_max_val_on(i, j)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_structures_rmolinari
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Rory Molinari
@@ -80,6 +80,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - lib/data_structures_rmolinari.rb
 - lib/data_structures_rmolinari/disjoint_union.rb
 - lib/data_structures_rmolinari/generic_segment_tree.rb