From 0ecf724c8d154069cb372e4ef87e0eae9fe872a0 Mon Sep 17 00:00:00 2001 From: Benjamin Mako Hill Date: Fri, 27 Jan 2006 18:21:52 +0000 Subject: [PATCH 1/1] Initial import into SVN of rubyvote library git-svn-id: svn://rubyforge.org/var/svn/rubyvote/trunk@1 1440c7f4-e209-0410-9a04-881b5eb134a8 --- COPYING | 340 ++++++++++++++++++++++++++++++++++++++++++++++ README | 196 ++++++++++++++++++++++++++ lib/condorcet.rb | 238 ++++++++++++++++++++++++++++++++ lib/election.rb | 160 ++++++++++++++++++++++ lib/positional.rb | 76 +++++++++++ test.rb | 138 +++++++++++++++++++ 6 files changed, 1148 insertions(+) create mode 100644 COPYING create mode 100644 README create mode 100644 lib/condorcet.rb create mode 100644 lib/election.rb create mode 100644 lib/positional.rb create mode 100755 test.rb diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..b7b5f53 --- /dev/null +++ b/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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 2 of the License, or + (at your option) any later version. + + This program 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 should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/README b/README new file mode 100644 index 0000000..7029d84 --- /dev/null +++ b/README @@ -0,0 +1,196 @@ +RubyVote: Election Methods Library in Ruby +=========================================== + +:Author: Benjamin Mako Hill +:Copyright: MIT Media Lab and MIT +:License: GNU GPL + +Summary +-------- + +**Version:** 0.1 + +This software includes an set of classes to tally votes and compute +winners in elections or votes using a series of different +methods. Currrently these include: + +* Plurality or "winner-take-all" +* Approval +* Borda +* Simple Condorcet +* Condorcet with Cloneproof SSD + +More information can be found at the following pages: + +* http://en.wikipedia.org/wiki/Plurality_electoral_system +* http://en.wikipedia.org/wiki/Approval_voting +* http://en.wikipedia.org/wiki/Borda_count +* http://en.wikipedia.org/wiki/Condorcet_method +* http://en.wikipedia.org/wiki/Shulze_method + +Writing support for a new module (e.g., instant runnof voting) is a +fantastic way to to contribute to this module. + +This software is prerelease software. I am both a relatively new Ruby +progreammming and relatively new to election methods. These election +methods have bugs and may have bugs that skew results. If you are +understand Ruby and election methods, please do me a favor and audit +my code. + + + +How To Use This Library +------------------------- + +Using this library is relatively simple but will differ per election +methods. In each case, you will need to ``require`` the appropriate +file for the type of election you will be running and then create a +new vote object. You should then either pass an array of votes to the +object upon creation or pass votes in one at at a time. + + +.. Note:: *You* are responsible for ensuring that the votes are in + correct form before you hand them to this module. This will + not currently check for most types of invalid votes and does + not (currently) accept a list of candidates at creation from + which it checks all votes. As such, new candidates will be + created when seen. If you think this is a meaningful + addition to this library, please send a patch. Otherwise, + please check for the validity of votes BEFORE you pass them + to this election module. + +Examples of each type of election currently supported can be seen in +the test.rb file distributed in this archive. + +ElectionVote Objects +********************* + +Each ElectionVote object has the following exposed attributions: + +* ElectionVote#votes -- returns a list of votes that have been tallied +* ElectionVote#candidates -- returns a list of candidates + +Additionally, each subclass will create a #results method which will +return an ElectionResult subclass of the appropriate type. + +Currently, you use this module by creating any of the following types +of vote objects: + +Plurality +^^^^^^^^^^ + +This is the most simple "winner-take-all" system. The array passed to +the new vote object should be an array of strings. Each string is +counted as one vote for a candidate. + +Example:: + + require 'election' + vote_array = [ "A", "B", "B", "A" ] + resultobject = PluralityVote.new(vote_array).result + +Approval +^^^^^^^^^ + +Approval is similar to plurality voting except that users can vote for +more than one candidate at once naming all of the candidates that they +approve of. + +Example:: + + require 'election' + vote_array = [ ["A", "B"], ["B", "A"], ["B"] ] + resultobject = ApprovalVote.new(vote_array).result + +Borda +^^^^^^ + +Borda is a positional voting system and, as a result, takes a list of +ranked candidates and assigns points to each candidates based on their +order. In Borda, there are *n* candidate and the first candidates is +assigned *n* - 1 points and each subsequent candidate is assigned one +less point. The candidate is assigned no points. + +Currently, all candidates should be ranked in each ballot. + +Example:: + + require 'positional' + vote_array = [ ["A", "B"], ["B", "A"], ["B", "A"] ] + resultobject = BordaVote.new(vote_array).result + +Pure Condorcet +^^^^^^^^^^^^^^^^ + +Condorcet is a preferential system and, as such, each vote must list +of ranked preferences from most to least preferred. Currently, all +candidates must be listed. No ties are allowed on ballots with the +current implementation. + +Example:: + + require 'condorcet' + vote_array = [ ["A", "B"], ["B", "A"], ["B", "A"] ] + resultobject = PureCondorcetVote.new(vote_array).result + +Cloneproof Schwartz Sequential Dropping +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +`Cloneproof SSD` is a Condorcet variant with the ability to create +winners in circular defeats (e.g., A beats B, B beats C, C beats A) +where this is no clear winner in Condorcet. It is used identically to +Pure Condorcet. + +Example:: + + require 'condorcet' + vote_array = [ ["A", "B"], ["B", "A"], ["B", "A"] ] + resultobject = CloneproofSSDVote.new(vote_array).result + +ElectionResult Objects +*********************** + +Each election result object will have the following methods: + +* #winner? -- return boolean as to the winner or winners of an election +* #winners -- an array of winners of the election +* #ranked_candidates -- (where available) a list of ranked candidates + + +License +-------- + +This program 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 2 of the License, or (at +your option) any later version. + +This program 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 should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301, USA. + +Look in the COPYING file for the text of the GNU GPL. + +Authors +-------- + +Currently, the only contributor to this program is Benjamin Mako Hill +working at the MIT Media Lab. Please feel free to contribute to this +module and get your name added here. + +For more information about Mako and his programs, you can seee his +homepage here: + + http://mako.cc + +For more information about the MIT Media Lab, you can see its homepage +here: + + http://www.media.mit.edu + diff --git a/lib/condorcet.rb b/lib/condorcet.rb new file mode 100644 index 0000000..9733989 --- /dev/null +++ b/lib/condorcet.rb @@ -0,0 +1,238 @@ +# election library -- a ruby library for elections +# copyright © 2005 MIT Media Lab and Benjamin Mako Hill + +# This program 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 2 of the License, or +# (at your option) any later version. + +# This program 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 should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +################################################################# +## ==== condorcet.rb ==== +## +## This file contains Condorcet election methods. Currently this +## includes a pure condorcet and a CloneproofSSD implementation +## modeled after the Python-based Debian project election code and +## that gives the same results in several tested corner cases. +################################################################# + +################################################################## +## CondorcetVote Classes and SubClasses +## +## The CondorcetVote class is subclassed by the PureCondorcetVote and +## the CloneproofSSDVote classes but should not be used directly. + +require 'election' + +class CondorcetVote < ElectionVote + + def tally_vote(vote=nil) + + vote.each_with_index do |winner, index| + # only run through this if this *is* preferred to something + break if vote.length - 1 == index + losers = vote.last( vote.length - index ) + + losers.each do |loser| + next if winner == loser + + @votes[winner] = Hash.new unless @votes.has_key?(winner) + @votes[loser] = Hash.new unless @votes.has_key?(loser) + + if @votes[winner].has_key?(loser) + @votes[winner][loser] += 1 + else + @votes[winner][loser] = 1 + end + + # make sure we have a comparable object + @votes[loser][winner] = 0 unless @votes[loser].has_key?( winner ) + + @candidates << loser unless @candidates.include?( loser ) + end + + @candidates << winner unless @candidates.include?( winner ) + end + end + + protected + def verify_vote(vote=nil) + vote.instance_of?( Array ) and + vote == vote.uniq + end + +end + +class PureCondorcetVote < CondorcetVote + def result + PureCondorcetResult.new( self ) + end +end + +class CloneproofSSDVote < CondorcetVote + def result + CloneproofSSDResult.new( self ) + end +end + + +################################################################## +## CondorcetResult Classes and SubClasses +## +## The CondorcetResult class is subclassed by the PureCondorcetResult +## and the CloneproofSSDResult classes but should not be used +## directly. + +class CondorcetResult < ElectionResult + def initialize(voteobj=nil) + unless voteobj and voteobj.kind_of?( CondorcetVote ) + raise ArgumentError, "You must pass a CondorcetVote array.", caller + end + super(voteobj) + end + + protected + def defeats(candidates=nil, votes=nil) + candidates = @election.candidates unless candidates + votes = @election.votes unless votes + + defeats = Array.new + candidates.each do |candidate| + candidates.each do |challenger| + next if candidate == challenger + if votes[candidate][challenger] > votes[challenger][candidate] + defeats << [ candidate, challenger ] + end + end + end + + defeats + end + +end + +class PureCondorcetResult < CondorcetResult + def initialize(voteobj=nil) + super(voteobj) + self.condorcet() + end + + protected + def condorcet + votes = @election.votes + candidates = @election.candidates + + victors = Hash.new + candidates.each do |candidate| + victors[candidate] = Array.new + end + + self.defeats.each do |pair| + winner, loser = *pair + victors[winner] << loser + end + + winners = @election.candidates.find_all do |candidate| + victors[candidate].length == @election.candidates.length - 1 + end + + @winners << winners if winners.length == 1 + end +end + +class CloneproofSSDResult < CondorcetResult + def initialize(voteobj=nil) + super(voteobj) + @winners = self.cpssd() + end + + protected + def cpssd + votes = @election.votes + candidates = *@election.candidates + + def in_schwartz_set?(candidate, candidates, transitive_defeats) + candidates.each do |challenger| + next if candidate == challenger + + if transitive_defeats.include?( [ challenger, candidate ] ) and + not transitive_defeats.include?( [ candidate, challenger ] ) + return false + end + end + return true + end + + loop do + + # see the array with the standard defeats + transitive_defeats = self.defeats(candidates, votes) + + candidates.each do |cand1| + candidates.each do |cand2| + candidates.each do |cand3| + if transitive_defeats.include?( [ cand2, cand1 ] ) and + transitive_defeats.include?( [ cand1, cand3 ] ) and + not transitive_defeats.include?( [ cand2, cand3 ] ) and + not cand2 == cand3 + transitive_defeats << [ cand2, cand3 ] + end + end + end + end + + schwartz_set = Array.new + candidates.each do |candidate| + if in_schwartz_set?(candidate, candidates, transitive_defeats) + schwartz_set << candidate + end + end + + candidates = schwartz_set + + # look through the schwartz set now for defeats + defeats = self.defeats(candidates, votes) + + # it's a tie or there's only one option + break if defeats.length == 0 + + def is_weaker_defeat?( pair1, pair2 ) + votes = @election.votes + if votes[pair1[0]][pair1[1]] > votes[pair2[0]][pair2[1]] + return true + elsif votes[pair1[0]][pair1[1]] == votes[pair2[0]][pair2[1]] and + votes[pair1[1]][pair1[0]] > votes[pair2[1]][pair2[0]] + return true + else + false + end + end + + defeats.sort! do |pair1, pair2| + if is_weaker_defeat?( pair1, pair2 ) + +1 + elsif is_weaker_defeat?( pair2, pair1 ) + -1 + else + 0 + end + end + + votes[defeats[0][0]][defeats[0][1]] = 0 + votes[defeats[0][1]][defeats[0][0]] = 0 + + end + + return candidates + end + +end diff --git a/lib/election.rb b/lib/election.rb new file mode 100644 index 0000000..7fd8396 --- /dev/null +++ b/lib/election.rb @@ -0,0 +1,160 @@ +# election library -- a ruby library for elections +# copyright © 2005 MIT Media Lab and Benjamin Mako Hill + +# This program 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 2 of the License, or +# (at your option) any later version. + +# This program 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 should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +################################################################# +## ==== election.rb ==== +## +## This file contains the core ElectionVote and ElectionResults +## classes and the most common and simple election methods including +## plurality and approval voting. +################################################################# + +################################################################## +## ElectionVote Classes and SubClasses +## +## There classes are used to store, verify, and "tally" (i.e. count +## votes for the standard Election superclass and for the most common +## types of elections. + +class ElectionVote + attr_reader :votes + attr_reader :candidates + + def initialize(votes=nil) + @votes = Hash.new unless defined?(@votes) + @candidates = Array.new unless defined?(@candidates) + + if votes + if votes.instance_of?( Array ) + votes.each do |vote| + self.tally_vote(vote) if self.verify_vote(vote) + end + else + raise ElectionError, "Votes must be in the form of an array.", caller + end + end + end + + protected + # by default, this is set to look if the vote is defined. it should + # be overridden in each class + def verify_vote(vote=nil) + vote ? true : false + end + + # by default, this does nothing. it must be redefined in any subclass + def tally_vote + self.verify_vote(vote) + end +end + +class PluralityVote < ElectionVote + def result + PluralityResult.new(self) + end + + protected + def verify_vote(vote=nil) + vote.instance_of?( String ) + end + + def tally_vote(candidate) + if @votes.has_key?(candidate) + @votes[candidate] += 1 + else + @votes[candidate] = 1 + @candidates << candidate + end + end +end + +class ApprovalVote < PluralityVote + def result + ApprovalResult.new(self) + end + + protected + def verify_vote(vote=nil) + vote.instance_of?( Array ) and vote.length >= 1 + end + + def tally_vote(approvals) + approvals.each {|candidate| super(candidate)} + end +end + + +################################################################## +## Election Result Classes +## + +## There classes are used to compute and report the results of an +## election. In almost all cases, these will be returned by the +## #results method of a corresponding ElectionVote subclass. + +class ElectionResult + attr_reader :winners + + def initialize(voteobj=nil) + unless voteobj and voteobj.kind_of?( ElectionVote ) + raise ArgumentError, "You must pass a ElectionVote array.", caller + end + + @election = voteobj + @winners = Array.new + end + + def winner + @winners[0] if @winners.length > 0 + end + + def winner? + @winners.length > 0 + end + +end + +class PluralityResult < ElectionResult + attr_reader :ranked_candidates + + def initialize(voteobj=nil) + super(voteobj) + + votes = @election.votes + candidates = @election.candidates + + @ranked_candidates = votes.sort do |a, b| + b[1] <=> a[1] + end.collect {|a| a[0]} + + # winners are anyone who has the same number of votes as the + # first person + @winners = @ranked_candidates.find_all do |i| + votes[i] == votes[@ranked_candidates[0]] + end + end +end + +# this class is complete because results for approval are computed +# identically to results from plurality +class ApprovalResult < PluralityResult +end + +class ElectionError < ArgumentError +end + diff --git a/lib/positional.rb b/lib/positional.rb new file mode 100644 index 0000000..5136aec --- /dev/null +++ b/lib/positional.rb @@ -0,0 +1,76 @@ +# election library -- a ruby library for elections +# copyright © 2005 MIT Media Lab and Benjamin Mako Hill + +# This program 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 2 of the License, or +# (at your option) any later version. + +# This program 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 should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +################################################################# +## ==== positional.rb ==== +## +## This file contains positional election methods. Currently only +## includes an implementation of the Borda count election method. +################################################################# + +################################################################## +## BordaVote and BordaResult Classes +## +## These classes inherit from and/or are modeled after the classes in +## election.rb and condorcet.rb + +require 'election' + +class BordaVote < ElectionVote + + def initialize(votes=nil) + @candidates = Array.new + votes.each do |vote| + @candidates = vote.uniq if vote.uniq.length > candidates.length + end + super(votes) + end + + def tally_vote(vote) + points = candidates.length - 1 + vote.each do |candidate| + @votes[candidate] = points + points -= 1 + end + end + + def verify_vote(vote=nil) + vote.instance_of?( Array ) and + vote == vote.uniq + end + + def result + BordaResult.new(self) + end +end + +class BordaResult < ElectionResult + def initialize(voteobj=nil) + super(voteobj) + votes = @election.votes + + @ranked_candidates = votes.sort do |a, b| + b[1] <=> a[1] + end.collect {|i| i[0]} + + @winners = @ranked_candidates.find_all do |i| + votes[i] == votes[@ranked_candidates[0]] + end + end + +end diff --git a/test.rb b/test.rb new file mode 100755 index 0000000..3be4176 --- /dev/null +++ b/test.rb @@ -0,0 +1,138 @@ +#!/usr/bin/ruby -I./lib + +# election library -- a ruby library for elections +# copyright © 2005 MIT Media Lab and Benjamin Mako Hill + +# This program 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 2 of the License, or +# (at your option) any later version. + +# This program 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 should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +require 'election' +require 'condorcet' +require 'positional' + +def print_winner(result) + if not result.winner? + puts "There is no winner." + elsif result.winners.length == 1 + puts "The winner is %s" % result.winners[0] + else + puts "There is a tie between the following candidates: %s" % result.winners.join(", ") + end +end + +def condorcet_test1 + puts "USING CONDORCET..." + puts "The winner should be: B" + + vote_array = Array.new + 3.times {vote_array << "ABC".split("")} + 3.times {vote_array << "CBA".split("")} + 2.times {vote_array << "BAC".split("")} + + print_winner( PureCondorcetVote.new(vote_array).result ) +end + +def ssd_test1 + puts "USING CloneProofSSD..." + puts "The winner should be: E" + + vote_array = Array.new + 5.times {vote_array << "ACBED".split("")} + 5.times {vote_array << "ADECB".split("")} + 8.times {vote_array << "BEDAC".split("")} + 3.times {vote_array << "CABED".split("")} + 7.times {vote_array << "CAEBD".split("")} + 2.times {vote_array << "CBADE".split("")} + 7.times {vote_array << "DCEBA".split("")} + 8.times {vote_array << "EBADC".split("")} + + print_winner( CloneproofSSDVote.new(vote_array).result ) +end + +def ssd_test2 + puts "USING CloneProofSSD..." + puts "The winner should be: D" + + vote_array = Array.new + 5.times {vote_array << "ACBD".split("")} + 2.times {vote_array << "ACDB".split("")} + 3.times {vote_array << "ADCB".split("")} + 4.times {vote_array << "BACD".split("")} + 3.times {vote_array << "CBDA".split("")} + 3.times {vote_array << "CDBA".split("")} + 1.times {vote_array << "DACB".split("")} + 5.times {vote_array << "DBAC".split("")} + 4.times {vote_array << "DCBA".split("")} + + print_winner( CloneproofSSDVote.new(vote_array).result ) +end + +def ssd_test3 + puts "USING CloneProofSSD..." + puts "The winner should be: B(?)" + + vote_array = Array.new + 3.times {vote_array << "ABCD".split("")} + 2.times {vote_array << "DABC".split("")} + 2.times {vote_array << "DBCA".split("")} + 2.times {vote_array << "CBDA".split("")} + + print_winner( CloneproofSSDVote.new(vote_array).result ) +end + + +def borda_test1 + puts "USING BORDA..." + puts "The winner should be: B" + + vote_array = Array.new + 3.times {vote_array << "ABC".split("")} + 3.times {vote_array << "CBA".split("")} + 2.times {vote_array << "BAC".split("")} + + print_winner( BordaVote.new(vote_array).result ) +end + +def plurality_test1 + puts "USING PLURALITY..." + puts "The winner should be: C" + + vote_array = "ABCABCABCCCBBAAABABABCCCCCCCCCCCCCA".split("") + + print_winner( PluralityVote.new(vote_array).result ) +end + + +def approval_test1 + puts "USING APPROVAL..." + puts "The winner should be: A" + + vote_array = Array.new + 10.times {vote_array << "AB".split("")} + 10.times {vote_array << "CB".split("")} + 11.times {vote_array << "AC".split("")} + 5.times {vote_array << "A".split("")} + + print_winner( ApprovalVote.new(vote_array).result ) +end + +condorcet_test1() +ssd_test1() +ssd_test2() +ssd_test3() +borda_test1() +plurality_test1() +approval_test1() + -- 2.39.5