spcl / dace

DaCe - Data Centric Parallel Programming
http://dace.is/fast
BSD 3-Clause "New" or "Revised" License
496 stars 129 forks source link

Renamed `graph.bfs_edges` to `edge_bfs` #1604

Closed BenWeber42 closed 1 month ago

BenWeber42 commented 4 months ago

networkx has similar methods bfs_edges and edge_bfs for their graph classes. There is a slight and documented difference between the two: https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.traversal.edgebfs.edge_bfs.html#networkx.algorithms.traversal.edgebfs.edge_bfs

Unfortunately, our graph.bfs_edges behaves differently to networkx's bfs_edges. In fact, it behaves exactly like networkx's edge_bfs. To avoid future confusion (just happened to me), I propose renaming our bfs_edges to edge_bfs to be consistent with networkx.