mggg / mggg/VoteKit

Add "fast" winner set election functions

Open
#293 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new feature refactor upgrades
Dominant language
Python
Stars
23
Forks
33
PR merge metrics
No merged PRs in 30d

Description

In order to speed up elections for users that do not need all of the information stored in the Election class, write a set of functions that compute the winner sets of our election types (since that is what most people need, especially in parameter sweeps).

stv_winner_sets()

Then if users want the full info, they can call the STV class.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the STV class and the existing election implementations. Trace how winner sets are currently computed, then determine the expected interface for stv_winner_sets() and compare its results with the class-based implementation. Done means users can obtain the same STV winner sets without requesting the full Election information.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.