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.

NodeIndices

class NodeIndices

Bases: object

A custom class for the return of node indices

This class can be treated as a read-only sequence of integer node indices.

This class is a container class for the results of functions that return a list of node indices. 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)
nodes = graph.node_indices()
# Index based access
third_element = nodes[2]
# Use as iterator
nodes_iter = iter(nodes)
first_element = next(nodes_iter)
second_element = next(nodes_iter)