API reference

Games

Objects for handling game instances.

StableMarriage	Solver for the stable marriage problem (SM).
HospitalResident	Solver for the hospital-resident assignment problem (HR).
StudentAllocation	Solver for the student-allocation problem (SA).
StableRoommates	Solver for the stable roommates problem (SR).

Players

Classes to represent the players who act in games.

Player	Generic single-match player class for instances of SM or SR.
Hospital	Hospital player class for instances of HR.
Project	Project player class for instances of SA.
Supervisor	Supervisor player class for instances of SA.

Algorithms

Modules for the algorithms that solve matching games.

stable_marriage	Functions for the SM algorithms.
hospital_resident	Functions for the HR algorithms.
student_allocation	Functions for the SA algorithm.
stable_roommates	Functions for the SR algorithm.

Matchings

Dictionary-like objects for storing matchings.

SingleMatching	Matching class for games with singular matches like SM or SR.
MultipleMatching	Matching class for games with multiple matches like HR or SA.

Auxiliary pieces

Everything else exposed in the public API.

exceptions	Exceptions for game solver checks.
base	Abstract base classes for inheritance.