Releases: daffidwilde/matching
Stable roommates problem; expand tests and docs
- Implement the stable roommates problem.
- Add example tests to all games.
- Flesh out documentation.
Student allocation and dictionary creation
Forgetting players; citations.
- Individuals forget the names of others one at a time rather than all instances at once as previously.
- Add citation file.
Minor maintenance updates
- Update travis.yml to stop failures. Dodgy support for Python <3.6.
- Add new badges.
A brand new interface
Here is the first stable and "proper" release for matching. A lot has changed in the API with this release, and I am striving towards this being a library that is useful for as many people as possible -- as opposed to a collection of functions meant for me. So, please, if there is anything you want to see included or improved in the library then open a PR or raise an issue.
The main changes are as follows:
- Instead of passing dictionaries to an algorithm function, lists of
matching.Playerinstances must be created for the two matching parties - Each of these instances have a few attributes but, most importantly, they take a name (this should be unique to the party) and a
list(ortuple) ranking their preferences of the names of the other party's members. - With these lists of
Playerinstances, each type of matching game now has its own solver class (e.g. the hospital-resident assignment problem usesmatching.HospitalResident) with various methods to solve the game and then check the stability/validity of a matching.
Further details on the usage are given in the README and full documentation is yet to come.
Thank you to everyone for using this library, with particular thanks to @justinrporter for their extensive issue which prompted me to commit myself to this refactoring.
Henry
First release: stable marriage and hospital-resident assignment
My first release.
Algorithms included are for solving instances of the stable marriage and hospital-resident assignment problems derived by Gale, Shapley and Roth.