Skip to content

Commit 0575976

Browse files
committed
Fix DFT visitor callback examineEdge documentation.
1 parent 8054f67 commit 0575976

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

docs/algorithm-dft.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,12 @@ callback | request | explanation
3232
initializeVertex | { u: string: g: DirectedGraph } | invoked on every vertex of the graph before the start of the search
3333
startVertex | { u: string: g: DirectedGraph } | invoked on the source vertex once before the start of the search
3434
discoverVertex | { u: string: g: DirectedGraph } | invoked when a vertex is encountered for the first time
35-
examineVertex | { u: string: g: DirectedGraph } | invoked on every out-edge of each vertex after it is discovered
35+
examineEdge | { e: { u: string, v: string }, g: DirectedGraph } | invoked on every out-edge of each vertex after it is discovered
3636
treeEdge | { e: { u: string, v: string }, g: DirectedGraph } | invoked on each edge as it becomes a member of the edges that form the search tree
3737
backEdge | { e: { u: string, v: string }, g: DirectedGraph } | invoked on the back edges in the graph. For an undirected graph there is some ambiguity between tree edges and back edges since the edge (u,v) and (v,u) are the same edge, but both the tree_edge() and back_edge() functions will be invoked. One way to resolve this ambiguity is to record the tree edges, and then disregard the back-edges that are already marked as tree edges. An easy way to record tree edges is to record predecessors at the tree_edge event point
3838
forwardOrCrossEdge | { e: { u: string, v: string }, g: DirectedGraph } | invoked on forward or cross edges in the graph. In an undirected graph this method is never called
39-
finishEdge | | invoked on each non-tree edge as well as on each tree edge after finish_vertex has been called on its target vertex
4039
finishVertex | { u: string: g: DirectedGraph } |invoked on vertex u after finish_vertex has been called for all the vertices in the DFS-tree rooted at vertex u. If vertex u is a leaf in the DFS-tree, then the finish_vertex function is called on u after all the out-edges of u have been examined.
41-
40+
finishEdge | { e: { u: string, v: string }, g: DirectedGraph } | invoked on each non-tree edge as well as on each tree edge after finishVertex has been called on its target vertex
4241

4342
**See also: [Boost C++ Graph Library: DFS Visitor Concept](http://www.boost.org/doc/libs/1_55_0/libs/graph/doc/DFSVisitor.html)**
4443

0 commit comments

Comments
 (0)