The documentation for retworkx has migrated to:
These docs will no longer be updated.
- distance_matrix(graph, parallel_threshold=300)[source]¶
- distance_matrix(graph: retworkx.PyDiGraph, parallel_threshold=300, as_undirected=False)
- distance_matrix(graph: retworkx.PyGraph, parallel_threshold=300)
Get the distance matrix for a graph
This differs from functions like
floyd_warshall_numpy()in that the edge weight/data payload is not used and each edge is treated as a distance of 1.
This function is also multithreaded and will run in parallel if the number of nodes in the graph is above the value of
parallel_threshold(it defaults to 300). If the function will be running in parallel the env var
RAYON_NUM_THREADScan be used to adjust how many threads will be used.
graph – The graph to get the distance matrix for, can be either a
parallel_threshold (int) – The number of nodes to calculate the the distance matrix in parallel at. It defaults to 300, but this can be tuned
as_undirected (bool) – If set to
Truethe input directed graph will be treat as if each edge was bidirectional/undirected in the output distance matrix.
The distance matrix
- Return type