Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes in Bidirectional A* #2020

Merged
merged 13 commits into from
May 21, 2020
Merged

Fixes in Bidirectional A* #2020

merged 13 commits into from
May 21, 2020

Conversation

guilyx
Copy link
Contributor

@guilyx guilyx commented May 20, 2020

In the current state Bidirectional A* was not working due to an issue in the available vertices check. Could've been highlighted sooner but I only realized it as I added more doctests. Sorry about that.

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

@deadshotsb deadshotsb requested a review from cclauss May 21, 2020 18:28
Copy link
Member

@poyea poyea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your pull request!🤩

@cclauss cclauss merged commit 21ed896 into TheAlgorithms:master May 21, 2020
@cclauss
Copy link
Member

cclauss commented May 21, 2020

Thanks for doing this. I wrapped long lines w/ # doctest: +NORMALIZE_WHITESPACE and then needed to clean up some codespell issues in several other files. I would encourage you to put doctests at the method level instead of the class level because it takes a lot of up and down scrolling to jump from the definition of a method to actually seeing how it is called and tested.

Note that this code confuses the flake8 linter because the return statements are of some functions are indented under if statements. There is no explicit returns when the if statement fails.

As discussed in CONTRIBUTING.md, algorithm functions should not print(). They should raise exceptions or return None, etc. when bad things happen and leave it to the caller to print(), etc.

stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* implement bidirectional astar

* add type hints

* add wikipedia url

* format with black

* changes from review

* fix collision check

* Add testmod()

* # doctest: +NORMALIZE_WHITESPACE

* Codespell: euclidean

* Codespell: coordinates

* Codespell: traversal

* Codespell: remaining

Co-authored-by: John Law <johnlaw.po@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants