Function retworkx::graph_distance_matrix[][src]

pub fn graph_distance_matrix(
    py: Python<'_>,
    graph: &PyGraph,
    parallel_threshold: usize
) -> PyResult<PyObject>

Get the distance matrix for an undirected graph

This differs from functions like digraph_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 paralllel_threshold (it defaults to 300). If the function will be running in parallel the env var RAYON_NUM_THREADS can be used to adjust how many threads will be used.

:param PyGraph graph: The graph to get the distance matrix for :param int parallel_threshold: The number of nodes to calculate the the distance matrix in parallel at. It defaults to 300, but this can be tuned

:returns: The distance matrix :rtype: numpy.ndarray