schulze-vote 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f1a89377c52c746f04598f5af4202130d6276e4
-  data.tar.gz: 55fab398da85310889bee1304c3b099d9a6a6554
+  metadata.gz: d14c1791421988a4b47d01a1a1d534a178447f4e
+  data.tar.gz: 970a191bb923a4469fea996a4d78537425b13d77
 SHA512:
-  metadata.gz: 0ee33a934d33321ea22e2f35bad75fa1c9b462b0b4e9c141b7e0709eabe8a3d547fba852526b70a9de395afa12fa55a30b3e4b60dc553b3aeaf95cb2e96a8fee
-  data.tar.gz: b7475ff5206ebd7f19166aaf89a4cb88c3e37bd7a2ae15e60d3b4b7b35bc91cab5da1e56541b7feba5b1aebf568c805bbf2e9864d2bd7bb0acfbf7912aa2e289
+  metadata.gz: bc0aab70b8a74efc664067693f2553e9a9c983be783ff1be51fc40d31eb112f79b3c435b7ed60963ac90214e24da0b7a1cd265a929a9b68978016e1a0363e301
+  data.tar.gz: 382412f15f3d6b445be9d8a49d01118b0a41db71cdb3247505bad3a7f5a76bba52b924e9da7d1196be8f6628684f7e69039cfa0c80c9156db884ea8e9ac3d35d

data/README.md

@@ -192,6 +192,13 @@ end
 
 which is the same result of the reference above.
 
+## Classifications
+
+You have a `classifications(limit_results = false)` that you can call.
+If the number of results is greater then the `limit_results` parameter then a `TooManyClassificationsException`
+is raised.
+If you set this parameter to any value other then `false` be careful to catch and manage the exception properly.
+
 ## Contributing to schulze-vote
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/vote/condorcet/schulze/basic.rb

@@ -49,8 +49,13 @@ module Vote
         # return all possible solutions to the votation
         attr_reader :winners_array
 
-        def classifications
-          @classifications ||= calculate_classifications
+        # compute all possible solutions
+        # since this can take days, there is an option to limit the numeber of calculated classifications
+        # the default is 10. if the system is calculating more then 10 possible classifications it will stop
+        # raising a TooManyClassifications exception
+        # you can set it to false to disable the limit
+        def classifications(limit_results = false)
+          @classifications ||= calculate_classifications(limit_results)
         end
 
         private
@@ -139,7 +144,7 @@ module Vote
           rank
         end
 
-        def calculate_classifications
+        def calculate_classifications(limit_results)
           calculate_potential_winners
           calculate_beat_couples
 
@@ -147,29 +152,35 @@ module Vote
           start_list.sort! { |e1, e2| rank_element(e1) <=> rank_element(e2) }
 
           classifications = []
-          compute_classifications(classifications, [], @potential_winners, @beat_couples, start_list)
+          compute_classifications(classifications, [], @potential_winners, @beat_couples, start_list, limit_results)
           classifications
         end
 
-        def compute_classifications(classifications, classif = [], potential_winners, beated_list, start_list)
+        def compute_classifications(classifications, classif = [], potential_winners,
+                                    beated_list, start_list, limit_results)
           if beated_list.empty?
             start_list.permutation.each do |array|
               classifications << classif + array
+              check_limits(classifications, limit_results)
             end
           else
             if classif.empty? && potential_winners.any?
               potential_winners.each do |element|
-                add_element(classifications, classif, nil, beated_list, start_list, element)
+                add_element(classifications, classif, nil, beated_list, start_list, element, limit_results)
               end
             else
               start_list.each do |element|
-                add_element(classifications, classif, nil, beated_list, start_list, element)
+                add_element(classifications, classif, nil, beated_list, start_list, element, limit_results)
               end
             end
           end
         end
 
-        def add_element(classifications, classif, _potential_winners, beated_list, start_list, element)
+        def check_limits(classifications, limit_results)
+          raise TooManyClassificationsException if limit_results && classifications.size > limit_results
+        end
+
+        def add_element(classifications, classif, _potential_winners, beated_list, start_list, element, limit_results)
           return if beated_list.any? { |c| c[1] == element }
           classification = classif.clone
           classification << element
@@ -178,11 +189,15 @@ module Vote
           next_start_list.delete(element)
           if next_start_list.empty?
             classifications << classification
+            check_limits(classifications, limit_results)
           else
-            compute_classifications(classifications, classification, nil, next_beated_list, next_start_list)
+            compute_classifications(classifications, classification, nil, next_beated_list, next_start_list, limit_results)
           end
         end
       end
     end
   end
 end
+
+class TooManyClassificationsException < StandardError
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schulze-vote
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies: []
 description: This gem is a Ruby implementation of the Schulze voting method (with
   help of the Floyd-Warshall algorithm), a type of the Condorcet voting methods.