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.

Sign up for GitHub

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

Jump to bottom

ref: refactor KnightTour implementation #11356

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

ref: refactor KnightTour implementation #11356

wants to merge 3 commits into from

Conversation

TruongNhanNguyen
Copy link

Describe your change:

In this refactored version:

  • I've organized the code into a KnightTour class to encapsulate related functions.
  • Each method now belongs to the KnightTour class and operates on the class attributes.
  • I've renamed some variables and methods for clarity.
  • Magic numbers have been replaced with named constants.
  • Error handling has been improved to raise more informative errors.
  • The solve_knight_tour function now directly modifies the board rather than returning it, enhancing readability.
  • I've added a check to ensure the board size is at least 1.
  • The doctests remain intact and are still executed when running the script.
  • Refactor 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@TruongNhanNguyen
ref: refactor KnightTour implementation
f9070f2
@TruongNhanNguyen
ref: update KnightTour implementation
b728110 
- The `MOVES` list is declared as a class attribute since it does not change and is shared among all instances.
- The `board_size` is passed to the constructor, and `board` is initialized as an instance attribute.
- The `get_valid_moves` method now uses instance variables instead of relying on class variables.
- `solve_knight_tour` and `find_knight_tour` methods now directly access `self.board_size` and `self.board`.
@TruongNhanNguyen
Copy link
Author

Please have a look at this PR, @imSanko, @cclauss, @MaximSmolskiy

imSanko
imSanko approved these changes Apr 10, 2024
View reviewed changes
Copy link
Contributor

@imSanko imSanko left a comment

Choose a reason for hiding this comment

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

seems good.

@TruongNhanNguyen
Copy link
Author

TruongNhanNguyen commented Apr 16, 2024 •
edited

Can you help me ask for reviews from other code maintainers @imSanko or suggest making the code better to merge?

@TruongNhanNguyen
Copy link
Author

Requesting review: @cclauss, @MaximSmolskiy, and @imSanko.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@imSanko imSanko Awaiting requested review from imSanko

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@TruongNhanNguyen @imSanko