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.

Custom Return Types

rustworkx.BFSSuccessors	A custom class for the return from rustworkx.bfs_successors()
rustworkx.BFSPredecessors	A custom class for the return from rustworkx.bfs_predecessors()
rustworkx.NodeIndices	A custom class for the return of node indices
rustworkx.EdgeIndices	A custom class for the return of edge indices
rustworkx.EdgeList	A custom class for the return of edge lists
rustworkx.WeightedEdgeList	A custom class for the return of edge lists with weights
rustworkx.EdgeIndexMap	A class representing a mapping of edge indices to a tuple of node indices and weight/data payload
rustworkx.PathMapping	A custom class for the return of paths to target nodes
rustworkx.PathLengthMapping	A custom class for the return of path lengths to target nodes
rustworkx.Pos2DMapping	A class representing a mapping of node indices to 2D positions
rustworkx.AllPairsPathMapping	A custom class for the return of paths to target nodes from all nodes
rustworkx.AllPairsPathLengthMapping	A custom class for the return of path lengths to target nodes from all nodes
rustworkx.CentralityMapping	A custom class for the return of centralities at target nodes
rustworkx.EdgeCentralityMapping	A custom class for the return of edge centralities at target edges
rustworkx.Chains	A custom class for the return of a list of list of edges.
rustworkx.NodeMap	A class representing a mapping of node indices to node indices
rustworkx.ProductNodeMap	A class representing a mapping of tuple of node indices to node indices.
rustworkx.BiconnectedComponents	A class representing a mapping of edge endpoints to biconnected component number that the edge belongs.