vote-schulze 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # vote-schulze
 
-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.
+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.
 
 Wikipedia:
 
@@ -17,12 +17,45 @@ gem install vote-schulze
 
 ``` ruby
 require 'vote-schulze'
-vs = SchulzeBasic.new
-vs.load candidate_count, vote_list
-vs.run
-#=> [result as array]
+vs = SchulzeBasic.do candidate_count, vote_list
+vs.ranking_array
 ```
 
+`SchulzeBasic.do` - SchulzeBasic is a short term for `Vote::Condorcet::Schulze::Basic` and `.do` is a method of this class!
+
+Input:
+
+* `candidate_count` Integer: number of candidates
+* `vote_list` Array of Arrays: votes of each voter as weights `[ [A,B,C,...],[A,B,C,...],[A,B,C,...] ]`
+
+preference order to weight example:
+
+```
+voter  => A D C B
+
+weight => 4,1,2,3
+
+A is on first position = highest prio == 4
+B is on last position                 == 1
+C is on third position                == 2
+D is on second position               == 3
+```
+
+Later versions will have an automatic Preference-to-Weight algorithm.
+(Internally only integers are used for calculation of ranking.)
+
+### _SchulzeBasic_
+
+It doesn't matter if you start counting at 0 (zero) or 1 (one).
+
+Also it's not important, if you use jumps (like `1 3 5 9`).
+
+Internally it will only check if candidate X > candidate Y
+
+Output:
+
+* `.ranking_array` Array: numbers of total wins for each candidate `[candidate A, candidate B, candidate C, ...]`
+
 ## Contributing to vote-schulze
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -36,6 +69,5 @@ vs.run
 
 ## Copyright
 
-Copyright (c) 2011 Christoph Grabo. See LICENSE.txt for
-further details.
+Copyright (c) 2011 Christoph Grabo. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/vote-schulze.rb

@@ -1,7 +1,14 @@
 # encoding: UTF-8
+
+# $:<<`pwd`.strip
+# require 'vote-schulze'
+
 require 'matrix'
-require 'matrix_ext'
+require 'vote'
+require 'vote/matrix'
+
 autoload :Vote, 'vote'
+
 SchulzeInput = Vote::Condorcet::Schulze::Input
 SchulzeBasic = Vote::Condorcet::Schulze::Basic
 SchulzeWinAndLost = Vote::Condorcet::Schulze::WinAndLost

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

@@ -1,30 +1,17 @@
 # encoding: UTF-8
-require 'matrix'
 
 module Vote
   module Condorcet
     module Schulze
 
       class Basic
-        @candidate_count = 0
-        @vote_matrix = nil
-        @play_matrix = nil
-        @result_matrix = nil
-        @ranking = nil
-
-        def initialize candidate_count=0, vote_matrix=nil
-          if candidate_count > 0 && vote_matrix != nil
-            load
-          end
-          true
+
+        def initialize
+          #self
         end
 
         def load candidate_count, vote_matrix
 
-          @play_matrix = nil
-          @result_matrix = nil
-          @ranking = nil
-
           @candidate_count = candidate_count
 
           @vote_matrix = vote_matrix.is_a?(Vote::Condorcet::Schulze::Input) ? \
@@ -37,13 +24,11 @@ module Vote
           self
         end
 
-        def vote_matrix
-          @vote_matrix
-        end
+        private
 
         def play
 
-          @play_matrix ||= Matrix.scalar(@candidate_count,0)
+          @play_matrix = ::Matrix.scalar(@candidate_count,0).extend(Vote::Matrix)
 
           # step 1: find matches with wins
           @candidate_count.times do |i|
@@ -70,31 +55,26 @@ module Vote
             end
           end
 
-          true
+          self
         end
 
-        def play_matrix
-          @play_matrix
-        end
 
         def result
-          @result_matrix ||= Matrix.scalar(@candidate_count,0)
+
+          @result_matrix = ::Matrix.scalar(@candidate_count,0).extend(Vote::Matrix)
 
           @result_matrix.each_with_index do |e,x,y|
             next if x==y
             @result_matrix[x,y] = e+1 if @play_matrix[x,y] > @play_matrix[y,x]
           end
 
-          true
+          self
         end
 
-        def result_matrix
-          @result_matrix
-        end
 
         def rank
 
-          @ranking ||= Array.new(@candidate_count,0)
+          @ranking = Array.new(@candidate_count,0)
 
           @result_matrix.row_vectors.each_with_index do |v,i|
             v.to_a.map do |e|
@@ -102,23 +82,42 @@ module Vote
             end
           end
 
-          true
+          self
         end
 
-        def ranking_array
-          @ranking
-        end
+        public
 
         def run
           play
           result
           rank
+        end
+
+        def vote_matrix
+          @vote_matrix
+        end
+        def play_matrix
+          @play_matrix
+        end
+        def result_matrix
+          @result_matrix
+        end
+        def ranking_array
           @ranking
         end
 
-      end
 
-    end
-  end
-end
+        # All-in-One class method to get a calculated SchulzeBasic object
+        def self.do candidate_count, vote_matrix
+          instance = new
+          instance.load candidate_count, vote_matrix
+          instance.run
+          instance
+        end
+
+      end #Basic
+
+    end #Schulze
+  end #Condorcet
+end #Vote
 

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

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'matrix'
 
 module Vote
   module Condorcet
@@ -10,7 +9,7 @@ module Vote
         @vote_matrix = nil
 
         def initialize candidate_count, vote_list
-          @vote_matrix = Matrix.scalar(candidate_count,0)
+          @vote_matrix = ::Matrix.scalar(candidate_count,0).extend(Vote::Matrix)
           insert_vote_array(vote_list) if vote_list.is_a?(Array)
           insert_vote_file(vote_list) if vote_list.is_a?(File)
         end

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

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+
 module Vote
   module Condorcet
     module Schulze

data/lib/vote/matrix.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+# extend matrix with method []=(i,j,v)
+# usage: m = ::Matrix.scalar(size,value).extend(Vote::Matrix)
+
+module Vote
+  module Matrix
+
+    def []=(i,j,v)
+      @rows[i][j] = v
+    end
+
+  end
+end
+

data/vote-schulze.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vote-schulze}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Grabo"]
+  s.date = %q{2011-05-19}
+  s.description = %q{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.}
+  s.email = %q{chris@dinarrr.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/vote-schulze.rb",
+    "lib/vote.rb",
+    "lib/vote/condorcet.rb",
+    "lib/vote/condorcet/schulze.rb",
+    "lib/vote/condorcet/schulze/basic.rb",
+    "lib/vote/condorcet/schulze/input.rb",
+    "lib/vote/condorcet/schulze/win_and_lost.rb",
+    "lib/vote/matrix.rb",
+    "spec/spec_helper.rb",
+    "spec/vote-schulze_spec.rb",
+    "vote-schulze.gemspec"
+  ]
+  s.homepage = %q{http://github.com/asaaki/vote-schulze}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Schulze method implementation in Ruby (Condorcet voting method)}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vote-schulze
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-17 00:00:00.000000000 +02:00
+date: 2011-05-19 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18950060 !ruby/object:Gem::Requirement
+  requirement: &26515360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *18950060
+  version_requirements: *26515360
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &18949580 !ruby/object:Gem::Requirement
+  requirement: &26514880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *18949580
+  version_requirements: *26514880
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &18949100 !ruby/object:Gem::Requirement
+  requirement: &26514400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *18949100
+  version_requirements: *26514400
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &18948620 !ruby/object:Gem::Requirement
+  requirement: &26513920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18948620
+  version_requirements: *26513920
 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.
 email: chris@dinarrr.com
@@ -74,7 +74,6 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- lib/matrix_ext.rb
 - lib/vote-schulze.rb
 - lib/vote.rb
 - lib/vote/condorcet.rb
@@ -82,8 +81,10 @@ files:
 - lib/vote/condorcet/schulze/basic.rb
 - lib/vote/condorcet/schulze/input.rb
 - lib/vote/condorcet/schulze/win_and_lost.rb
+- lib/vote/matrix.rb
 - spec/spec_helper.rb
 - spec/vote-schulze_spec.rb
+- vote-schulze.gemspec
 has_rdoc: true
 homepage: http://github.com/asaaki/vote-schulze
 licenses:
@@ -100,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -203018078703163748
+      hash: 2256632431419553553
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/matrix_ext.rb

@@ -1,8 +0,0 @@
-# encoding: UTF-8
-# monkey patch for public element modification
-class Matrix
-  def []=(i,j,v)
-    @rows[i][j] = v
-  end
-end
-