Note

This is the documentation for the current state of the development branch of rustworkx. The documentation or APIs here can change prior to being released.

rustworkx.descendants#

descendants(graph, node, /)#

Retrieve all descendants of a specified node in a directed graph.

This function differs from the PyDiGraph.successors() method, which only returns nodes that have a direct edge leading from the specified node. In contrast, this function returns all nodes that have a path leading from the specified node, regardless of the number of edges in between.

>>> G = rx.PyDiGraph()
>>> G.add_nodes_from(range(5))
NodeIndices[0, 1, 2, 3, 4]
>>> G.add_edges_from_no_data([(0, 1), (1, 2), (2, 3), (2, 4)])
[0, 1, 2, 3]
>>> rx.descendants(G, 1)
{2, 3, 4}