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

Feature/dijkstra algorithm tests #9967

Closed

Conversation

lubaso
Copy link

@lubaso lubaso commented Oct 7, 2023

Describe your change:

Fixes issue #9943

  • 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 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".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Oct 7, 2023
Comment on lines 1 to +7
def print_dist(dist, v):
"""
Print vertex distances.

Parameters:
dist (list): A list of distances.
v (int): The number of vertices.
Copy link
Member

Choose a reason for hiding this comment

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

Putting the type hints into the function signature allows mypy to check them in our tests. Please do not repeat them in the docstring below because readers will get confused if one is changed but the other is not.

Suggested change
def print_dist(dist, v):
"""
Print vertex distances.
Parameters:
dist (list): A list of distances.
v (int): The number of vertices.
def print_dist(dist: list[float], v: int):
"""
Print vertex distances.
Parameters:
dist: A list of distances.
v: The number of vertices.

Comment on lines 26 to +33
def min_dist(mdist, vset, v):
"""
Find the vertex with the minimum distance.

Parameters:
mdist (list): A list of distances.
vset (list): A list of boolean values indicating visited vertices.
v (int): The number of vertices.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
def min_dist(mdist, vset, v):
"""
Find the vertex with the minimum distance.
Parameters:
mdist (list): A list of distances.
vset (list): A list of boolean values indicating visited vertices.
v (int): The number of vertices.
def min_dist(mdist: list[float], vset: list[bool], v: int) -> int:
"""
Find the vertex with the minimum distance.
Parameters:
mdist: A list of distances.
vset: A list of boolean values indicating visited vertices.
v: The number of vertices.

Comment on lines 48 to +55
def dijkstra(graph, v, src):
"""
Implement Dijkstra's algorithm to find the shortest path.

Parameters:
graph (list): The graph represented as an adjacency matrix.
v (int): The number of vertices.
src (int): The source vertex.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
def dijkstra(graph, v, src):
"""
Implement Dijkstra's algorithm to find the shortest path.
Parameters:
graph (list): The graph represented as an adjacency matrix.
v (int): The number of vertices.
src (int): The source vertex.
def dijkstra(graph: list[list[float]], v: int, src: int) -> None:
"""
Implement Dijkstra's algorithm to find the shortest path.
Parameters:
graph: The graph is represented as an adjacency matrix.
v: The number of vertices.
src: The source vertex.

@cclauss
Copy link
Member

cclauss commented Oct 29, 2023

Thank you for your contribution to TheAlgorithms/Python but this has been a very busy HacktoberFest so we will be closing all new pull requests until the end of October so we can properly review approximately 200 open pull requests.

We hope you will try to contribute again after October 31st.

@cclauss cclauss closed this Oct 29, 2023
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 enhancement This PR modified some existing files tests are failing Do not merge until tests pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants