{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "As currently implemented, Dijkstra's algorithm and Johnson's algorithm do not work for graphs with direction-dependent distances when directed == False. i.e., if csgraph[i,j] and csgraph[j,i] are non-equal edges, method='D' may yield an incorrect result." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If multiple valid solutions are possible, output may vary with SciPy and Python version." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "NegativeCycleError:", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "if there are negative cycles in the graph" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "dist_matrix", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The N x N matrix of distances between graph nodes. dist_matrix[i,j] gives the shortest distance from point i to point j along the graph." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "predecessors", "annotation": "ndarray, shape (n_indices, n_nodes,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Returned only if return_predecessors == True. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "indices" }, { "__type": "Text", "__tag": 4046, "value": " is None then " }, { "__type": "InlineCode", "__tag": 4051, "value": "n_indices = n_nodes" }, { "__type": "Text", "__tag": 4046, "value": " and the shape of the matrix becomes " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n_nodes, n_nodes)" }, { "__type": "Text", "__tag": 4046, "value": ". The matrix of predecessors, which can be used to reconstruct the shortest paths. Row i of the predecessor matrix contains information on the shortest paths from point i: each entry predecessors[i, j] gives the index of the previous node in the path from point i to point j. If no path exists between point i and j, then predecessors[i, j] = -9999" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Perform a shortest-path graph search on a positive directed or undirected graph." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "csgraph", "annotation": "array_like, or sparse array or matrix, 2 dimensions", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The N x N array of distances representing the input graph." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "method", "annotation": "string ['auto'|'FW'|'D'], optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Algorithm to use for shortest paths. Options are:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'auto' -- (default) select the best among 'FW', 'D', 'BF', or 'J'" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "based on the input data." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'FW' -- Floyd-Warshall algorithm." } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Computational cost is approximately " }, { "__type": "InlineCode", "__tag": 4051, "value": "O[N^3]" }, { "__type": "Text", "__tag": 4046, "value": ". The input csgraph will be converted to a dense representation." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'D' -- Dijkstra's algorithm with priority queue." } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Computational cost is approximately " }, { "__type": "InlineCode", "__tag": 4051, "value": "O[I * (E + N) * log(N)]" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "E" }, { "__type": "Text", "__tag": 4046, "value": " is the number of edges in the graph, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "I = len(indices)" }, { "__type": "Text", "__tag": 4046, "value": " if " }, { "__type": "InlineCode", "__tag": 4051, "value": "indices" }, { "__type": "Text", "__tag": 4046, "value": " is passed. Otherwise, " }, { "__type": "InlineCode", "__tag": 4051, "value": "I = N" }, { "__type": "Text", "__tag": 4046, "value": ". The input csgraph will be converted to a csr representation." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'BF' -- Bellman-Ford algorithm." } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This algorithm can be used when weights are negative. If a negative cycle is encountered, an error will be raised. Computational cost is approximately " }, { "__type": "InlineCode", "__tag": 4051, "value": "O[N(N^2 k)]" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " is the average number of connected edges per node. The input csgraph will be converted to a csr representation." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'J' -- Johnson's algorithm." } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Like the Bellman-Ford algorithm, Johnson's algorithm is designed for use when the weights are negative. It combines the Bellman-Ford algorithm with Dijkstra's algorithm for faster computation." } ] } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "directed", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True (default), then find the shortest path on a directed graph: only move from point i to point j along paths csgraph[i, j]. If False, then find the shortest path on an undirected graph: the algorithm can progress from point i to j along csgraph[i, j] or csgraph[j, i]" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "return_predecessors", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, return the size (N, N) predecessor matrix." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "unweighted", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, then find unweighted distances. That is, rather than finding the path between each point such that the sum of weights is minimized, find the path such that the number of edges is minimized." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, overwrite csgraph with the result. This applies only if method == 'FW' and csgraph is a dense, c-ordered array with dtype=float64." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "indices", "annotation": "array_like or int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If specified, only compute the paths from the points at the given indices. Incompatible with method == 'FW'." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.11.0" } ] } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": null, "item_line": null, "item_type": "cython_function_or_method", "aliases": [ "scipy.sparse.csgraph.shortest_path" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.sparse import csr_array\nfrom scipy.sparse.csgraph import shortest_path\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "graph = [\n[0, 0, 7, 0],\n[0, 0, 8, 5],\n[7, 8, 0, 0],\n[0, 5, 0, 0]\n]\ngraph = csr_array(graph)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(graph)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "sources = [0, 2]\ndist_matrix, predecessors = shortest_path(csgraph=graph, directed=False, indices=sources, return_predecessors=True)\ndist_matrix\npredecessors\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nReconstructing shortest paths from sources to all the nodes of the graph.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "shortest_paths = {}\nfor idx in range(len(sources)):\n for node in range(4):\n curr_node = node # start from the destination node\n path = []\n while curr_node != -9999: # no previous node available, exit the loop\n path = [curr_node] + path # prefix the previous node obtained from the last iteration\n curr_node = int(predecessors[idx][curr_node]) # set current node to previous node\n shortest_paths[(sources[idx], node)] = path\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nComputing the length of the shortest path from node 0 to node 3\nof the graph. It can be observed that computed length and the\n``dist_matrix`` value are exactly same.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "shortest_paths[(0, 3)]\npath03 = shortest_paths[(0, 3)]\nsum([graph[path03[0], path03[1]], graph[path03[1], path03[2]], graph[path03[2], path03[3]]])\ndist_matrix[0][3]\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nAnother example of computing shortest path length from node 2 to node 3.\nHere, ``dist_matrix[1][3]`` is used to get the length of the path returned by\n``shortest_path``. This is because node 2 is the second source, so the\nlengths of the path from it to other nodes in the graph will be at index 1\nin ``dist_matrix``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "shortest_paths[(2, 3)]\npath23 = shortest_paths[(2, 3)]\nsum([graph[path23[0], path23[1]], graph[path23[1], path23[2]]])\ndist_matrix[1][3]\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "word-ladders-example", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "word-ladders-example" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An illustratation of the " }, { "__type": "InlineCode", "__tag": 4051, "value": "shortest_path" }, { "__type": "Text", "__tag": 4046, "value": " API with a meaninful example. It also reconstructs the shortest path by using predecessors matrix returned by this function." } ] } ], "type": "ref" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "csgraph", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "method", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "auto" }, { "__type": "SigParam", "__tag": 4030, "name": "directed", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "return_predecessors", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "unweighted", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "overwrite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "indices", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "shortest_path" }, "references": null, "qa": "scipy.sparse.csgraph._shortest_path:shortest_path", "arbitrary": [], "local_refs": [ "csgraph", "directed", "dist_matrix", "indices", "method", "overwrite", "predecessors", "return_predecessors", "unweighted" ] }