Note

This documents the development version of NetworkX. Documentation for the current release can be found here.

networkx.algorithms.shortest_paths.astar.astar_path_length

astar_path_length(G, source, target, heuristic=None, weight='weight')[source]

Returns the length of the shortest path between source and target using the A* (“A-star”) algorithm.

Parameters
GNetworkX graph
sourcenode

Starting node for path

targetnode

Ending node for path

heuristicfunction

A function to evaluate the estimate of the distance from the a node to the target. The function takes two nodes arguments and must return a number.

weightstring or function

If this is a string, then edge weights will be accessed via the edge attribute with this key (that is, the weight of the edge joining u to v will be G.edges[u, v][weight]). If no such edge attribute exists, the weight of the edge is assumed to be one. If this is a function, the weight of an edge is the value returned by the function. The function must accept exactly three positional arguments: the two endpoints of an edge and the dictionary of edge attributes for that edge. The function must return a number.

Raises
——
NetworkXNoPath

If no path exists between source and target.

See also

astar_path