Skip to content

Commit e20b503

Browse files
Improve comments, add doctests for kahns_algorithm_topo.py (#11668)
* Improve comments, add doctests for kahns_algorithm_topo.py * Improve function docstring * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Rename variables, remove print --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 40f65e8 commit e20b503

File tree

1 file changed

+46
-21
lines changed

1 file changed

+46
-21
lines changed

graphs/kahns_algorithm_topo.py

+46-21
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,61 @@
1-
def topological_sort(graph):
1+
def topological_sort(graph: dict[int, list[int]]) -> list[int] | None:
22
"""
3-
Kahn's Algorithm is used to find Topological ordering of Directed Acyclic Graph
4-
using BFS
3+
Perform topological sorting of a Directed Acyclic Graph (DAG)
4+
using Kahn's Algorithm via Breadth-First Search (BFS).
5+
6+
Topological sorting is a linear ordering of vertices in a graph such that for
7+
every directed edge u → v, vertex u comes before vertex v in the ordering.
8+
9+
Parameters:
10+
graph: Adjacency list representing the directed graph where keys are
11+
vertices, and values are lists of adjacent vertices.
12+
13+
Returns:
14+
The topologically sorted order of vertices if the graph is a DAG.
15+
Returns None if the graph contains a cycle.
16+
17+
Example:
18+
>>> graph = {0: [1, 2], 1: [3], 2: [3], 3: [4, 5], 4: [], 5: []}
19+
>>> topological_sort(graph)
20+
[0, 1, 2, 3, 4, 5]
21+
22+
>>> graph_with_cycle = {0: [1], 1: [2], 2: [0]}
23+
>>> topological_sort(graph_with_cycle)
524
"""
25+
626
indegree = [0] * len(graph)
727
queue = []
8-
topo = []
9-
cnt = 0
28+
topo_order = []
29+
processed_vertices_count = 0
1030

31+
# Calculate the indegree of each vertex
1132
for values in graph.values():
1233
for i in values:
1334
indegree[i] += 1
1435

36+
# Add all vertices with 0 indegree to the queue
1537
for i in range(len(indegree)):
1638
if indegree[i] == 0:
1739
queue.append(i)
1840

41+
# Perform BFS
1942
while queue:
2043
vertex = queue.pop(0)
21-
cnt += 1
22-
topo.append(vertex)
23-
for x in graph[vertex]:
24-
indegree[x] -= 1
25-
if indegree[x] == 0:
26-
queue.append(x)
27-
28-
if cnt != len(graph):
29-
print("Cycle exists")
30-
else:
31-
print(topo)
32-
33-
34-
# Adjacency List of Graph
35-
graph = {0: [1, 2], 1: [3], 2: [3], 3: [4, 5], 4: [], 5: []}
36-
topological_sort(graph)
44+
processed_vertices_count += 1
45+
topo_order.append(vertex)
46+
47+
# Traverse neighbors
48+
for neighbor in graph[vertex]:
49+
indegree[neighbor] -= 1
50+
if indegree[neighbor] == 0:
51+
queue.append(neighbor)
52+
53+
if processed_vertices_count != len(graph):
54+
return None # no topological ordering exists due to cycle
55+
return topo_order # valid topological ordering
56+
57+
58+
if __name__ == "__main__":
59+
import doctest
60+
61+
doctest.testmod()

0 commit comments

Comments
 (0)