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

Add doctests to dijkstra-algorithm #9953

Closed
Closed
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions graphs/dijkstra_2.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
def print_dist(dist, v):
"""
Print vertex distances.

Parameters:
dist (list): A list of distances.
v (int): 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"):
Expand All @@ -9,6 +25,18 @@


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.

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 +47,24 @@


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.

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]]

Check failure on line 59 in graphs/dijkstra_2.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (E501)

graphs/dijkstra_2.py:59:89: E501 Line too long (140 > 88 characters)

Check failure on line 59 in graphs/dijkstra_2.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (E501)

graphs/dijkstra_2.py:59:89: E501 Line too long (140 > 88 characters)
>>> dijkstra(graph, 4, 0)
Vertex Distance
0 0
1 2
2 3
3 1
"""

Check failure on line 67 in graphs/dijkstra_2.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (W293)

graphs/dijkstra_2.py:67:1: W293 Blank line contains whitespace

Check failure on line 67 in graphs/dijkstra_2.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (W293)

graphs/dijkstra_2.py:67:1: W293 Blank line contains whitespace
mdist = [float("inf") for _ in range(v)]
vset = [False for _ in range(v)]
mdist[src] = 0.0
Expand Down
Loading