Skip to content

Feature/dijkstra algorithm tests #9967

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 9 commits into from
Closed

Feature/dijkstra algorithm tests #9967

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5ab32f1
Add doctests and follow contribution guidelines
Oct 7, 2023
dcbc76d
Add doctest to dijkstra-algorithm
Oct 7, 2023
8679c63
Fix trailing whitespace
Oct 7, 2023
b511783
Add doctest to dijkstra-algorithm
Oct 7, 2023
5457d8c
Add doctest to dijkstra-algorithm
Oct 7, 2023
1fe17da
Add doctest to dijkstra-algorithm
Oct 7, 2023
566eacb
Add doctest to dijkstra-algorithm
Oct 7, 2023
82f0986
Add doctest to dijkstra-algorithm
Oct 7, 2023
45baaf7
Add doctest to dijkstra-algorithm
Oct 7, 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
59 changes: 53 additions & 6 deletions graphs/dijkstra_2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
def print_dist(dist, v):
"""
Print vertex distances.

Parameters:
dist (list): A list of distances.
v (int): The number of vertices.
Comment on lines 1 to +7
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.


Example:
>>> print_dist([0.0, 2.0, 3.0, float('inf')], 4)
Vertex Distance
0 0
1 2
2 3
3 INF
"""
print("\nVertex Distance")
for i in range(v):
if dist[i] != float("inf"):
print(i, "\t", int(dist[i]), end="\t")
print(i, int(dist[i]), end=" ")
else:
print(i, "\t", "INF", end="\t")
print(i, "INF", end=" ")
print()


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.
Comment on lines 26 to +33
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.


Example:
>>> min_dist([0.0, 2.0, 3.0, float('inf')], [False, True, False, False], 4)
0
"""
min_val = float("inf")
min_ind = -1
for i in range(v):
Expand All @@ -19,6 +46,26 @@ def min_dist(mdist, vset, v):


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.
Comment on lines 48 to +55
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.


Example:
>>> graph = [[0.0, 2.0, float('inf'), 1.0],
... [2.0, 0.0, 4.0, float('inf')],
... [float('inf'), 4.0, 0.0, 3.0],
... [1.0, float('inf'), 3.0, 0.0]]
>>> dijkstra(graph, 4, 0)
Vertex Distance
0 0
1 2
2 3
3 1
"""
mdist = [float("inf") for _ in range(v)]
vset = [False for _ in range(v)]
mdist[src] = 0.0
Expand All @@ -35,12 +82,12 @@ def dijkstra(graph, v, src):
):
mdist[i] = mdist[u] + graph[u][i]

print_dist(mdist, i)
print_dist(mdist, v)


if __name__ == "__main__":
V = int(input("Enter number of vertices: ").strip())
E = int(input("Enter number of edges: ").strip())
V = int(input("Enter the number of vertices: ").strip())
E = int(input("Enter the number of edges: ").strip())

graph = [[float("inf") for i in range(V)] for j in range(V)]

Expand All @@ -54,5 +101,5 @@ def dijkstra(graph, v, src):
weight = float(input("Enter weight:").strip())
graph[src][dst] = weight

gsrc = int(input("\nEnter shortest path source:").strip())
gsrc = int(input("\nEnter the shortest path source:").strip())
dijkstra(graph, V, gsrc)