weighted_list_rank 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f50527ee43cba5bd55144f8c76bc4b702cd2e84a797008aa4bed9cfa9b055a9
-  data.tar.gz: 0427e71591900a28fadcc5e68dae0bfbd71c7b97b00896953b5ecaec80ccbad7
+  metadata.gz: 801eb04183d7dec5f99bfbcb76a902a920dcfee105f83f0c0c9a98667b73e6e4
+  data.tar.gz: c5c5665b7205bc0fd52c4c7d23f34103ba2dfd764579e0a575897f8ce36e95af
 SHA512:
-  metadata.gz: 2da62414b58dafb3ac4e49cbc18e0cb1b24c09edb78e0888365a3ac68e16e764974a83be8379dabe3a4291673170d7d1e80429a1a1c97189aa7ee3f1edbae597
-  data.tar.gz: 545f22a6c95c3713698c743e7f5fb1f2495034fc57ee81b4a745a8d064594cc9fa818fd5481d6443152a51e1fdaa5a7f1f362e17297f72a345a6e59a36255d12
+  metadata.gz: 210d7a10b0978195b26a0fd3cbdfd068b93e09066ac332984e165d011170abb544837fc4aafd6cb410055bd7b412199733ca2d37e1190630aa5bd650f8f5df9a
+  data.tar.gz: 65adb83584d5b1ec5d2282a0f8411edb147eb700f3030e9ab4c80def5ca8d2d7963166091cda87e8ea8a603a1c7f7168d28b661c2cbf0a4c6807b3617c47551c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-02-03
+
+- refactored the exponential algorithm to only add bonus points out of a pool of 50% of a list's weight
+
+## [0.1.3] - 2024-02-03
+
+- sort the score_details by the highest score from each list first
+
 ## [0.1.2] - 2024-02-03
 
 - Added list weight to rank result

data/lib/weighted_list_rank/context.rb

@@ -34,7 +34,8 @@ module WeightedListRank
       sorted_items = items.map do |id, details|
         {
           id: id,
-          score_details: details[:list_details],
+          # Sort the score_details array by score in descending order before including it
+          score_details: details[:list_details].sort_by { |detail| -detail[:score] },
           total_score: details[:total_score]
         }
       end

data/lib/weighted_list_rank/strategies/exponential.rb

@@ -1,20 +1,9 @@
 module WeightedListRank
   module Strategies
-    # The Exponential strategy calculates the score of an item within a list using an exponential formula.
-    # This strategy emphasizes the significance of an item's rank within the list, where items with higher
-    # ranks (closer to 1) are exponentially more valuable than those with lower ranks.
-    #
-    # The exponential nature of the calculation is controlled by the +exponent+ attribute, allowing for
-    # flexible adjustment of how steeply the score decreases as rank increases.
     class Exponential < WeightedListRank::Strategy
-      # The exponent used in the score calculation formula. Higher values increase the rate at which
-      # scores decrease as item rank increases.
-      #
-      # @return [Float] the exponent value
       attr_reader :exponent
 
       # Initializes a new instance of the Exponential strategy with an optional exponent.
-      #
       # @param exponent [Float] the exponent to use in the score calculation formula, defaults to 1.5.
       def initialize(exponent: 1.5)
         @exponent = exponent
@@ -22,23 +11,28 @@ module WeightedListRank
 
       # Calculates the score of an item within a list based on its rank position, the total number of items,
       # and the list's weight, using an exponential formula.
+      # The bonus pool is set to 50% of the list's weight.
       #
       # @param list [WeightedListRank::List] the list containing the item being scored.
       # @param item [WeightedListRank::Item] the item for which to calculate the score.
       #
       # @return [Float] the calculated score for the item, adjusted by the list's weight and the specified exponent.
       def calculate_score(list, item)
-        rank_position = item.position
-
-        # if there are no positions, then just return the list weight
-        return list.weight if rank_position.nil?
+        # Return the list weight if there are no positions
+        return list.weight if item.position.nil?
 
         num_items = list.items.count
+        total_bonus_pool = list.weight * 0.5  # Bonus pool is 50% of the list's weight
+
+        # Calculate the exponential factor for the item's rank position
+        exponential_factor = (num_items + 1 - item.position)**exponent
+        total_exponential_factor = (1..num_items).sum { |pos| (num_items + 1 - pos)**exponent }
+
+        # Allocate a portion of the total bonus pool based on the item's exponential factor
+        item_bonus = (exponential_factor / total_exponential_factor) * total_bonus_pool
 
-        contribution = ((num_items + 1 - rank_position)**exponent) / num_items.to_f
-        scaled_contribution = contribution / num_items
-        bonus = scaled_contribution * list.weight
-        list.weight + bonus
+        # The final score is the list's weight plus the item's allocated bonus
+        list.weight + item_bonus
       end
     end
   end

data/lib/weighted_list_rank/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WeightedListRank
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list_rank
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Shane Sherman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop