Gale Shapley Algorithm

[akashvshroff]

Implementation of a Nobel prize-winning algorithm that determines a stable matching in a bipartite graph.

Describe your change:

• Add an algorithm?
• Fix a bug or typo in an existing algorithm?
• Documentation change?

Checklist:

• I have read CONTRIBUTING.md.
• This pull request is all my own work -- I have not plagiarized.
• I know that pull requests will not be merged if they fail the automated tests.
• This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
• All new Python files are placed inside an existing directory.
• All filenames are in all lowercase characters with no spaces or dashes.
• All functions and variable names follow Python naming conventions.
• All function parameters and return values are annotated with Python type hints.
• All functions have doctests that pass the automated testing.
• All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
• If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

[TravisBuddy]

Hey @akashvshroff,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 163ef130-aca0-11ea-8245-836d9da6cb4c

[l3str4nge]

Please flake8 --ignore=E203,W503 --max-complexity=25 --max-line-length=120 --statistics --count . on your local machine and fix errors.

[TravisBuddy]

Hey @akashvshroff,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 3875c110-b633-11ea-aaf6-456b40a357ff

[akashvshroff]

Please flake8 --ignore=E203,W503 --max-complexity=25 --max-line-length=120 --statistics --count . on your local machine and fix errors.

I think it should be alright now? Thanks.

[TravisBuddy]

Hey @akashvshroff,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: bf289ae0-b636-11ea-aaf6-456b40a357ff

[asukaminato0721]

I read the log, it said W291 trailing whitespace which means there are extra white sapces. You can use the format function in your editor to fix it.

[akashvshroff]

I read the log, it said W291 trailing whitespace which means there are extra white spaces. You can use the format function in your editor to fix it.

When I do it, it says 0 and indicates there are no errors - did you try it on the code as part of my latest commit? Thanks.

[cclauss]

psf/black and other formatters might be reluctant to modify text that is inside a triple quoted string but flake8 will still flag that those lines as having trailing whitespace. If that is the case then manual edits may be required.

[cclauss]

I know this is a bit of a chore but... I do not think that we should base an algorithm on the premise that Marriages are heterosexual as it will not be viewed as politically correct in some circles. Could we please shift to organ donors and recipients instead. I hope that you understand why this would be helpful for us building a diversified community of contributors. Thanks.

[akashvshroff]

I know this is a bit of a chore but... I do not think that we should base an algorithm on the premise that Marriages are heterosexual as it will not be viewed as politically correct in some circles. Could we please shift to organ donors and recipients instead. I hope that you understand why this would be helpful for us building a diversified community of contributors. Thanks.

I've made the necessary changes and manually ensured that there is no trailing whitespace in the program, I hope it is alright now! Thanks.

[TravisBuddy]

Hey @akashvshroff,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 73f20c50-bde3-11ea-a595-8f8781864445

[cclauss]

Just a few minor changes and then we can land this one.

[cclauss]

./graphs/gale_shapley_bigraph.py:30:89: E501 line too long (90 > 88 characters)

[TravisBuddy]

Hey @akashvshroff,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: 56e77eb0-be7e-11ea-b6c3-5fc2c9c22d2c

[akashvshroff]

I hope I've edited everything as required!

[TravisBuddy]

Travis tests have failed

Hey @akashvshroff,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

TravisBuddy Request Identifier: 2d19ac50-be80-11ea-b6c3-5fc2c9c22d2c