Matching - Catch broken non-free successor removal

What's Changed

• Fix #165 by @dfukagaw28 in https://github.com/daffidwilde/matching/pull/166
• updates link to documentation by @Nikoleta-v3 in https://github.com/daffidwilde/matching/pull/164

New Contributors

• @dfukagaw28 made their first contribution in https://github.com/daffidwilde/matching/pull/166
• @Nikoleta-v3 made their first contribution in https://github.com/daffidwilde/matching/pull/164

Full Changelog: https://github.com/daffidwilde/matching/compare/1.4.2...1.4.3

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 2 years ago

Matching - Make cleaning exhaustive

• Fix sort of murky processing when removing players
• Use a hypothesis settings profile for CI

Full Changelog: https://github.com/daffidwilde/matching/compare/1.4.1...1.4.2

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 2 years ago

Matching - New documentation and a rethought build

• Restructure the project to use pyproject.toml and tox
• Improve the documentation (reformatted doc-strings, migrating to Quarto and GitHub Pages)
• Minor fixes to ensure CI

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 2 years ago

Matching - Extended algorithms, abstract classes, and the algorithms submodule

• Add abstract classes for players, games and matchings.
• Implement extended algorithm for SR, and clean up HR/SM algorithms.
• Move all of the algorithms to their own module, matching.algorithms.
• Improvements to the test suite (using custom hypothesis strategies.)
• Minor bug fixes.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 5 years ago

Matching - Improving SR and minor fixes

• Move unmatching to second phase in SR (allows for simple games.)
• Minor docs fixes.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 5 years ago

Matching - Add initial hospital capacity check

• Add HR input check for non-positive hospital capacities.
• Remove recursive flag from isort call in CI.
• Minor clean up of README images.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 5 years ago

Matching - Minor docs fixes.

• Temporarily catch a PytestWarning from nbval in one of the tutorial notebooks.
• Add a link to the JOSS paper from the README.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde over 5 years ago

Matching - Acceptance to JOSS

Update the self-citation information in paper.bib to v1.3.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 6 years ago

Matching - End of JOSS review: player copying, game metaclass and docs fixes.

• Players are now copied via copy.deepcopy when a game is created and the copies are used, leaving any originals unchanged.
• Formalise test and Python requirements in setup.py.
• Revert flaky forgetting fix from v1.2.1 and correct the flaky tests that were causing the issue.
• Replace the Game class with BaseGame and make it a metaclass via abc.ABCMeta.
• Fix bugs in documentation stopping build.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 6 years ago

Matching - Documentation, JOSS paper and bug fixes

• Finish documentation.
• Complete paper for submission to JOSS.
• Catch flaky forgetting bug in Player.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 6 years ago

Matching - Stable roommates problem; expand tests and docs

• Implement the stable roommates problem.
• Add example tests to all games.
• Flesh out documentation.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 6 years ago

Matching - Student allocation and dictionary creation

• Implemented the student-allocation problem (#44).
• Added capability for large game creation from dictionaries (#45).

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 7 years ago

Matching - Forgetting players; citations.

• Individuals forget the names of others one at a time rather than all instances at once as previously.
• Add citation file.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde about 7 years ago

Matching - Minor maintenance updates

• Update travis.yml to stop failures. Dodgy support for Python <3.6.
• Add new badges.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde about 7 years ago

Matching - 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.Player instances 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 (or tuple) ranking their preferences of the names of the other party's members.
• With these lists of Player instances, each type of matching game now has its own solver class (e.g. the hospital-resident assignment problem uses matching.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

Scientific Software - Peer-reviewed - Python
Published by daffidwilde about 7 years ago

Matching - 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.

Scientific Software - Peer-reviewed - Python
Published by daffidwilde almost 8 years ago