sapor 0.1b1 → 0.2a1

data/lib/sapor/largest_remainder.rb

@@ -0,0 +1,118 @@
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+module Sapor
+  #
+  # Class representing a largest remainder electoral system with only one
+  # district.
+  #
+  class LargestRemainder
+    def initialize(no_of_seats, quota_class, threshold = 0, full_quota = false,
+                   bonus = 0, other_eligible = true)
+      @no_of_seats = no_of_seats
+      @quota_class = quota_class
+      @threshold = threshold
+      @full_quota = full_quota
+      @bonus = bonus
+      @other_eligible = other_eligible
+    end
+
+    def project(simulation)
+      result = create_empty_result(simulation)
+      thresholded_simulation = apply_threshold(simulation)
+      total_votes = if @full_quota
+                      simulation.values.inject(:+)
+                    else
+                      thresholded_simulation.values.inject(:+)
+                    end
+      quota = @quota_class.get(total_votes, @no_of_seats)
+      add_automatic_seats(result, thresholded_simulation, quota)
+      add_remaining_seats(result, thresholded_simulation, quota)
+      result[simulation.max_by(&:last)[0]] += @bonus
+      result
+    end
+
+    private
+
+    def add_automatic_seats(result, simulation, quota)
+      simulation.each_pair do |choice, votes|
+        result[choice] = (votes / quota).floor
+      end
+    end
+
+    def add_remaining_seats(result, simulation, quota)
+      remainders = calculate_remainders(simulation, quota)
+      choices = simulation.keys.sort { |a, b| remainders[b] <=> remainders[a] }
+      remaining_seats = @no_of_seats - result.values.inject(:+)
+      choices.slice(0, remaining_seats).each { |c| result[c] += 1 }
+    end
+
+    def apply_threshold(simulation)
+      threshold = simulation.values.inject(:+).to_f * @threshold
+      thresholded_simulation = {}
+      simulation.each_pair do |choice, votes|
+        thresholded_simulation[choice] = votes >= threshold ? votes : 0
+      end
+      thresholded_simulation[OTHER] = 0 unless @other_eligible
+      thresholded_simulation
+    end
+
+    def calculate_remainders(simulation, quota)
+      remainders = {}
+      simulation.each_pair do |choice, votes|
+        remainders[choice] = votes / quota - (votes / quota).floor
+      end
+      remainders
+    end
+
+    def create_empty_result(simulation)
+      result = {}
+      simulation.each_key do |choice|
+        result[choice] = 0
+      end
+      result[OTHER] = 0
+      result
+    end
+  end
+
+  #
+  # Class calculating the Hare quota.
+  #
+  class HareQuota
+    def self.get(total_votes, no_of_seats)
+      total_votes.to_f / no_of_seats
+    end
+  end
+
+  #
+  # Class calculating the Droop quota.
+  #
+  class DroopQuota
+    def self.get(total_votes, no_of_seats)
+      1 + total_votes.to_f / (1 + no_of_seats)
+    end
+  end
+
+  #
+  # Class calculating the Hagenbach-Bischoff quota.
+  #
+  class HagenbachBischoffQuota
+    def self.get(total_votes, no_of_seats)
+      total_votes.to_f / (1 + no_of_seats)
+    end
+  end
+end

data/lib/sapor/log4r_logger.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Statistical Analysis of Polling Results (SAPoR)
-# Copyright (C) 2014 Filip van Laenen <f.a.vanlaenen@ieee.org>
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
 #
 # This file is part of SAPoR.
 #

data/lib/sapor/log_facade.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Statistical Analysis of Polling Results (SAPoR)
-# Copyright (C) 2014 Filip van Laenen <f.a.vanlaenen@ieee.org>
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
 #
 # This file is part of SAPoR.
 #

data/lib/sapor/{leveled_proportional.rb → multi_district_leveled_proportional.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Statistical Analysis of Polling Results (SAPoR)
-# Copyright (C) 2014 Filip van Laenen <f.a.vanlaenen@ieee.org>
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
 #
 # This file is part of SAPoR.
 #
@@ -19,16 +19,16 @@
 
 module Sapor
   #
-  # Class representing a proportional electoral system with a second round of
-  # leveling seats.
+  # Class representing a multi-district proportional electoral system with a
+  # second round of leveling seats.
   #
-  class LeveledProportional
+  class MultiDistrictLeveledProportional
     def initialize(last_election_result, last_detailed_election_result,
                    seat_distribution, leveling_seats, leveling_threshold,
                    denominators_class)
-      @proportional = Proportional.new(last_election_result,
-                                       last_detailed_election_result,
-                                       seat_distribution, denominators_class)
+      @proportional = MultiDistrictProportional.new(last_election_result,
+                                                    last_detailed_election_result,
+                                                    seat_distribution, denominators_class)
       @leveling_seats = leveling_seats
       @leveling_threshold = leveling_threshold
       @denominators_class = denominators_class

data/lib/sapor/{proportional.rb → multi_district_proportional.rb}

@@ -1,7 +1,6 @@
-# encoding: utf-8
 #
 # Statistical Analysis of Polling Results (SAPoR)
-# Copyright (C) 2014 Filip van Laenen <f.a.vanlaenen@ieee.org>
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
 #
 # This file is part of SAPoR.
 #
@@ -19,24 +18,35 @@
 
 module Sapor
   #
-  # Class representing a proportional electoral system.
+  # Class representing a proportional electoral system with more than one
+  # district.
   #
-  class Proportional
+  class MultiDistrictProportional
     def initialize(last_election_result, last_detailed_election_result,
-                   seat_distribution, denominators_class, threshold = 0)
+                   seat_distribution, denominators_class, threshold = 0,
+                   national_threshold = 0)
       @last_election_result = last_election_result
       @last_detailed_election_result = last_detailed_election_result
       @seat_distribution = seat_distribution
       @denominators_class = denominators_class
       @threshold = threshold
+      @national_threshold = national_threshold
     end
 
     def project(simulation)
+      allowed_parties = []
+      unless @national_threshold.zero?
+        threshold = @national_threshold * simulation.values.inject(:+)
+        simulation.each_pair do |choice, votes|
+          allowed_parties << choice if votes >= threshold
+        end
+      end
       multiplicators = calculate_multiplicators(simulation)
       result = create_empty_result(simulation)
       @last_detailed_election_result.each_pair do |name, local_last_result|
         no_of_seats = @seat_distribution[name]
-        seats = local_seats(no_of_seats, local_last_result, multiplicators)
+        seats = local_seats(no_of_seats, local_last_result, multiplicators,
+                            allowed_parties)
         add_seats_to_result(result, seats)
       end
       result
@@ -78,18 +88,20 @@ module Sapor
     def local_votes(local_last_result, multiplicators)
       local_votes = {}
       local_last_result.each_pair do |choice, votes|
-        if multiplicators.key?(choice)
-          local_votes[choice] = votes * multiplicators[choice]
-        else
-          local_votes[choice] = votes
-        end
+        local_votes[choice] = if multiplicators.key?(choice)
+                                votes * multiplicators[choice]
+                              else
+                                votes
+                              end
       end
       local_votes
     end
 
-    def local_quotients(local_votes, local_threshold, no_of_seats)
+    def local_quotients(local_votes, local_threshold, no_of_seats,
+                        allowed_parties)
       local_quotients = []
       local_votes.each_pair do |choice, new_value|
+        next unless allowed_parties.empty? || allowed_parties.include?(choice)
         next if new_value < local_threshold
         @denominators_class.get(no_of_seats).each do |d|
           local_quotients << [choice, new_value.to_f / d]
@@ -98,31 +110,14 @@ module Sapor
       local_quotients
     end
 
-    def local_seats(no_of_seats, local_last_result, multiplicators)
+    def local_seats(no_of_seats, local_last_result, multiplicators,
+                    allowed_parties)
       local_votes = local_votes(local_last_result, multiplicators)
       local_threshold = local_votes.values.inject(:+).to_f * @threshold
       local_quotients = local_quotients(local_votes, local_threshold,
-                                        no_of_seats)
+                                        no_of_seats, allowed_parties)
       sorted_quotients = local_quotients.sort { |a, b| b.last <=> a.last }
       sorted_quotients.map(&:first).slice(0, no_of_seats)
     end
   end
-
-  #
-  # Class building the denominators for D'Hondt.
-  #
-  class DhondtDenominators
-    def self.get(size)
-      Range.new(1, size)
-    end
-  end
-
-  #
-  # Class building the denominators for modified Sainte-Lague.
-  #
-  class SainteLague14Denominators
-    def self.get(size)
-      Range.new(1, size).map { |a| a.equal?(1) ? 1.4 : a * 2 - 1 }
-    end
-  end
 end

data/lib/sapor/multi_district_variable_threshold_proportional.rb

@@ -0,0 +1,128 @@
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+module Sapor
+  #
+  # Class representing a proportional electoral system with more than one
+  # district.
+  #
+  class MultiDistrictVariableThresholdProportional
+    def initialize(last_election_result, last_detailed_election_result,
+                   seat_distribution, denominators_class,
+                   party_list_threshold, coalition_list_threshold,
+                   coalition_lists, minority_lists)
+      @last_election_result = last_election_result
+      @last_detailed_election_result = last_detailed_election_result
+      @seat_distribution = seat_distribution
+      @denominators_class = denominators_class
+      @party_list_threshold = party_list_threshold
+      @coalition_list_threshold = coalition_list_threshold
+      @coalition_lists = coalition_lists
+      @minority_lists = minority_lists
+    end
+
+    def project(simulation)
+      allowed_parties = []
+      total_votes = simulation.values.inject(:+)
+      party_list_threshold = @party_list_threshold * total_votes
+      coalition_list_threshold = @coalition_list_threshold * total_votes
+      simulation.each_pair do |choice, votes|
+        next unless @minority_lists.include?(choice) ||
+                    @coalition_lists.include?(choice) &&
+                    votes >= coalition_list_threshold ||
+                    !@coalition_lists.include?(choice) &&
+                    votes >= party_list_threshold
+        allowed_parties << choice
+      end
+      multiplicators = calculate_multiplicators(simulation)
+      result = create_empty_result(simulation)
+      @last_detailed_election_result.each_pair do |name, local_last_result|
+        no_of_seats = @seat_distribution[name]
+        seats = local_seats(no_of_seats, local_last_result, multiplicators,
+                            allowed_parties)
+        add_seats_to_result(result, seats)
+      end
+      result
+    end
+
+    private
+
+    def add_seats_to_result(result, seats)
+      seats.each do |seat|
+        if result.key?(seat)
+          result[seat] += 1
+        else
+          result[seat] = 1
+        end
+      end
+    end
+
+    def calculate_multiplicators(simulation)
+      simulation_sum = simulation.values.inject(:+)
+      last_election_sum = @last_election_result.values.inject(:+)
+      multiplicators = {}
+      simulation.each_key do |choice|
+        new_fraction = simulation[choice].to_f / simulation_sum
+        last_fraction = @last_election_result[choice].to_f / last_election_sum
+        multiplicators[choice] = new_fraction / last_fraction
+      end
+      multiplicators
+    end
+
+    def create_empty_result(simulation)
+      result = {}
+      simulation.each_key do |choice|
+        result[choice] = 0
+      end
+      result[OTHER] = 0
+      result
+    end
+
+    def local_votes(local_last_result, multiplicators)
+      local_votes = {}
+      local_last_result.each_pair do |choice, votes|
+        local_votes[choice] = if multiplicators.key?(choice)
+                                votes * multiplicators[choice]
+                              else
+                                votes
+                              end
+      end
+      local_votes
+    end
+
+    def local_quotients(local_votes, no_of_seats, allowed_parties)
+      local_quotients = []
+      local_votes.each_pair do |choice, new_value|
+        next unless allowed_parties.empty? || allowed_parties.include?(choice)
+        @denominators_class.get(no_of_seats).each do |d|
+          local_quotients << [choice, new_value.to_f / d]
+        end
+      end
+      local_quotients
+    end
+
+    def local_seats(no_of_seats, local_last_result, multiplicators,
+                    allowed_parties)
+      local_votes = local_votes(local_last_result, multiplicators)
+      local_quotients = local_quotients(local_votes, no_of_seats,
+                                        allowed_parties)
+      sorted_quotients = local_quotients.sort { |a, b| b.last <=> a.last }
+      sorted_quotients.map(&:first).slice(0, no_of_seats)
+    end
+  end
+end

data/lib/sapor/number_formatter.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Statistical Analysis of Polling Results (SAPoR)
-# Copyright (C) 2014 Filip van Laenen <f.a.vanlaenen@ieee.org>
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
 #
 # This file is part of SAPoR.
 #

data/lib/sapor/options.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+#
+# Statistical Analysis of Polling Results (SAPoR)
+# Copyright (C) 2016 Filip van Laenen <f.a.vanlaenen@ieee.org>
+#
+# This file is part of SAPoR.
+#
+# SAPoR is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# SAPoR is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You can find a copy of the GNU General Public License in /doc/gpl.txt
+#
+
+module Sapor
+
+  #
+  # Represents a set of options.
+  #
+  class Options
+    DEFAULT_MAX_ERROR = 0.001
+    DEFAULT_MAX_POLYCHOTOMY_ITERATIONS = 2 ** 25
+    DEFAULT_MIN_DICHOTOMIES_ITERATIONS = 0
+    DEFAULT_MIN_POLYCHOTOMY_ITERATIONS = 2 ** 20
+
+    MAX_ERROR_KEY = 'emx'
+    MAX_POLYCHOTOMY_ITERATIONS_KEY = 'pmx'
+    MIN_DICHOTOMIES_ITERATIONS_KEY = 'dmn'
+    MIN_POLYCHOTOMY_ITERATIONS_KEY = 'pmn'
+    
+    FLOAT_OPTIONS = [MAX_ERROR_KEY]
+    INTEGER_OPTIONS = [MAX_POLYCHOTOMY_ITERATIONS_KEY, MIN_DICHOTOMIES_ITERATIONS_KEY, MIN_POLYCHOTOMY_ITERATIONS_KEY]
+
+    def initialize(arguments)
+      @hash = { MAX_ERROR_KEY => DEFAULT_MAX_ERROR,
+        MAX_POLYCHOTOMY_ITERATIONS_KEY => DEFAULT_MAX_POLYCHOTOMY_ITERATIONS,
+        MIN_DICHOTOMIES_ITERATIONS_KEY => DEFAULT_MIN_DICHOTOMIES_ITERATIONS,
+        MIN_POLYCHOTOMY_ITERATIONS_KEY => DEFAULT_MIN_POLYCHOTOMY_ITERATIONS }
+      arguments.each do | argument |
+        key_value = argument[1..-1].split('=')
+        key = key_value.first
+        value = key_value.last
+        if INTEGER_OPTIONS.include?(key)
+          value = value.to_i
+        elsif FLOAT_OPTIONS.include?(key)
+          value = value.to_f
+        end
+        @hash[key] = value
+      end
+    end
+    
+    def max_error
+      @hash[MAX_ERROR_KEY]
+    end
+    
+    def max_polychotomy_iterations
+      @hash[MAX_POLYCHOTOMY_ITERATIONS_KEY]
+    end
+
+    def min_dichotomies_iterations
+      @hash[MIN_DICHOTOMIES_ITERATIONS_KEY]
+    end
+
+    def min_polychotomy_iterations
+      @hash[MIN_POLYCHOTOMY_ITERATIONS_KEY]
+    end
+  end
+end