Warning

This documents an unmaintained version of NetworkX. Please upgrade to a maintained version and see the current NetworkX documentation.

bfs_tree

bfs_tree(G, source, reverse=False)

Return an oriented tree constructed from of a breadth-first-search starting at source.

Parameters :

G : NetworkX graph

source : node, optional

Specify starting node for breadth-first search and return edges in the component reachable from source.

reverse : bool, optional

If True traverse a directed graph in the reverse direction

Returns :

T: NetworkX DiGraph

An oriented tree

Notes

Based on http://www.ics.uci.edu/~eppstein/PADS/BFS.py by D. Eppstein, July 2004.

If a source is not specified then a source is chosen arbitrarily and repeatedly until all components in the graph are searched.

Examples

>>> G = nx.Graph()
>>> G.add_path([0,1,2])
>>> print(list(nx.bfs_edges(G,0)))
[(0, 1), (1, 2)]