Skip to content

fix: make documentation and tests descriptive and concise #9289

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

Closed
wants to merge 2 commits into from
Closed

fix: make documentation and tests descriptive and concise #9289

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
428de35
fix: make documentation and tests descriptive and concise
AdePhil Oct 1, 2023
92e640b
update docs
AdePhil Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 31 additions & 22 deletions backtracking/rat_in_maze.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,27 @@
def solve_maze(maze: list[list[int]]) -> bool:
"""
This method solves the "rat in maze" problem.
In this problem we have some n by n matrix, a start point and an end point.
We want to go from the start to the end. In this matrix zeroes represent walls
and ones paths we can use.
In this problem, we have an n by n binary matrix where each
cell in the matrix contains a value 0 or 1.
In this matrix, 1 represent a valid path that can be
followed to reach the end of the matrix,
while 0 is a dead end. The rat is allowed to move in 4 directions:
Copy link

Choose a reason for hiding this comment

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

I prefer wall/obstacle to "dead end".
According to the Cambridge Dictionary, a "dead end" is:
« a road that is closed at one end, and does not lead anywhere: »
A "dead end" is already a road and doesn't as such depict very well what I see from the input.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dlesnoff Thanks for the review. I have made the update you suggested here.

UP, DOWN, LEFT, RIGHT.
Given a starting point (0, 0) and an ending point (n-1, n-1),
return True if it's possible for the rat to reach the ending point
from the starting point.
Parameters :
maze(2D matrix) : maze
Returns:
Return: True if the maze has a solution or False if it does not.
>>> maze = [[0, 1, 0, 1, 1],
... [0, 0, 0, 0, 0],
... [1, 0, 1, 0, 1],
... [0, 0, 1, 0, 0],
... [1, 0, 0, 1, 0]]
It also prints out the valid path from start to end with 1s
representing the valid path
if there’s a solution or “No solution exists!” if it does not.
>>> maze = [[1, 0, 1, 0, 0],
... [1, 1, 1, 1, 1],
... [0, 1, 0, 1, 0],
... [1, 1, 0, 1, 1],
... [0, 1, 1, 0, 1]]
>>> solve_maze(maze)
[1, 0, 0, 0, 0]
[1, 1, 1, 1, 0]
Expand All @@ -24,11 +33,11 @@ def solve_maze(maze: list[list[int]]) -> bool:
[0, 0, 0, 0, 1]
True

>>> maze = [[0, 1, 0, 1, 1],
... [0, 0, 0, 0, 0],
... [0, 0, 0, 0, 1],
... [0, 0, 0, 0, 0],
... [0, 0, 0, 0, 0]]
>>> maze = [[1, 0, 1, 0, 0],
... [1, 1, 1, 1, 1],
... [1, 1, 1, 1, 0],
... [1, 1, 1, 1, 1],
... [1, 1, 1, 1, 1]]
>>> solve_maze(maze)
[1, 0, 0, 0, 0]
[1, 0, 0, 0, 0]
Expand All @@ -37,24 +46,24 @@ def solve_maze(maze: list[list[int]]) -> bool:
[1, 1, 1, 1, 1]
True

>>> maze = [[0, 0, 0],
... [0, 1, 0],
... [1, 0, 0]]
>>> maze = [[1, 1, 1],
... [1, 0, 1],
... [0, 1, 1]]
>>> solve_maze(maze)
[1, 1, 1]
[0, 0, 1]
[0, 0, 1]
True

>>> maze = [[0, 1, 0],
... [0, 1, 0],
... [1, 0, 0]]
>>> maze = [[1, 0, 1],
... [1, 0, 1],
... [0, 1, 1]]
>>> solve_maze(maze)
No solution exists!
False

>>> maze = [[0, 1],
... [1, 0]]
>>> maze = [[1, 0],
... [0, 1]]
>>> solve_maze(maze)
No solution exists!
False
Expand Down Expand Up @@ -93,7 +102,7 @@ def run_maze(maze: list[list[int]], i: int, j: int, solutions: list[list[int]])

if lower_flag and upper_flag:
# check for already visited and block points.
block_flag = (not solutions[i][j]) and (not maze[i][j])
block_flag = (not solutions[i][j]) and maze[i][j] == 1
if block_flag:
# check visited
solutions[i][j] = 1
Expand Down