Rustworkx API Reference

Graph Classes

rustworkx.PyGraph([multigraph, attrs])	A class for creating undirected graphs
rustworkx.PyDiGraph([check_cycle, ...])	A class for creating directed graphs
rustworkx.PyDAG([check_cycle, multigraph, attrs])	A class for creating direct acyclic graphs.

Algorithm Functions

Shortest Paths

rustworkx.dijkstra_shortest_paths(graph, source)	Find the shortest path from a node
rustworkx.dijkstra_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a graph object using Dijkstra's algorithm.
rustworkx.all_pairs_dijkstra_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others.
rustworkx.all_pairs_dijkstra_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others.
rustworkx.bellman_ford_shortest_paths(graph, ...)	Find the shortest path from a node
rustworkx.bellman_ford_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a graph object using the Bellman-Ford algorithm with the SPFA heuristic.
rustworkx.all_pairs_bellman_ford_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others.
rustworkx.all_pairs_bellman_ford_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others.
rustworkx.negative_edge_cycle(graph, ...)	Check if a negative cycle exists on a graph
rustworkx.find_negative_cycle(graph, ...)	Find a negative cycle of a graph
rustworkx.distance_matrix(graph[, ...])	Get the distance matrix for a graph
rustworkx.floyd_warshall(graph[, weight_fn, ...])	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.floyd_warshall_numpy(graph[, ...])	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.astar_shortest_path(graph, node, ...)	Compute the A* shortest path for a graph
rustworkx.k_shortest_path_lengths(graph, ...)	Compute the length of the kth shortest path
rustworkx.num_shortest_paths_unweighted(...)	Get the number of unweighted shortest paths from a source node
rustworkx.unweighted_average_shortest_path_length(graph)	Return the average shortest path length with unweighted edges.

Centrality

rustworkx.betweenness_centrality(graph[, ...])	Returns the betweenness centrality of each node in the graph.
rustworkx.eigenvector_centrality(graph[, ...])	Compute the eigenvector centrality of a graph.

Traversal

rustworkx.dfs_edges(graph[, source])	Get an edge list of the tree edges from a depth-first traversal
rustworkx.dfs_search(graph, source, visitor)	Depth-first traversal of a directed/undirected graph.
rustworkx.bfs_successors(graph, node, /)	Return successors in a breadth-first-search from a source node.
rustworkx.bfs_search(graph, source, visitor)	Breadth-first traversal of a directed/undirected graph.
rustworkx.dijkstra_search(graph, source, ...)	Dijkstra traversal of a graph.
rustworkx.topological_sort(graph, /)	Return the topological sort of node indices from the provided graph
rustworkx.lexicographical_topological_sort(...)	Get the lexicographical topological sorted nodes from the provided DAG
rustworkx.descendants(graph, node, /)	Return the descendants of a node in a graph.
rustworkx.ancestors(graph, node, /)	Return the ancestors of a node in a graph.
rustworkx.collect_runs(graph, filter)	Collect runs that match a filter function
rustworkx.collect_bicolor_runs(graph, ...)	Collect runs that match a filter function given edge colors
rustworkx.visit.DFSVisitor()	A visitor object that is invoked at the event-points inside the dfs_search() algorithm.
rustworkx.visit.BFSVisitor()	A visitor object that is invoked at the event-points inside the bfs_search() algorithm.
rustworkx.visit.DijkstraVisitor()	A visitor object that is invoked at the event-points inside the dijkstra_search() algorithm.
rustworkx.TopologicalSorter(graph, /[, ...])	Provides functionality to topologically sort a directed graph.

DAG Algorithms

rustworkx.dag_longest_path(graph, /[, weight_fn])	Find the longest path in a DAG
rustworkx.dag_longest_path_length(graph, /)	Find the length of the longest path in a DAG
rustworkx.dag_weighted_longest_path(graph, ...)	Find the weighted longest path in a DAG
rustworkx.dag_weighted_longest_path_length(...)	Find the length of the weighted longest path in a DAG
rustworkx.is_directed_acyclic_graph(graph, /)	Check that the PyDiGraph or PyDAG doesn't have a cycle
rustworkx.layers(dag, first_layer, /[, ...])	Return a list of layers

Tree

rustworkx.minimum_spanning_edges(graph[, ...])	Find the edges in the minimum spanning tree or forest of a graph using Kruskal's algorithm.
rustworkx.minimum_spanning_tree(graph[, ...])	Find the minimum spanning tree or forest of a graph using Kruskal's algorithm.
rustworkx.steiner_tree(graph, ...)	Return an approximation to the minimum Steiner tree of a graph.

Isomorphism

rustworkx.is_isomorphic(first, second[, ...])	Determine if 2 graphs are isomorphic
rustworkx.is_subgraph_isomorphic(first, second)	Determine if 2 graphs are subgraph isomorphic
rustworkx.is_isomorphic_node_match(first, ...)	Determine if 2 graphs are isomorphic
rustworkx.vf2_mapping(first, second[, ...])	Return an iterator over all vf2 mappings between two graphs.

Matching

rustworkx.max_weight_matching(graph, /[, ...])	Compute a maximum-weighted matching for a PyGraph
rustworkx.is_matching(graph, matching, /)	Check if matching is valid for graph
rustworkx.is_maximal_matching(graph, matching, /)	Check if a matching is a maximal (not maximum) matching for a graph

Connectivity and Cycles

rustworkx.number_connected_components(graph, /)	Find the number of connected components in an undirected graph.
rustworkx.connected_components(graph, /)	Find the connected components in an undirected graph
rustworkx.node_connected_component(graph, ...)	Returns the set of nodes in the component of graph containing node.
rustworkx.is_connected(graph, /)	Check if the graph is connected.
rustworkx.strongly_connected_components(graph, /)	Compute the strongly connected components for a directed graph
rustworkx.number_weakly_connected_components(...)	Find the number of weakly connected components in a directed graph
rustworkx.weakly_connected_components(graph, /)	Find the weakly connected components in a directed graph
rustworkx.is_weakly_connected(graph, /)	Check if the graph is weakly connected
rustworkx.cycle_basis(graph, /[, root])	Return a list of cycles which form a basis for cycles of a given PyGraph
rustworkx.simple_cycles(graph, /)	Find all simple cycles of a PyDiGraph
rustworkx.digraph_find_cycle(graph, /[, source])	Return the first cycle encountered during DFS of a given PyDiGraph, empty list is returned if no cycle is found
rustworkx.articulation_points(graph, /)	Return the articulation points of an undirected graph.
rustworkx.biconnected_components(graph, /)	Return the biconnected components of an undirected graph.
rustworkx.chain_decomposition(graph, /[, source])	Returns the chain decomposition of a graph.
rustworkx.all_simple_paths(graph, from_, to)	Return all simple paths between 2 nodes in a PyGraph object
rustworkx.all_pairs_all_simple_paths(graph)	Return all the simple paths between all pairs of nodes in the graph
rustworkx.stoer_wagner_min_cut(graph, /[, ...])	Compute a weighted minimum cut using the Stoer-Wagner algorithm.

Graph Operations

rustworkx.complement(graph)	Compute the complement of a graph.
rustworkx.union(first, second[, ...])	Return a new graph by forming a union from two input graph objects
rustworkx.cartesian_product(first, second)	Return a new graph by forming the cartesian product from two input graph objects

Other Algorithm Functions

rustworkx.adjacency_matrix(graph[, ...])	Return the adjacency matrix for a graph object
rustworkx.transitivity(graph)	Compute the transitivity of a graph.
rustworkx.core_number(graph)	Return the core number for each node in the graph.
rustworkx.graph_greedy_color(graph, /)	Color a PyGraph using a largest_first strategy greedy graph coloring.
rustworkx.metric_closure(graph, weight_fn, /)	Return the metric closure of a graph
rustworkx.is_planar(graph, /)	Check if an undirected graph is planar.

Generators

rustworkx.generators.cycle_graph([...])	Generate an undirected cycle graph
rustworkx.generators.directed_cycle_graph([...])	Generate a cycle graph
rustworkx.generators.path_graph([num_nodes, ...])	Generate an undirected path graph
rustworkx.generators.directed_path_graph([...])	Generate a directed path graph
rustworkx.generators.star_graph([num_nodes, ...])	Generate an undirected star graph
rustworkx.generators.directed_star_graph([...])	Generate a directed star graph
rustworkx.generators.mesh_graph([num_nodes, ...])	Generate an undirected mesh graph where every node is connected to every other
rustworkx.generators.directed_mesh_graph([...])	Generate a directed mesh graph where every node is connected to every other
rustworkx.generators.grid_graph([rows, ...])	Generate an undirected grid graph.
rustworkx.generators.directed_grid_graph([...])	Generate a directed grid graph. The edges propagate towards right and
rustworkx.generators.binomial_tree_graph(...)	Generate an undirected binomial tree of order n recursively.
rustworkx.generators.directed_binomial_tree_graph(...)	Generate an undirected binomial tree of order n recursively.
rustworkx.generators.hexagonal_lattice_graph(...)	Generate an undirected hexagonal lattice graph.
rustworkx.generators.directed_hexagonal_lattice_graph(...)	Generate a directed hexagonal lattice graph. The edges propagate towards
rustworkx.generators.heavy_square_graph(d, /)	Generate an undirected heavy square graph.
rustworkx.generators.directed_heavy_square_graph(d, /)	Generate an directed heavy square graph.
rustworkx.generators.heavy_hex_graph(d, /[, ...])	Generate an undirected heavy hex graph.
rustworkx.generators.directed_heavy_hex_graph(d, /)	Generate a directed heavy hex graph.
rustworkx.generators.lollipop_graph([...])	Generate an undirected lollipop graph where a mesh graph is connected to a path.
rustworkx.generators.generalized_petersen_graph(n, k, /)	Generate a generalized Petersen graph \(G(n, k)\) with \(2n\) nodes and \(3n\) edges.
rustworkx.generators.barbell_graph([...])	Generate an undirected barbell graph where two identical mesh graphs are connected by a path.
rustworkx.generators.full_rary_tree(...[, ...])	Creates a full r-ary tree of n nodes.

Random Graph Generator Functions

rustworkx.directed_gnp_random_graph(...[, seed])	Return a \(G_{np}\) directed random graph, also known as an Erdős-Rényi graph or a binomial graph.
rustworkx.undirected_gnp_random_graph(...[, ...])	Return a \(G_{np}\) random undirected graph, also known as an Erdős-Rényi graph or a binomial graph.
rustworkx.directed_gnm_random_graph(...[, seed])	Return a \(G_{nm}\) directed graph, also known as an Erdős-Rényi graph.
rustworkx.undirected_gnm_random_graph(...[, ...])	Return a \(G_{nm}\) undirected graph, also known as an Erdős-Rényi graph.
rustworkx.random_geometric_graph(num_nodes, ...)	Returns a random geometric graph in the unit cube of dimensions dim.

Layout Functions

rustworkx.random_layout(graph[, center, seed])	Generate a random layout
rustworkx.spring_layout(graph[, pos, fixed, ...])	Position nodes using Fruchterman-Reingold force-directed algorithm.
rustworkx.bipartite_layout(graph, first_nodes)	Generate a bipartite layout of the graph
rustworkx.circular_layout(graph[, scale, center])	Generate a circular layout of the graph
rustworkx.shell_layout(graph[, nlist, ...])	Generate a shell layout of the graph
rustworkx.spiral_layout(graph[, scale, ...])	Generate a spiral layout of the graph

Serialization

rustworkx.node_link_json(graph[, path, ...])	Generate a JSON object representing a graph in a node-link format
rustworkx.read_graphml(path, /)	Read a list of graphs from a file in GraphML format.

Converters

rustworkx.networkx_converter(graph[, ...])

Convert a networkx graph object into a rustworkx graph object.

API functions for PyDigraph

These functions are algorithm functions that are type specific for PyDiGraph or PyDAG objects. Universal functions from Retworkx API that work for both graph types internally call the functions from the explicitly typed based on the data type.

rustworkx.digraph_is_isomorphic(first, second, /)	Determine if 2 directed graphs are isomorphic
rustworkx.digraph_is_subgraph_isomorphic(...)	Determine if 2 directed graphs are subgraph - isomorphic
rustworkx.digraph_vf2_mapping(first, second, /)	Return an iterator over all vf2 mappings between two PyDiGraph objects
rustworkx.digraph_distance_matrix(graph, /)	Get the distance matrix for a directed graph
rustworkx.digraph_floyd_warshall(graph, /[, ...])	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.digraph_floyd_warshall_numpy(graph, /)	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.digraph_adjacency_matrix(graph, /)	Return the adjacency matrix for a PyDiGraph object
rustworkx.digraph_all_simple_paths	Return all simple paths between 2 nodes in a PyDiGraph object
rustworkx.digraph_all_pairs_all_simple_paths(...)	Return all the simple paths between all pairs of nodes in the graph
rustworkx.digraph_astar_shortest_path(graph, ...)	Compute the A* shortest path for a PyDiGraph
rustworkx.digraph_dijkstra_shortest_paths	Find the shortest path from a node
rustworkx.digraph_all_pairs_dijkstra_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others in a PyDiGraph object
rustworkx.digraph_dijkstra_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyDiGraph object using Dijkstra's algorithm
rustworkx.digraph_all_pairs_dijkstra_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others in a PyDiGraph object
rustworkx.digraph_bellman_ford_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyDiGraph object using the Bellman-Ford algorithm with the SPFA heuristic.
rustworkx.digraph_bellman_ford_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyDiGraph object using the Bellman-Ford algorithm with the SPFA heuristic.
rustworkx.digraph_all_pairs_bellman_ford_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others in a PyDiGraph object
rustworkx.digraph_all_pairs_bellman_ford_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others in a PyDiGraph object
rustworkx.digraph_k_shortest_path_lengths(...)	Compute the length of the kth shortest path
rustworkx.digraph_dfs_edges(graph, /[, source])	Get an edge list of the tree edges from a depth-first traversal
rustworkx.digraph_dfs_search(graph, source, ...)	Depth-first traversal of a directed graph.
rustworkx.digraph_find_cycle(graph, /[, source])	Return the first cycle encountered during DFS of a given PyDiGraph, empty list is returned if no cycle is found
rustworkx.digraph_transitivity(graph, /)	Compute the transitivity of a directed graph.
rustworkx.digraph_core_number(graph, /)	Return the core number for each node in the directed graph.
rustworkx.digraph_complement(graph, /)	Compute the complement of a directed graph.
rustworkx.digraph_union(first, second, /[, ...])	Return a new PyDiGraph by forming a union from two input PyDiGraph objects
rustworkx.digraph_tensor_product(first, ...)	Return a new PyDiGraph by forming the tensor product from two input PyGraph objects
rustworkx.digraph_cartesian_product(first, ...)	Return a new PyDiGraph by forming the cartesian product from two input PyDiGraph objects
rustworkx.digraph_random_layout	Generate a random layout
rustworkx.digraph_bipartite_layout(graph, ...)	Generate a bipartite layout of the graph
rustworkx.digraph_circular_layout(graph, /)	Generate a circular layout of the graph
rustworkx.digraph_shell_layout(graph, /[, ...])	Generate a shell layout of the graph
rustworkx.digraph_spiral_layout(graph, /[, ...])	Generate a spiral layout of the graph
rustworkx.digraph_spring_layout(graph[, ...])	Position nodes using Fruchterman-Reingold force-directed algorithm.
rustworkx.digraph_num_shortest_paths_unweighted(...)	Get the number of unweighted shortest paths from a source node
rustworkx.digraph_betweenness_centrality(...)	Compute the betweenness centrality of all nodes in a PyDiGraph.
rustworkx.digraph_eigenvector_centrality(...)	Compute the eigenvector centrality of a PyDiGraph.
rustworkx.digraph_unweighted_average_shortest_path_length(...)	Return the average shortest path length for a PyDiGraph with unweighted edges.
rustworkx.digraph_bfs_search(graph, source, ...)	Breadth-first traversal of a directed graph.
rustworkx.digraph_dijkstra_search(graph, ...)	Dijkstra traversal of a directed graph.
rustworkx.digraph_node_link_json(graph, /[, ...])	Generate a JSON object representing a PyDiGraph in a node-link format

API functions for PyGraph

These functions are algorithm functions that are type specific for PyGraph objects. Universal functions from Rustworkx API that work for both graph types internally call the functions from the explicitly typed API based on the data type.

rustworkx.graph_is_isomorphic(first, second, /)	Determine if 2 undirected graphs are isomorphic
rustworkx.graph_is_subgraph_isomorphic(...)	Determine if 2 undirected graphs are subgraph - isomorphic
rustworkx.graph_vf2_mapping(first, second, /)	Return an iterator over all vf2 mappings between two PyGraph objects
rustworkx.graph_distance_matrix(graph, /[, ...])	Get the distance matrix for an undirected graph
rustworkx.graph_floyd_warshall(graph, /[, ...])	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.graph_floyd_warshall_numpy(graph, /)	Find all-pairs shortest path lengths using Floyd's algorithm
rustworkx.graph_adjacency_matrix(graph, /[, ...])	Return the adjacency matrix for a PyGraph class
rustworkx.graph_all_simple_paths	Return all simple paths between 2 nodes in a PyGraph object
rustworkx.graph_all_pairs_all_simple_paths(...)	Return all the simple paths between all pairs of nodes in the graph
rustworkx.graph_astar_shortest_path(graph, ...)	Compute the A* shortest path for a PyGraph
rustworkx.graph_dijkstra_shortest_paths	Find the shortest path from a node
rustworkx.graph_dijkstra_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyGraph object using Dijkstra's algorithm
rustworkx.graph_all_pairs_dijkstra_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others in a PyGraph object
rustworkx.graph_k_shortest_path_lengths(...)	Compute the length of the kth shortest path
rustworkx.graph_all_pairs_dijkstra_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others in a PyGraph object
rustworkx.graph_bellman_ford_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyGraph object using the Bellman-Ford algorithm with the SPFA heuristic.
rustworkx.graph_bellman_ford_shortest_path_lengths(...)	Compute the lengths of the shortest paths for a PyGraph object using the Bellman-Ford algorithm with the SPFA heuristic.
rustworkx.graph_all_pairs_bellman_ford_shortest_paths(...)	For each node in the graph, finds the shortest paths to all others in a PyGraph object
rustworkx.graph_all_pairs_bellman_ford_path_lengths(...)	For each node in the graph, calculates the lengths of the shortest paths to all others in a PyGraph object
rustworkx.graph_dfs_edges(graph, /[, source])	Get an edge list of the tree edges from a depth-first traversal
rustworkx.graph_dfs_search(graph, source, ...)	Depth-first traversal of an undirected graph.
rustworkx.graph_transitivity(graph, /)	Compute the transitivity of an undirected graph.
rustworkx.graph_core_number(graph, /)	Return the core number for each node in the graph.
rustworkx.graph_complement(graph, /)	Compute the complement of an undirected graph.
rustworkx.graph_union(first, second, /[, ...])	Return a new PyGraph by forming a union from two input PyGraph objects
rustworkx.graph_tensor_product(first, second, /)	Return a new PyGraph by forming the tensor product from two input PyGraph objects
rustworkx.graph_cartesian_product(first, ...)	Return a new PyGraph by forming the cartesian product from two input PyGraph objects
rustworkx.graph_random_layout	Generate a random layout
rustworkx.graph_bipartite_layout(graph, ...)	Generate a bipartite layout of the graph
rustworkx.graph_circular_layout(graph, /[, ...])	Generate a circular layout of the graph
rustworkx.graph_shell_layout(graph, /[, ...])	Generate a shell layout of the graph
rustworkx.graph_spiral_layout(graph, /[, ...])	Generate a spiral layout of the graph
rustworkx.graph_spring_layout(graph[, pos, ...])	Position nodes using Fruchterman-Reingold force-directed algorithm.
rustworkx.graph_num_shortest_paths_unweighted(...)	Get the number of unweighted shortest paths from a source node
rustworkx.graph_betweenness_centrality(graph, /)	Compute the betweenness centrality of all nodes in a PyGraph.
rustworkx.graph_eigenvector_centrality(graph, /)	Compute the eigenvector centrality of a PyGraph.
rustworkx.graph_unweighted_average_shortest_path_length(...)	Return the average shortest path length for a PyGraph with unweighted edges.
rustworkx.graph_bfs_search(graph, source, ...)	Breadth-first traversal of an undirected graph.
rustworkx.graph_dijkstra_search(graph, ...)	Dijkstra traversal of an undirected graph.
rustworkx.graph_node_link_json(graph, /[, ...])	Generate a JSON object representing a PyGraph in a node-link format

Exceptions

rustworkx.InvalidNode
rustworkx.DAGWouldCycle
rustworkx.NoEdgeBetweenNodes
rustworkx.DAGHasCycle
rustworkx.NegativeCycle
rustworkx.NoSuitableNeighbors
rustworkx.NoPathFound
rustworkx.NullGraph
rustworkx.visit.StopSearch	Stop graph traversal
rustworkx.visit.PruneSearch	Prune part of the search tree while traversing a graph.
rustworkx.JSONSerializationError

Custom Return Types

rustworkx.BFSSuccessors	A custom class for the return from rustworkx.bfs_successors()
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.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.