diff --git a/doc/dijkstra_shortest_paths.html b/doc/dijkstra_shortest_paths.html index ac991c79..40f55c0d 100644 --- a/doc/dijkstra_shortest_paths.html +++ b/doc/dijkstra_shortest_paths.html @@ -248,9 +248,13 @@ IN: vertex_index_map(VertexIndexMap i_map) OUT: predecessor_map(PredecessorMap p_map)
- The predecessor map records the edges in the minimum spanning - tree. Upon completion of the algorithm, the edges (p[u],u) - for all u in V are in the minimum spanning tree. If p[u] = + The predecessor map records the edges in the shortest path tree, the tree computed + by the traversal of the graph. Upon completion of the algorithm, the edges + (p[u],u) for all u in V are in the tree. The shortest path + from vertex s to each vertex v in the graph consists of the + vertices v, p[v], p[p[v]], and so on until s is + reached, in reverse order. The + tree is not guaranteed to be a minimum spanning tree. If p[u] = u then u is either the source vertex or a vertex that is not reachable from the source. The PredecessorMap type must be a vertex_index_map(VertexIndexMap i_map) UTIL/OUT: distance_map(DistanceMap d_map)
- The shortest path weight from the source vertex s to each - vertex in the graph g is recorded in this property map. The - shortest path weight is the sum of the edge weights along the - shortest path. The type DistanceMap must be a model of - g is recorded in this property map, with edges + directed away from the spanning tree root. + The type DistanceMap must be a model of Read/Write Property Map. The vertex descriptor type of the graph needs to be usable as the key type of the distance map. The