julien-boudry/condorcet

Complete election manager, providing natively many methods of Condorcet : Condorcet basic / Copeland / Dodgson / Kemeny–Young / Minimax / Ranked Pairs / Schulze

Sunday, July 22, 2018
by julien-boudry
Repository
7 Watchers
37 Stars
2,112 Installations

PHP
0 Dependents
1 Suggesters
5 Forks
0 Open issues
100 Versions
6 % Grown

The README.md

, _(*1)

, _(*2)

, _(*3)

, _(*4)

Main Author: Julien Boudry
License: MIT - Please say hello if you like or use this code!
Contribute: Contribution File
Donation: ₿ bc1q3jllk3qd9fjvvuqy07tawkv7t6h7qjf55fc2gh or GitHub Sponsor Page
You can also offer me a bottle of good wine., _(*5)

Condorcet PHP

Presentation | Documentation Book | API Reference | Voting Methods | Tests, _(*6)

Condorcet is a powerful engine for managing electoral processes and calculating election results. It handles all aspects from configuration and vote collection to result calculation. The library natively implements over 20 voting methods compatible with preferential voting ballots, including Condorcet methods, Alternative Voting, STV, and many others. => See all supported voting methods, _(*7)

Two ways to use Condorcet: * Command Line Application: For quick access to essential features without technical expertise. Easily compute election results and statistics. * PHP Library: Integrate into your code to access all advanced features (custom manipulations, extensions, performance optimizations, advanced I/O methods, etc.)., _(*8)

Both approaches can handle massive numbers of votes (hundreds of millions) on modest hardware., _(*9)

Summary

Condorcet PHP

Project State and Specifications

Release Notes, _(*10)

Version	PHP Requirements	State	Support
5.0	8.4	Stable	✔ support provided
4.7	8.3	Old Stable	✔ support provided
4.6	8.2	Old Stable	❌ not any support
3.x	8.1	Old Stable	❌ not any support
2.2	7.4	Old Stable	❌ support requiring some incentive
2.0	7.1	Old Stable	❌ not any support
1.0	5.6	Old Stable	❌ not any support
0.9x	5.5	Old Stable	❌ ℹ Since v0.90, you should consider then it's a new project (api, engine).
0.14	5.5	Old Stable	❌ ready for the museum

All versions require Json and Mbstring extensions (or polyfill). Pdo-Sqlite is recommended for elections with hundreds of thousands of votes or more., _(*11)

Supported Voting Methods

Condorcet supports both "single-winner" methods (with full ranking extrapolation) and proportional representation systems., _(*12)

Full details on voting methods, options, and implementation choices, _(*13)

Single-Winner Methods provided natively

Single-winner methods return a complete ranking of all candidates., _(*14)

Deterministic

Condorcet / Borda (+ Nauru variant) / Copeland / Dodgson (2 Approximations) / FPTP / Instant-runoff (alternative vote) / Kemeny–Young / Minimax (+ variants) / Ranked Pairs (+ variants) / Schulze (+ variants), _(*15)

Lotteries

Random Ballot / Random Candidates, _(*16)

Proportional Methods provided natively

Methods designed for electing multiple candidates to an assembly., _(*17)

Single Transferable Vote (STV) / Comparison of Pairs of Outcomes by the Single Transferable Vote (CPO-STV) / Highest Averages Methods (Sainte-Laguë, Jefferson/D'Hondt, and variants) / Largest Remainder Methods (with different quotas), _(*18)

Add your own voting method as a module

Condorcet features a modular architecture allowing easy extension with new algorithms: - Documentation on creating voting methods - Module Skeleton Template, _(*19)

Main Features

Complete Election Management, _(*20)
- Handle the full election cycle: candidate registration, vote collection, result calculation
- Support for vote ordering, tagging, deletion, and result simulation
- Multiple input formats (string, JSON, objects)
- Import/export support for Condorcet Election Format, Debian Format, David Hill Format
- Integrity verification through checksumming
- Serialization and data export for storage
- User-friendly features (vote validation, anti-spam, human-readable results)
Comprehensive Results and Statistics, _(*21)
- Identify Condorcet Winners, Losers, and Paradoxes
- Generate complete rankings using various voting methods
- Detailed statistical analysis of results
- Support for both complete and partial ballot rankings
- Vote weighting capabilities
Advanced Capabilities, _(*22)
- Object-oriented design for flexibility and extendability
- Dynamic candidate and vote management across multiple elections (simulate election easily)
- External storage drivers for handling massive elections
- Intelligent caching system (performance optimization)
- Vote constraints
Extensibility and Configuration, _(*23)
- Extend functionality without modifying core code
- Create custom vote methods, constraints, and storage drivers
- Extensive configuration options

Although not primarily designed for maximum performance, Condorcet delivers predictable, linear scaling even with very large elections. While not formally certified, comprehensive test coverage ensures reliable results., _(*24)

Use Condorcet as a command line application

Install as a command line application

Available installation methods: - Native installation from source with Composer - Standalone PHAR executable file - Docker image (build or pull), _(*25)

Installation instructions for command line usage, _(*26)

Condorcet Book - Command Line

Use Condorcet as a PHP Library

Install / Autoloading

Uses namespace \CondorcetPHP\Condorcet, _(*27)

Installation options: - Composer (recommended) or any native PSR-4 compatible autoloader - Native autoloader (included), _(*28)

Installation instructions for PHP library usage, _(*29)

Library Manual

Complete Documentation Book, _(*30)

The documentation includes comprehensive examples illustrating the library's capabilities., _(*31)

Class & API References

API Reference, _(*32)

PHP Library - Examples

Overview Examples: * General Overview (tour of main features) * Advanced Object Management, _(*33)

HTML Output Examples: * Visual examples with HTML output, _(*34)

Specific Examples: * Documentation Book contains numerous code examples * Managing millions of votes with external database drivers, _(*35)

Performance & Coding Style Considerations

Coding Standards:

The codebase follows PSR-12 with some flexibility, enforced via CS-Fixer throughLaravel Pint., _(*36)

Performance:

Typical Use Case: Complex scenario with all voting methods, 6 candidates, 2 seats, 1,000 votes
- Memory usage: under 3MB
- Execution time (with JIT): under 160ms
- Execution time (without JIT): under 250ms

Performance varies significantly between voting methods. See method benchmarks., _(*37)

Kemeny-Young Performance: * 7 candidates: ~5MB memory, 10ms * 8 candidates: ~6MB memory, 10ms * 9 candidates: ~7MB memory, 1.1s * 10 candidates: ~7MB memory, 14s * 11 candidates: ~8MB memory, 193s, _(*38)

Large Elections: For elections with 50,000+ votes, consider external storage to avoid memory constraints. Condorcet includes a PDO driver that works with standard relational databases to handle hundreds of millions of votes. A simple SQLite implementation is provided., _(*39)

Custom storage drivers can be implemented for NoSQL or other storage systems., _(*40)

See the documentation on handling large elections, _(*41)

Benchmarks run on a modern Linux x64 system with PHP 8.1 (CLI)., _(*42)

Roadmap for Further Releases

Future developments to be announced

List of known projects, add yours!, _(*43)

The Versions

22/07 2018

dev-master

9999999-dev https://github.com/julien-boudry/Condorcet

Complete election manager, providing natively many methods of Condorcet : Condorcet basic / Copeland / Dodgson / Kemeny–Young / Minimax / Ranked Pairs / Schulze

library condorcet

Complete election manager, providing natively many methods of Condorcet : Condorcet basic / Copeland / Dodgson / Kemeny–Young / Minimax / Ranked Pairs / Schulze

julien-boudry/condorcet

The README.md

Condorcet PHP

Summary

Project State and Specifications

Supported Voting Methods

Single-Winner Methods provided natively

Deterministic

Lotteries

Proportional Methods provided natively

Add your own voting method as a module

Main Features

Use Condorcet as a command line application

Install as a command line application

Condorcet Book - Command Line

Use Condorcet as a PHP Library

Install / Autoloading

Library Manual

Class & API References

PHP Library - Examples

Performance & Coding Style Considerations

Coding Standards:

Performance:

Roadmap for Further Releases

Related projects / They use Condorcet

The Versions

dev-master

The Requires

The Development Requires

by Julien Boudry

dev-dev-1.8.x

The Requires

The Development Requires

by Julien Boudry

v1.8.0

The Requires

The Development Requires

by Julien Boudry

dev-dev-1.7.x

The Requires

The Development Requires

by Julien Boudry

dev-VERSION/1.7.x

The Requires

The Development Requires

by Julien Boudry

v1.7.0

The Requires

The Development Requires

by Julien Boudry

dev-VERSION/1.6.x

The Requires

The Development Requires

by Julien Boudry

dev-dev-1.6.x

The Requires

The Development Requires

by Julien Boudry

v1.6.0

The Requires

The Development Requires

by Julien Boudry

dev-TEST/ScrutinizerPHPAnalysisEngineV2

The Requires

The Development Requires

by Julien Boudry

dev-VERSION/1.5.x

The Requires

The Development Requires

by Julien Boudry

v1.5.0

The Requires

The Development Requires

by Julien Boudry

dev-dev-1.4.x

The Requires

The Development Requires

by Julien Boudry