dfs_successors

dfs_successors(G, source=None, depth_limit=None, *, sort_neighbors=None)

Returns dictionary of successors in depth-first-search from source.

Parameters:

GNetworkX graph

sourcenode, optional

Specify starting node for depth-first search. Note that you will get successors for all nodes in the component containing source. This input only specifies where the DFS starts.

depth_limitint, optional (default=len(G))

Specify the maximum search depth.

sort_neighborsfunction (default=None)

A function that takes an iterator over nodes as the input, and returns an iterable of the same nodes with a custom ordering. For example, sorted will sort the nodes in increasing order.

Returns:

succ: dict

A dictionary with nodes as keys and list of successor nodes as values.

See also

dfs_preorder_nodes

dfs_postorder_nodes

dfs_labeled_edges

edge_dfs()

bfs_tree()

Notes

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

The implementation of this function is adapted from David Eppstein’s depth-first search function in PADS, with modifications to allow depth limits based on the Wikipedia article “Depth-limited search”.

Examples

>>> G = nx.path_graph(5)
>>> nx.dfs_successors(G, source=0)
{0: [1], 1: [2], 2: [3], 3: [4]}
>>> nx.dfs_successors(G, source=0, depth_limit=2)
{0: [1], 1: [2]}