Skip to content

Comments

Add A* (A-star) pathfinding algorithm with doctests and type hints#13780

Closed
umarprogrammer19 wants to merge 2 commits intoTheAlgorithms:masterfrom
umarprogrammer19:algo-umar
Closed

Add A* (A-star) pathfinding algorithm with doctests and type hints#13780
umarprogrammer19 wants to merge 2 commits intoTheAlgorithms:masterfrom
umarprogrammer19:algo-umar

Conversation

@umarprogrammer19
Copy link

A* (A-star) pathfinding algorithm with doctests and type hints

This PR adds a pure-Python implementation of the A (A-star) pathfinding algorithm that works over arbitrary graphs via a neighbors(node) callback and an admissible heuristic h(node, goal). The module includes comprehensive docstrings, type hints, and doctests showing usage on a 4-connected grid with Manhattan distance. The implementation keeps state with g (cost-so-far), a min-heap priority queue for f = g + h, and reconstructs the path via a parent map.*

File added

searches/astar.py (all lowercase, no spaces or dashes)

Complexity

  1. Time: Depends on heuristic quality and branching factor; worst-case comparable to Dijkstra’s on the explored subgraph.
  2. Space: O(V) for open/closed sets and parent/g-score maps on the explored set.

References

A* search algorithm — Wikipedia
Manhattan distance Taxicab geometry

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, I will open separate PRs for separate algorithms.
✅ All new Python files are placed inside an existing directory. (placed in searches/)
✅ 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, the description above includes the issue number(s) with a closing keyword: Fixes #ISSUE-NUMBER.

@algorithms-keeper
Copy link

Closing this pull request as invalid

@umarprogrammer19, this pull request is being closed as none of the checkboxes have been marked. It is important that you go through the checklist and mark the ones relevant to this pull request. Please read the Contributing guidelines.

If you're facing any problem on how to mark a checkbox, please read the following instructions:

  • Read a point one at a time and think if it is relevant to the pull request or not.
  • If it is, then mark it by putting a x between the square bracket like so: [x]

NOTE: Only [x] is supported so if you have put any other letter or symbol between the brackets, that will be marked as invalid. If that is the case then please open a new pull request with the appropriate changes.

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed invalid

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant