Borda voting rule added by leorasc · Pull Request #5 · the-maldridge/python-vote-core

leorasc · 2023-01-16T13:41:54Z

I added the Borda voting rule for one winner and for more winners, similar to the implementation of the Plurality voting rule. In addition, I added an implementation of the coalitional manipulation heuristics: Average Fit and Largest Fit.
Another minor fix in test_schulze_method: the test test_tuple_ballots somtimes fails, and somtimes does not, for the random tie-breaking order.

not completley implemented yet.

modified: py3votecore/borda_at_large.py

modified: test_functionality/test_borda_at_large.py

modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda_at_large.py modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

…exist modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda_manipulation_heurestics_methods.py

Working branch

modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: test_functionality/test_borda_manipulation_heurestics_methods.py

Working branch

new file: requirement.txt modified: setup.py modified: test_functionality/test_schulze_method.py

Added requirements and fixed a test.

modified: README.rst modified: py3votecore/borda.py modified: py3votecore/borda_at_large.py modified: py3votecore/borda_manipulation_heurestics_methods.py modified: setup.py modified: test_functionality/test_borda.py modified: test_functionality/test_borda_at_large.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

Added description of the added Borda votting rule and version update

erelsgl · 2023-01-16T18:31:20Z

py3votecore/borda_at_large.py

+import copy
+
+class BordaAtLarge(MultipleWinnerVotingSystem):
+


Add class documentation and doctest.

Added. Thank you

erelsgl · 2023-01-16T18:31:28Z

py3votecore/borda.py

+from .borda_at_large import BordaAtLarge
+
+class Borda(AbstractSingleWinnerVotingSystem):
+


Add class documentation and doctest.

Added. Thank you

modified: py3votecore/borda.py modified: py3votecore/borda_at_large.py

the-maldridge

Many small nits. This is a first pass review that does not check actual conformance against the algorithm in the linked whitepaper.

Each review item is commented on the first time I saw it, but multiple occurrences may exist within your patch. You will need to rebase your commits into a single logical change and push back to this PR prior to merge, but as I have not yet verified the correctness of the code, this is not required yet.

I found this PR difficult to review due to the lack of whitespace in most files. I strongly encourage you to refactor your code such that comments appear above the line they explain and to generally use whitespace to break up large blocks of code based on what each subsection does.

the-maldridge · 2023-02-08T04:05:01Z

py3votecore/borda.py

+
+    def __init__(self, ballots, tie_breaker=None):
+        """
+        The constructer accepts ballots of voters and a tie breaker if given.


Indeed it does expect ballots and a tie breaker, but the format would be useful to know for anyone consuming this class. You should amend the comment to include a brief description of the expected format of the ballots.

the-maldridge · 2023-02-08T04:05:31Z

py3votecore/borda.py

@@ -0,0 +1,36 @@
+# Copyright (C) 2023, Leora Schmerler


name should be added to CONTRIBUTORS at the root of the repo.

the-maldridge · 2023-02-08T04:06:35Z

py3votecore/borda_at_large.py

+
+    def calculate_results(self):
+        """
+        calculate_results accepts an instance of Borda, and is called from the constructor.


Typically you would not state that it accepts anything if the only argument is the class instance itself. This should be reworded to describe what the function actually does.

the-maldridge · 2023-02-08T04:07:52Z

py3votecore/borda_at_large.py

+
+    def as_dict(self):
+        """
+        as_dict accepts an instance of Borda, and returns a dict of the BordaAtLarge.


Same as above, reword docstring.

the-maldridge · 2023-02-08T04:09:16Z

py3votecore/borda_manipulation_heurestics_methods.py

+    candidate will be elected by the Borda voting rule, tie-breaks in faver of the preferred_candidate. The algorithm outputs true if it succeeds 
+    to find such manipulation, and false otherwise.
+
+    Programmer: Leora Schmerler


Move to CONTRIBUTORS in root.

the-maldridge · 2023-02-08T04:10:31Z

py3votecore/borda_manipulation_heurestics_methods.py

+
+def AverageFit(ballots: list, preferred_candidate: str, k: int)->list or bool:
+    """
+    "Complexity of and Algorithms for Borda Manipulation", by Jessica Davies, George Katsirelos, Nina Narodytska and Toby Walsh(2011),


If this reference is here to explain something you're going to need more words to explain that.

the-maldridge · 2023-02-08T04:12:51Z

setup.py


 setup(name='python3-vote-core',
-      version='20170329.00',
+      version='20230116.00',


This should be removed, as your PR is not what will trigger a release build.

the-maldridge · 2023-02-08T04:14:02Z

test_functionality/test_schulze_method.py

@@ -169,7 +169,10 @@ def test_tuple_ballots(self):
        output_list = SchulzeMethod(input_list, ballot_notation=SchulzeMethod.BALLOT_NOTATION_GROUPING).as_dict()

        # Run tests


This appears to be unrelated to the rest of your PR, and should be part of a separate patch.

leorasc added 23 commits December 7, 2022 01:30

Borda rule and manipulatopn heuristics algorithms-

22b0496

not completley implemented yet.

undo changes

e4b0c2c

Borda rule and manipulatopn heuristics algorithms-

3f35ad5

not completley implemented yet.

modified: py3votecore/borda.py

1d13531

modified: py3votecore/borda_at_large.py

Borda voting rule implemented and Largest and Average Fit.

141b54c

modified: py3votecore/borda_manipulation_heurestics_methods.py

5796eee

modified: test_functionality/test_borda_at_large.py

modified: py3votecore/borda_manipulation_heurestics_methods.py

dd6873d

modified: py3votecore/borda.py

5185e44

modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda.py

865bc68

modified: py3votecore/borda_at_large.py modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

Fixed conditions in the algorithm

1ecea1e

The heurestics modified to return a successfull manipulation if such …

f38508e

…exist modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda.py

3cc4925

modified: py3votecore/borda_manipulation_heurestics_methods.py

modified: py3votecore/borda.py

c47cba5

modified: py3votecore/borda_manipulation_heurestics_methods.py

Merge pull request #1 from leorasc/working_branch

1377cbf

Working branch

changes of parameters in test file, and some notes edited.

50915b1

modified: py3votecore/borda_manipulation_heurestics_methods.py modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda_manipulation_heurestics_methods.py

47b8218

modified: test_functionality/test_borda_manipulation_heurestics_methods.py

modified: py3votecore/borda_manipulation_heurestics_methods.py

f55282c

modified: test_functionality/test_borda_manipulation_heurestics_methods.py

Merge pull request #2 from leorasc/working_branch

0d79235

Working branch

Added requirements and fixed a test.

433c06e

new file: requirement.txt modified: setup.py modified: test_functionality/test_schulze_method.py

Merge pull request #3 from leorasc/working_branch

f81648d

Added requirements and fixed a test.

Merge pull request #4 from leorasc/working_branch

9d1ddb1

Added description of the added Borda votting rule and version update

modified: README.rst

be0253a

erelsgl suggested changes Jan 16, 2023

View reviewed changes

leorasc added 4 commits January 17, 2023 12:21

Create requirements.txt

6faa9c1

Delete requirement.txt

e2d3e62

Class documentation and doctest added.

b67743c

modified: py3votecore/borda.py modified: py3votecore/borda_at_large.py

Merge branch 'master' of https://github.com/leorasc/python-vote-core

c157b8d

the-maldridge requested changes Feb 8, 2023

View reviewed changes

		from .borda_at_large import BordaAtLarge

		class Borda(AbstractSingleWinnerVotingSystem):

		@@ -169,7 +169,10 @@ def test_tuple_ballots(self):
		output_list = SchulzeMethod(input_list, ballot_notation=SchulzeMethod.BALLOT_NOTATION_GROUPING).as_dict()

		# Run tests

Conversation

leorasc commented Jan 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

the-maldridge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants