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.

EdgeList

class EdgeList

Bases: object

A custom class for the return of edge lists

The class is a read-only sequence of tuples representing edge endpoints in the form:

[(node_index_a, node_index_b)]

where node_index_a and node_index_b are the integer node indices of the edge endpoints.

This class is a container class for the results of functions that return a list of edges. It implements the Python sequence protocol. So you can treat the return as a read-only sequence/list that is integer indexed. If you want to use it as an iterator you can by wrapping it in an iter() that will yield the results in order.

For example:

import rustworkx as rx

graph = rx.generators.directed_path_graph(5)
edges = graph.edge_list()
# Index based access
third_element = edges[2]
# Use as iterator
edges_iter = iter(edges)
first_element = next(edges_iter)
second_element = next(edges_iter)