Retworkx API Reference

Graph Classes

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

Algorithm Functions

Shortest Paths

retworkx.dijkstra_shortest_paths()	Find the shortest path from a node
retworkx.dijkstra_shortest_path_lengths()	Compute the lengths of the shortest paths for a graph object using Dijkstra’s algorithm.
retworkx.all_pairs_dijkstra_shortest_paths()	Find the shortest path from all nodes
retworkx.all_pairs_dijkstra_path_lengths()	Find the shortest path from a node
retworkx.distance_matrix()	Get the distance matrix for a graph
retworkx.floyd_warshall()	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.floyd_warshall_numpy()	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.astar_shortest_path()	Compute the A* shortest path for a graph
retworkx.k_shortest_path_lengths()	Compute the length of the kth shortest path
retworkx.num_shortest_paths_unweighted()	Get the number of unweighted shortest paths from a source node
retworkx.unweighted_average_shortest_path_length()	Return the average shortest path length with unweighted edges.

Centrality

retworkx.betweenness_centrality()

Returns the betweenness centrality of each node in the graph.

Traversal

retworkx.dfs_edges()	Get edge list in depth first order
retworkx.bfs_successors(graph, node, /)	Return successors in a breadth-first-search from a source node.
retworkx.topological_sort(graph, /)	Return the topological sort of node indexes from the provided graph
retworkx.lexicographical_topological_sort(…)	Get the lexicographical topological sorted nodes from the provided DAG
retworkx.descendants(graph, node, /)	Return the descendants of a node in a graph.
retworkx.ancestors(graph, node, /)	Return the ancestors of a node in a graph.
retworkx.collect_runs(graph, filter)	Collect runs that match a filter function
retworkx.collect_bicolor_runs(graph, …)	Collect runs that match a filter function given edge colors

DAG Algorithms

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

Tree

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

Isomorphism

retworkx.is_isomorphic()	Determine if 2 graphs are isomorphic
retworkx.is_subgraph_isomorphic()	Determine if 2 graphs are subgraph isomorphic
retworkx.is_isomorphic_node_match()	Determine if 2 graphs are isomorphic
retworkx.vf2_mapping()	Return an iterator over all vf2 mappings between two graphs.

Matching

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

Connectivity and Cycles

retworkx.strongly_connected_components(graph, /)	Compute the strongly connected components for a directed graph
retworkx.number_weakly_connected_components(…)	Find the number of weakly connected components in a directed graph
retworkx.weakly_connected_components(graph, /)	Find the weakly connected components in a directed graph
retworkx.is_weakly_connected(graph, /)	Check if the graph is weakly connected
retworkx.cycle_basis(graph, /[, root])	Return a list of cycles which form a basis for cycles of a given PyGraph
retworkx.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

Other Algorithm Functions

retworkx.complement()	Compute the complement of a graph.
retworkx.adjacency_matrix()	Return the adjacency matrix for a graph object
retworkx.all_simple_paths()	Return all simple paths between 2 nodes in a PyGraph object
retworkx.transitivity()	Compute the transitivity of a graph.
retworkx.core_number()	Return the core number for each node in the graph.
retworkx.graph_greedy_color(graph, /)	Color a PyGraph using a largest_first strategy greedy graph coloring.
retworkx.union()	Return a new graph by forming a union from two input graph objects
retworkx.metric_closure(graph, weight_fn, /)	Return the metric closure of a graph

Generators

retworkx.generators.cycle_graph([num_nodes, …])	Generate an undirected cycle graph
retworkx.generators.directed_cycle_graph([…])	Generate a cycle graph
retworkx.generators.path_graph([num_nodes, …])	Generate an undirected path graph
retworkx.generators.directed_path_graph([…])	Generate a directed path graph
retworkx.generators.star_graph([num_nodes, …])	Generate an undirected star graph
retworkx.generators.directed_star_graph([…])	Generate a directed star graph
retworkx.generators.mesh_graph([num_nodes, …])	Generate an undirected mesh graph where every node is connected to every other
retworkx.generators.directed_mesh_graph([…])	Generate a directed mesh graph where every node is connected to every other
retworkx.generators.grid_graph([rows, cols, …])	Generate an undirected grid graph.
retworkx.generators.directed_grid_graph([…])	Generate a directed grid graph. The edges propagate towards right and
retworkx.generators.binomial_tree_graph(order, /)	Generate an undirected binomial tree of order n recursively.
retworkx.generators.hexagonal_lattice_graph(…)	Generate an undirected hexagonal lattice graph.
retworkx.generators.directed_hexagonal_lattice_graph(…)	Generate a directed hexagonal lattice graph. The edges propagate towards
retworkx.generators.heavy_square_graph(d, /)	Generate an undirected heavy square graph.
retworkx.generators.directed_heavy_square_graph(d, /)	Generate an directed heavy square graph.
retworkx.generators.heavy_hex_graph(d, /[, …])	Generate an undirected heavy hex graph.
retworkx.generators.directed_heavy_hex_graph(d, /)	Generate a directed heavy hex graph.

Random Circuit Functions

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

Layout Functions

retworkx.random_layout()	Generate a random layout
retworkx.spring_layout()	Position nodes using Fruchterman-Reingold force-directed algorithm.
retworkx.bipartite_layout()	Generate a bipartite layout of the graph
retworkx.circular_layout()	Generate a circular layout of the graph
retworkx.shell_layout()	Generate a shell layout of the graph
retworkx.spiral_layout()	Generate a spiral layout of the graph

Converters

retworkx.networkx_converter(graph)

Convert a networkx graph object into a retworkx 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.

retworkx.digraph_is_isomorphic(first, second, /)	Determine if 2 directed graphs are isomorphic
retworkx.digraph_is_subgraph_isomorphic(…)	Determine if 2 directed graphs are subgraph - isomorphic
retworkx.digraph_vf2_mapping(first, second, /)	Return an iterator over all vf2 mappings between two PyDiGraph objects
retworkx.digraph_distance_matrix(graph, /[, …])	Get the distance matrix for a directed graph
retworkx.digraph_floyd_warshall(graph, /[, …])	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.digraph_floyd_warshall_numpy(graph, /)	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.digraph_adjacency_matrix(graph, /)	Return the adjacency matrix for a PyDiGraph object
retworkx.digraph_all_simple_paths	Return all simple paths between 2 nodes in a PyDiGraph object
retworkx.digraph_astar_shortest_path(graph, …)	Compute the A* shortest path for a PyDiGraph
retworkx.digraph_dijkstra_shortest_paths	Find the shortest path from a node
retworkx.digraph_all_pairs_dijkstra_shortest_paths(…)	Find the shortest path from all nodes in a PyDiGraph object
retworkx.digraph_dijkstra_shortest_path_lengths(…)	Compute the lengths of the shortest paths for a PyDiGraph object using Dijkstra’s algorithm
retworkx.digraph_all_pairs_dijkstra_path_lengths(…)	Calculate the the shortest length from all nodes in a PyDiGraph object
retworkx.digraph_k_shortest_path_lengths(…)	Compute the length of the kth shortest path
retworkx.digraph_dfs_edges(graph, /[, source])	Get edge list in depth first order
retworkx.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
retworkx.digraph_transitivity(graph, /)	Compute the transitivity of a directed graph.
retworkx.digraph_core_number(graph, /)	Return the core number for each node in the directed graph.
retworkx.digraph_complement(graph, /)	Compute the complement of a graph.
retworkx.digraph_union(first, second, /[, …])	Return a new PyDiGraph by forming a union from two input PyDiGraph objects
retworkx.digraph_random_layout	Generate a random layout
retworkx.digraph_bipartite_layout(graph, …)	Generate a bipartite layout of the graph
retworkx.digraph_circular_layout(graph, /[, …])	Generate a circular layout of the graph
retworkx.digraph_shell_layout(graph, /[, …])	Generate a shell layout of the graph
retworkx.digraph_spiral_layout(graph, /[, …])	Generate a spiral layout of the graph
retworkx.digraph_spring_layout(graph[, pos, …])	Position nodes using Fruchterman-Reingold force-directed algorithm.
retworkx.digraph_num_shortest_paths_unweighted(…)	Get the number of unweighted shortest paths from a source node
retworkx.digraph_betweenness_centrality(graph, /)	Compute the betweenness centrality of all nodes in a PyDiGraph.
retworkx.digraph_unweighted_average_shortest_path_length(…)	Return the average shortest path length for a PyDiGraph with unweighted edges.

API functions for PyGraph

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

retworkx.graph_is_isomorphic(first, second, /)	Determine if 2 undirected graphs are isomorphic
retworkx.graph_is_subgraph_isomorphic(first, …)	Determine if 2 undirected graphs are subgraph - isomorphic
retworkx.graph_vf2_mapping(first, second, /)	Return an iterator over all vf2 mappings between two PyGraph objects
retworkx.graph_distance_matrix(graph, /[, …])	Get the distance matrix for an undirected graph
retworkx.graph_floyd_warshall(graph, /[, …])	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.graph_floyd_warshall_numpy(graph, /)	Find all-pairs shortest path lengths using Floyd’s algorithm
retworkx.graph_adjacency_matrix(graph, /[, …])	Return the adjacency matrix for a PyGraph class
retworkx.graph_all_simple_paths	Return all simple paths between 2 nodes in a PyGraph object
retworkx.graph_astar_shortest_path(graph, …)	Compute the A* shortest path for a PyGraph
retworkx.graph_dijkstra_shortest_paths	Find the shortest path from a node
retworkx.graph_dijkstra_shortest_path_lengths(…)	Compute the lengths of the shortest paths for a PyGraph object using Dijkstra’s algorithm
retworkx.graph_all_pairs_dijkstra_shortest_paths(…)	Find the shortest path from all nodes in a PyGraph object
retworkx.graph_k_shortest_path_lengths(…)	Compute the length of the kth shortest path
retworkx.graph_all_pairs_dijkstra_path_lengths(…)	Calculate the the shortest length from all nodes in a PyGraph object
retworkx.graph_dfs_edges(graph, /[, source])	Get edge list in depth first order
retworkx.graph_transitivity(graph, /)	Compute the transitivity of an undirected graph.
retworkx.graph_core_number(graph, /)	Return the core number for each node in the graph.
retworkx.graph_complement(graph, /)	Compute the complement of a graph.
retworkx.graph_union(first, second, /[, …])	Return a new PyGraph by forming a union from two input PyGraph objects
retworkx.graph_random_layout	Generate a random layout
retworkx.graph_bipartite_layout(graph, …)	Generate a bipartite layout of the graph
retworkx.graph_circular_layout(graph, /[, …])	Generate a circular layout of the graph
retworkx.graph_shell_layout(graph, /[, …])	Generate a shell layout of the graph
retworkx.graph_spiral_layout(graph, /[, …])	Generate a spiral layout of the graph
retworkx.graph_spring_layout(graph[, pos, …])	Position nodes using Fruchterman-Reingold force-directed algorithm.
retworkx.graph_num_shortest_paths_unweighted(…)	Get the number of unweighted shortest paths from a source node
retworkx.graph_betweenness_centrality(graph, /)	Compute the betweenness centrality of all nodes in a PyGraph.
retworkx.graph_unweighted_average_shortest_path_length(…)	Return the average shortest path length for a PyGraph with unweighted edges.

Exceptions

retworkx.InvalidNode
retworkx.DAGWouldCycle
retworkx.NoEdgeBetweenNodes
retworkx.DAGHasCycle
retworkx.NoSuitableNeighbors
retworkx.NoPathFound
retworkx.NullGraph

Custom Return Types

retworkx.BFSSuccessors	A custom class for the return from retworkx.bfs_successors()
retworkx.NodeIndices	A custom class for the return of node indices
retworkx.EdgeIndices	A custom class for the return of edge indices
retworkx.EdgeList	A custom class for the return of edge lists
retworkx.WeightedEdgeList	A custom class for the return of edge lists with weights
retworkx.EdgeIndexMap	A class representing a mapping of edge indices to a tuple of node indices and weight/data payload
retworkx.PathMapping	A custom class for the return of paths to target nodes
retworkx.PathLengthMapping	A custom class for the return of path lengths to target nodes
retworkx.Pos2DMapping	A class representing a mapping of node indices to 2D positions
retworkx.AllPairsPathMapping	A custom class for the return of paths to target nodes from all nodes
retworkx.AllPairsPathLengthMapping	A custom class for the return of path lengths to target nodes from all nodes
retworkx.CentralityMapping	A custom class for the return of centralities at target nodes