lemon-0.x: comparison lemon/dfs.h

equal deleted inserted replaced

-:364b7160f164
+:983d9b232f44
 ///Adds a new source node.
 ///Adds a new source node to the set of nodes to be processed.
 ///
-///\bug dist's are wrong (or at least strange) in case of multiple sources.
+///\bug dists are wrong (or at least strange) in case of multiple sources.
 void addSource(Node s)
 {
 if(!(*_reached)[s])
 	{
 	  _reached->set(s,true);
 ///Processes the next node.
 ///Processes the next node.
 ///
-///\warning The stack must not be empty!
+///\pre The stack must not be empty!
 void processNextEdge()
 {
 Node m;
 Edge e=_stack[_stack_head];
 if(!(*_reached)[m=G->target(e)]) {
 ///This method runs the %DFS algorithm from the root node(s)
 ///in order to
 ///compute the
 ///%DFS path to each node. The algorithm computes
 ///- The %DFS tree.
-///- The distance of each node from the root(s).
+///- The distance of each node from the root(s) in the %DFS tree.
 ///
 void start()
 {
 while ( !emptyQueue() ) processNextEdge();
 }
 ///This method runs the %DFS algorithm from the root node(s)
 ///in order to
 ///compute the
 ///%DFS path to \c dest. The algorithm computes
 ///- The %DFS path to \c  dest.
-///- The distance of \c dest from the root(s).
+///- The distance of \c dest from the root(s) in the %DFS tree.
 ///
 void start(Node dest)
 {
 while ( !emptyQueue() && G->target(_stack[_stack_head])!=dest )
 	processNextEdge();
 ///\pre init() must be called and at least one node should be added
 ///with addSource() before using this function.
 ///
 ///\param nm must be a bool (or convertible) edge map. The algorithm
 ///will stop when it reaches an edge \c e with <tt>nm[e]==true</tt>.
+///
 ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c nm is an edge map,
 ///not a node map.
 template<class NM>
 void start(const NM &nm)
 {
 ///This method runs the %DFS algorithm from a root node \c s
 ///in order to
 ///compute the
 ///%DFS path to each node. The algorithm computes
 ///- The %DFS tree.
-///- The distance of each node from the root.
+///- The distance of each node from the root in the %DFS tree.
 ///
 ///\note d.run(s) is just a shortcut of the following code.
 ///\code
 ///  d.init();
 ///  d.addSource(s);
 ///@{
 ///Copies the path to \c t on the DFS tree into \c p
-///This function copies the path on the DFS tree to \c t into \c p.
+///This function copies the path to \c t on the DFS tree  into \c p.
 ///If \c t is a source itself or unreachable, then it does not
 ///alter \c p.
 ///\todo Is this the right way to handle unreachable nodes?
 ///
 ///\return Returns \c true if a path to \c t was actually copied to \c p,
 //       _predNode(0),
 _dist(0), _source(s) {}
 };
-/// A class to make the usage of Dfs algorithm easier
+/// A class to make the usage of the Dfs algorithm easier
-/// This class is created to make it easier to use Dfs algorithm.
+/// This class is created to make it easier to use the Dfs algorithm.
 /// It uses the functions and features of the plain \ref Dfs,
 /// but it is much simpler to use it.
 ///
 /// Simplicity means that the way to change the types defined
 /// in the traits class is based on functions that returns the new class
 ///edges of the %DFS paths.
 typedef typename TR::PredMap PredMap;
 //     ///\brief The type of the map that stores the last but one
 //     ///nodes of the %DFS paths.
 //     typedef typename TR::PredNodeMap PredNodeMap;
-///The type of the map that stores the dists of the nodes.
+///The type of the map that stores the distances of the nodes.
 typedef typename TR::DistMap DistMap;
 public:
 /// Constructor.
 DfsWizard() : TR() {}

changeset 1477	0d32f7947a00
parent 1438	826bdac3525a
child 1516	4aeda8d11d5e