LEMON/LEMON-main Changeset - r247:f1158744a112

Repositories » LEMON » LEMON-main

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r247:f1158744a112

« 244:c30731
« 246:7c6798

353:37557a »
248:8fada3 »

r247:f1158744a112

Mon, 04 Aug 2008 22:00:36

[Not Reviewed]

0 comments (0 inline)

alpar (Alpar Juttner)
alpar@cs.elte.hu

Merge

0 3 0

merge default

3 files changed with 1542 insertions and 1276 deletions:

lemon/bfs.h

571

455

lemon/dfs.h

553

476

lemon/dijkstra.h

418

345

↑ Collapse diff ↑

lemon/bfs.h

Show inline comments

@@ -23,3 +23,3 @@
 		///\file
-		///\brief Bfs algorithm.
+		///\brief BFS algorithm.
@@ -33,4 +33,2 @@
 		  ///Default traits class of Bfs class.
@@ -42,21 +40,23 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
-		    ///\brief The type of the map that stores the last
 		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<typename GR::Arc> PredMap;
-		    ///Instantiates a PredMap.
+		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \ref PredMap.
-		    ///\param G is the digraph, to which we would like to define the PredMap.
+		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient to initialize
-		    static PredMap *createPredMap(const GR &G)
+		    static PredMap *createPredMap(const Digraph &g)
+		    {
-		      return new PredMap(G);
+		      return new PredMap(g);
+		    }
 		    ///The type of the map that indicates which nodes are processed.
@@ -65,5 +65,5 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
-		    ///\todo named parameter to set this type, function to read and write.
+		    ///By default it is a NullMap.
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
@@ -73,5 +73,5 @@
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -80,2 +80,3 @@
+		    }
 		    ///The type of the map that indicates which nodes are reached.
@@ -83,28 +84,27 @@
 		    ///The type of the map that indicates which nodes are reached.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \ref ReachedMap.
 		    ///This function instantiates a \ref ReachedMap.
-		    ///\param G is the digraph, to which
+		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ReachedMap.
-		    static ReachedMap *createReachedMap(const GR &G)
+		    static ReachedMap *createReachedMap(const Digraph &g)
+		    {
-		      return new ReachedMap(G);
+		      return new ReachedMap(g);
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \ref DistMap.
 		    ///This function instantiates a \ref DistMap.
 		    ///\param G is the digraph, to which we would like to define
 		    ///the \ref DistMap
-		    static DistMap *createDistMap(const GR &G)
+		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref DistMap.
 		    static DistMap *createDistMap(const Digraph &g)
+		    {
-		      return new DistMap(G);
+		      return new DistMap(g);
+		    }
@@ -117,5 +117,9 @@
 		  ///
 		  ///\tparam GR The digraph type the algorithm runs on. The default value is
 		  ///\ref ListDigraph. The value of GR is not used directly by Bfs, it
-		  ///is only passed to \ref BfsDefaultTraits.
+		  ///There is also a \ref bfs() "function type interface" for the BFS
 		  ///algorithm, which is convenient in the simplier cases and it can be
 		  ///used easier.
 		  ///
 		  ///\tparam GR The type of the digraph the algorithm runs on.
 		  ///The default value is \ref ListDigraph. The value of GR is not used
 		  ///directly by \ref Bfs, it is only passed to \ref BfsDefaultTraits.
 		  ///\tparam TR Traits class to set various data types used by the algorithm.
@@ -125,3 +129,2 @@
 		  ///a Bfs traits class.
 		#ifdef DOXYGEN
@@ -135,8 +138,6 @@
 		  public:
 		    /**
 		     * \brief \ref Exception for uninitialized parameters.
+		     *
 		     * This error represents problems in the initialization
 		     * of the parameters of the algorithms.
 		     */
 		    ///\ref Exception for uninitialized parameters.
 		    ///This error represents problems in the initialization of the
 		    ///parameters of the algorithm.
 		    class UninitializedParameter : public lemon::UninitializedParameter {
@@ -148,15 +149,20 @@
 		    typedef TR Traits;
 		    ///The type of the underlying digraph.
 		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
 		    ///\brief The type of the map that stores the last
 		    ///arcs of the shortest paths.
 		    ///\brief The type of the map that stores the predecessor arcs of the
 		    ///shortest paths.
 		    typedef typename TR::PredMap PredMap;
-		    ///The type of the map indicating which nodes are reached.
+		    ///The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///The type of the map that indicates which nodes are reached.
 		    typedef typename TR::ReachedMap ReachedMap;
-		    ///The type of the map indicating which nodes are processed.
+		    ///The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///The type of the map that stores the dists of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///The type of the paths.
 		    typedef PredMapPath<Digraph, PredMap> Path;
 		    ///The traits class.
 		    typedef TR Traits;
 		  private:
@@ -168,19 +174,19 @@
-		    /// Pointer to the underlying digraph.
 		    //Pointer to the underlying digraph.
 		    const Digraph *G;
-		    ///Pointer to the map of predecessors arcs.
+		    //Pointer to the map of predecessor arcs.
 		    PredMap *_pred;
-		    ///Indicates if \ref _pred is locally allocated (\c true) or not.
 		    //Indicates if _pred is locally allocated (true) or not.
 		    bool local_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    DistMap *_dist;
-		    ///Indicates if \ref _dist is locally allocated (\c true) or not.
 		    //Indicates if _dist is locally allocated (true) or not.
 		    bool local_dist;
-		    ///Pointer to the map of reached status of the nodes.
 		    //Pointer to the map of reached status of the nodes.
 		    ReachedMap *_reached;
-		    ///Indicates if \ref _reached is locally allocated (\c true) or not.
 		    //Indicates if _reached is locally allocated (true) or not.
 		    bool local_reached;
-		    ///Pointer to the map of processed status of the nodes.
 		    //Pointer to the map of processed status of the nodes.
 		    ProcessedMap *_processed;
-		    ///Indicates if \ref _processed is locally allocated (\c true) or not.
 		    //Indicates if _processed is locally allocated (true) or not.
 		    bool local_processed;
@@ -192,3 +198,2 @@
 		    ///Creates the maps if necessary.
 		    ///\todo Better memory allocation (instead of new).
@@ -235,6 +240,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///PredMap type
+		    ///\ref PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting PredMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref PredMap type.
 		    template <class T>
@@ -253,6 +258,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///DistMap type
+		    ///\ref DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting DistMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref DistMap type.
 		    template <class T>
@@ -271,6 +276,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type
+		    ///\ref ReachedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ReachedMap type.
 		    template <class T>
@@ -289,6 +294,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type
+		    ///\ref ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type.
 		    template <class T>
@@ -300,12 +305,12 @@
 		      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
-		      static ProcessedMap *createProcessedMap(const Digraph &G)
+		      static ProcessedMap *createProcessedMap(const Digraph &g)
+		      {
-		        return new ProcessedMap(G);
+		        return new ProcessedMap(g);
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
@@ -323,6 +328,6 @@
 		    ///\param _G the digraph the algorithm will run on.
 		    ///
 		    Bfs(const Digraph& _G) :
 		      G(&_G),
 		    ///Constructor.
 		    ///\param g The digraph the algorithm runs on.
 		    Bfs(const Digraph &g) :
 		      G(&g),
 		      _pred(NULL), local_pred(false),
@@ -342,5 +347,5 @@
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
 		    ///If you don't use this function before calling \ref run(),
@@ -359,5 +364,5 @@
-		    ///Sets the map indicating the reached nodes.
+		    ///Sets the map that indicates which nodes are reached.
-		    ///Sets the map indicating the reached nodes.
+		    ///Sets the map that indicates which nodes are reached.
 		    ///If you don't use this function before calling \ref run(),
@@ -376,5 +381,5 @@
-		    ///Sets the map indicating the processed nodes.
+		    ///Sets the map that indicates which nodes are processed.
-		    ///Sets the map indicating the processed nodes.
+		    ///Sets the map that indicates which nodes are processed.
 		    ///If you don't use this function before calling \ref run(),
@@ -393,5 +398,6 @@
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that stores the distances of the nodes.
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that stores the distances of the nodes calculated by
 		    ///the algorithm.
 		    ///If you don't use this function before calling \ref run(),
@@ -411,11 +417,12 @@
 		  public:
 		    ///\name Execution control
 		    ///The simplest way to execute the algorithm is to use
-		    ///one of the member functions called \c run(...).
+		    ///one of the member functions called \ref lemon::Bfs::run() "run()".
 		    ///\n
 		    ///If you need more control on the execution,
 		    ///first you must call \ref init(), then you can add several source nodes
 		    ///with \ref addSource().
 		    ///Finally \ref start() will perform the actual path
-		    ///computation.
+		    ///If you need more control on the execution, first you must call
 		    ///\ref lemon::Bfs::init() "init()", then you can add several source
 		    ///nodes with \ref lemon::Bfs::addSource() "addSource()".
 		    ///Finally \ref lemon::Bfs::start() "start()" will perform the
 		    ///actual path computation.
@@ -423,4 +430,4 @@
 		    ///\brief Initializes the internal data structures.
 		    ///
 		    ///Initializes the internal data structures.
 		    ///Initializes the internal data structures.
@@ -462,3 +469,3 @@
 		    ///
-		    ///\warning The queue must not be empty!
+		    ///\pre The queue must not be empty.
 		    Node processNextNode()
@@ -484,12 +491,13 @@
-		    ///Processes the next node. And checks that the given target node
+		    ///Processes the next node and checks if the given target node
 		    ///is reached. If the target node is reachable from the processed
 		    ///node then the reached parameter will be set true. The reached
 		    ///parameter should be initially false.
 		    ///node, then the \c reach parameter will be set to \c true.
 		    ///
 		    ///\param target The target node.
-		    ///\retval reach Indicates that the target node is reached.
+		    ///\retval reach Indicates if the target node is reached.
 		    ///It should be initially \c false.
 		    ///
 		    ///\return The processed node.
 		    ///
-		    ///\warning The queue must not be empty!
+		    ///\pre The queue must not be empty.
 		    Node processNextNode(Node target, bool& reach)
@@ -516,12 +524,15 @@
 		    ///Processes the next node. And checks that at least one of
 		    ///reached node has true value in the \c nm node map. If one node
 		    ///with true value is reachable from the processed node then the
 		    ///rnode parameter will be set to the first of such nodes.
 		    ///Processes the next node and checks if at least one of reached
 		    ///nodes has \c true value in the \c nm node map. If one node
 		    ///with \c true value is reachable from the processed node, then the
 		    ///\c rnode parameter will be set to the first of such nodes.
 		    ///
-		    ///\param nm The node map of possible targets.
+		    ///\param nm A \c bool (or convertible) node map that indicates the
 		    ///possible targets.
 		    ///\retval rnode The reached target node.
 		    ///It should be initially \c INVALID.
 		    ///
 		    ///\return The processed node.
 		    ///
-		    ///\warning The queue must not be empty!
+		    ///\pre The queue must not be empty.
 		    template<class NM>
@@ -547,9 +558,7 @@
-		    ///Next node to be processed.
+		    ///The next node to be processed.
 		    ///Next node to be processed.
 		    ///
 		    ///\return The next node to be processed or INVALID if the queue is
 		    /// empty.
-		    Node nextNode()
+		    ///Returns the next node to be processed or \c INVALID if the queue
 		    ///is empty.
 		    Node nextNode() const
+		    {
@@ -559,7 +568,8 @@
 		    ///\brief Returns \c false if there are nodes
-		    ///to be processed in the queue
+		    ///to be processed.
 		    ///
 		    ///Returns \c false if there are nodes
 		    ///to be processed in the queue
 		    bool emptyQueue() { return _queue_tail==_queue_head; }
 		    ///to be processed in the queue.
 		    bool emptyQueue() const { return _queue_tail==_queue_head; }
 		    ///Returns the number of the nodes to be processed.
@@ -567,3 +577,3 @@
 		    ///Returns the number of the nodes to be processed in the queue.
 		    int queueSize() { return _queue_head-_queue_tail; }
+		    int queueSize() const { return _queue_head-_queue_tail; }
@@ -573,11 +583,18 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %BFS algorithm from the root node(s)
 		    ///in order to compute the shortest path to each node.
 		    ///
 		    ///This method runs the %BFS algorithm from the root node(s)
 		    ///in order to
 		    ///compute the
 		    ///shortest path to each node. The algorithm computes
 		    ///- The shortest path tree.
 		    ///- The distance of each node from the root(s).
 		    ///The algorithm computes
 		    ///- the shortest path tree (forest),
 		    ///- the distance of each node from the root(s).
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\note <tt>b.start()</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  while ( !b.emptyQueue() ) {
 		    ///    b.processNextNode();
 		    ///  }
 		    ///\endcode
 		    void start()
@@ -587,8 +604,5 @@
-		    ///Executes the algorithm until \c dest is reached.
+		    ///Executes the algorithm until the given target node is reached.
 		    ///Executes the algorithm until \c dest is reached.
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///Executes the algorithm until the given target node is reached.
 		    ///
@@ -596,5 +610,17 @@
 		    ///in order to compute the shortest path to \c dest.
 		    ///
 		    ///The algorithm computes
 		    ///- The shortest path to \c  dest.
 		    ///- The distance of \c dest from the root(s).
 		    ///- the shortest path to \c dest,
 		    ///- the distance of \c dest from the root(s).
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\note <tt>b.start(t)</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  bool reach = false;
 		    ///  while ( !b.emptyQueue() && !reach ) {
 		    ///    b.processNextNode(t, reach);
 		    ///  }
 		    ///\endcode
 		    void start(Node dest)
@@ -609,8 +635,8 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %BFS algorithm from the root node(s) in
 		    ///order to compute the shortest path to a node \c v with
 		    /// <tt>nm[v]</tt> true, if such a node can be found.
 		    ///
 		    ///\param nm must be a bool (or convertible) node map. The
 		    ///algorithm will stop when it reaches a node \c v with
-		    /// <tt>nm[v]</tt> true.
+		    ///\param nm A \c bool (or convertible) node map. The algorithm
 		    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
 		    ///
@@ -618,4 +644,16 @@
 		    ///\c INVALID if no such node was found.
 		    template<class NM>
 		    Node start(const NM &nm)
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\note <tt>b.start(nm)</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  Node rnode = INVALID;
 		    ///  while ( !b.emptyQueue() && rnode == INVALID ) {
 		    ///    b.processNextNode(nm, rnode);
 		    ///  }
 		    ///  return rnode;
 		    ///\endcode
 		    template<class NodeBoolMap>
 		    Node start(const NodeBoolMap &nm)
+		    {
@@ -628,12 +666,12 @@
-		    ///Runs %BFS algorithm from node \c s.
+		    ///Runs the algorithm from the given node.
 		    ///This method runs the %BFS algorithm from a root node \c s
 		    ///in order to
 		    ///compute the
 		    ///shortest path to each node. The algorithm computes
 		    ///- The shortest path tree.
 		    ///- The distance of each node from the root.
 		    ///This method runs the %BFS algorithm from node \c s
 		    ///in order to compute the shortest path to each node.
 		    ///
-		    ///\note b.run(s) is just a shortcut of the following code.
+		    ///The algorithm computes
 		    ///- the shortest path tree,
 		    ///- the distance of each node from the root.
 		    ///
 		    ///\note <tt>b.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
@@ -651,8 +689,10 @@
-		    ///Finds the shortest path between \c s and \c t.
+		    ///This method runs the %BFS algorithm from node \c s
 		    ///in order to compute the shortest path to \c t.
 		    ///
 		    ///\return The length of the shortest s---t path if there exists one,
 		    ///0 otherwise.
 		    ///\note Apart from the return value, b.run(s) is
 		    ///just a shortcut of the following code.
 		    ///\return The length of the shortest <tt>s</tt>--<tt>t</tt> path,
 		    ///if \c t is reachable form \c s, \c 0 otherwise.
 		    ///
 		    ///\note Apart from the return value, <tt>b.run(s,t)</tt> is just a
 		    ///shortcut of the following code.
 		    ///\code
@@ -669,2 +709,31 @@
 		    ///Runs the algorithm to visit all nodes in the digraph.
 		    ///This method runs the %BFS algorithm in order to
 		    ///compute the shortest path to each node.
 		    ///
 		    ///The algorithm computes
 		    ///- the shortest path tree (forest),
 		    ///- the distance of each node from the root(s).
 		    ///
 		    ///\note <tt>b.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  b.init();
 		    ///  for (NodeIt n(gr); n != INVALID; ++n) {
 		    ///    if (!b.reached(n)) {
 		    ///      b.addSource(n);
 		    ///      b.start();
 		    ///    }
 		    ///  }
 		    ///\endcode
 		    void run() {
 		      init();
 		      for (NodeIt n(*G); n != INVALID; ++n) {
 		        if (!reached(n)) {
 		          addSource(n);
 		          start();
+		        }
+		      }
+		    }
 		    ///@}
@@ -674,4 +743,4 @@
 		    ///functions.\n
 		    ///Before the use of these functions,
 		    ///either run() or start() must be calleb.
 		    ///Either \ref lemon::Bfs::run() "run()" or \ref lemon::Bfs::start()
 		    ///"start()" must be called before using them.
@@ -679,12 +748,11 @@
-		    typedef PredMapPath<Digraph, PredMap> Path;
+		    ///The shortest path to a node.
 		    ///Gives back the shortest path.
 		    ///Gives back the shortest path.
 		    ///\pre The \c t should be reachable from the source.
 		    Path path(Node t)
+		    {
 		      return Path(*G, *_pred, t);
+		    }
 		    ///Returns the shortest path to a node.
 		    ///
 		    ///\warning \c t should be reachable from the root(s).
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Path path(Node t) const { return Path(*G, *_pred, t); }
@@ -693,30 +761,34 @@
 		    ///Returns the distance of a node from the root(s).
 		    ///\pre \ref run() must be called before using this function.
 		    ///\warning If node \c v in unreachable from the root(s) the return value
-		    ///of this function is undefined.
 		    ///
 		    ///\warning If node \c v is not reachable from the root(s), then
 		    ///the return value of this function is undefined.
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    int dist(Node v) const { return (*_dist)[v]; }
 		    ///Returns the 'previous arc' of the shortest path tree.
+		    ///Returns the 'previous arc' of the shortest path tree for a node.
 		    ///For a node \c v it returns the 'previous arc'
 		    ///of the shortest path tree,
 		    ///i.e. it returns the last arc of a shortest path from the root(s) to \c
 		    ///v. It is \ref INVALID
 		    ///if \c v is unreachable from the root(s) or \c v is a root. The
 		    ///shortest path tree used here is equal to the shortest path tree used in
 		    ///\ref predNode().
 		    ///\pre Either \ref run() or \ref start() must be called before using
-		    ///this function.
+		    ///This function returns the 'previous arc' of the shortest path
 		    ///tree for the node \c v, i.e. it returns the last arc of a
 		    ///shortest path from the root(s) to \c v. It is \c INVALID if \c v
 		    ///is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The shortest path tree used here is equal to the shortest path
 		    ///tree used in \ref predNode().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Arc predArc(Node v) const { return (*_pred)[v];}
 		    ///Returns the 'previous node' of the shortest path tree.
+		    ///Returns the 'previous node' of the shortest path tree for a node.
 		    ///For a node \c v it returns the 'previous node'
 		    ///of the shortest path tree,
 		    ///i.e. it returns the last but one node from a shortest path from the
 		    ///root(a) to \c /v.
 		    ///It is INVALID if \c v is unreachable from the root(s) or
 		    ///if \c v itself a root.
 		    ///This function returns the 'previous node' of the shortest path
 		    ///tree for the node \c v, i.e. it returns the last but one node
 		    ///from a shortest path from the root(s) to \c v. It is \c INVALID
 		    ///if \c v is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The shortest path tree used here is equal to the shortest path
 		    ///tree used in \ref predArc().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
@@ -726,13 +798,18 @@
 		    ///Returns a reference to the NodeMap of distances.
 		    ///Returns a reference to the NodeMap of distances.
 		    ///\pre Either \ref run() or \ref init() must
-		    ///be called before using this function.
+		    ///\brief Returns a const reference to the node map that stores the
 		    /// distances of the nodes.
 		    ///
 		    ///Returns a const reference to the node map that stores the distances
 		    ///of the nodes calculated by the algorithm.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
 		    ///must be called before using this function.
 		    const DistMap &distMap() const { return *_dist;}
 		    ///Returns a reference to the shortest path tree map.
 		    ///Returns a reference to the NodeMap of the arcs of the
 		    ///shortest path tree.
 		    ///\brief Returns a const reference to the node map that stores the
 		    ///predecessor arcs.
 		    ///
 		    ///Returns a const reference to the node map that stores the predecessor
 		    ///arcs, which form the shortest path tree.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
@@ -741,10 +818,8 @@
 		    ///Checks if a node is reachable from the root.
+		    ///Checks if a node is reachable from the root(s).
 		    ///Returns \c true if \c v is reachable from the root.
 		    ///\warning The source nodes are indicated as unreached.
 		    ///Returns \c true if \c v is reachable from the root(s).
 		    ///\pre Either \ref run() or \ref start()
 		    ///must be called before using this function.
 		    ///
 		    bool reached(Node v) { return (*_reached)[v]; }
 		    bool reached(Node v) const { return (*_reached)[v]; }
@@ -753,5 +828,5 @@
-		  ///Default traits class of Bfs function.
+		  ///Default traits class of bfs() function.
-		  ///Default traits class of Bfs function.
+		  ///Default traits class of bfs() function.
 		  ///\tparam GR Digraph type.
@@ -760,21 +835,22 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
-		    ///\brief The type of the map that stores the last
 		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef NullMap<typename Digraph::Node,typename GR::Arc> PredMap;
-		    ///Instantiates a PredMap.
+		    typedef NullMap<typename Digraph::Node,typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \ref PredMap.
-		    ///\param g is the digraph, to which we would like to define the PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient to initialize
 		#ifdef DOXYGEN
-		    static PredMap *createPredMap(const GR &g)
+		    static PredMap *createPredMap(const Digraph &g)
 		#else
-		    static PredMap *createPredMap(const GR &)
+		    static PredMap *createPredMap(const Digraph &)
 		#endif
@@ -788,5 +864,4 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
@@ -794,7 +869,7 @@
 		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ProcessedMap
+		    ///we would like to define the \ref ProcessedMap.
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -803,2 +878,3 @@
+		    }
 		    ///The type of the map that indicates which nodes are reached.
@@ -806,17 +882,17 @@
 		    ///The type of the map that indicates which nodes are reached.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \ref ReachedMap.
 		    ///This function instantiates a \ref ReachedMap.
-		    ///\param G is the digraph, to which
+		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ReachedMap.
-		    static ReachedMap *createReachedMap(const GR &G)
+		    static ReachedMap *createReachedMap(const Digraph &g)
+		    {
-		      return new ReachedMap(G);
+		      return new ReachedMap(g);
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -824,3 +900,3 @@
 		    typedef NullMap<typename Digraph::Node,int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \ref DistMap.
@@ -830,5 +906,5 @@
 		#ifdef DOXYGEN
-		    static DistMap *createDistMap(const GR &g)
+		    static DistMap *createDistMap(const Digraph &g)
 		#else
-		    static DistMap *createDistMap(const GR &)
+		    static DistMap *createDistMap(const Digraph &)
 		#endif
@@ -839,3 +915,3 @@
 		  /// Default traits used by \ref BfsWizard
+		  /// Default traits class used by \ref BfsWizard
@@ -853,16 +929,16 @@
 		  protected:
-		    /// Type of the nodes in the digraph.
+		    //The type of the nodes in the digraph.
 		    typedef typename Base::Digraph::Node Node;
-		    /// Pointer to the underlying digraph.
+		    //Pointer to the digraph the algorithm runs on.
 		    void *_g;
-		    ///Pointer to the map of reached nodes.
 		    //Pointer to the map of reached nodes.
 		    void *_reached;
-		    ///Pointer to the map of processed nodes.
 		    //Pointer to the map of processed nodes.
 		    void *_processed;
-		    ///Pointer to the map of predecessors arcs.
 		    //Pointer to the map of predecessors arcs.
 		    void *_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    void *_dist;
-		    ///Pointer to the source node.
 		    //Pointer to the source node.
 		    Node _source;
@@ -882,4 +958,4 @@
 		    /// Others are initiated to 0.
 		    /// \param g is the initial value of  \ref _g
 		    /// \param s is the initial value of  \ref _source
 		    /// \param g The digraph the algorithm runs on.
 		    /// \param s The source node.
 		    BfsWizardBase(const GR &g, Node s=INVALID) :
@@ -890,7 +966,9 @@
-		  /// A class to make the usage of Bfs algorithm easier
+		  /// Auxiliary class for the function type interface of BFS algorithm.
 		  /// This class is created to make it easier to use Bfs algorithm.
 		  /// It uses the functions and features of the plain \ref Bfs,
-		  /// but it is much simpler to use it.
+		  /// This auxiliary class is created to implement the function type
 		  /// interface of \ref Bfs algorithm. It uses the functions and features
 		  /// of the plain \ref Bfs, but it is much simpler to use it.
 		  /// It should only be used through the \ref bfs() function, which makes
 		  /// it easier to use the algorithm.
 		  ///
@@ -903,8 +981,8 @@
 		  /// operator. In the case of \ref BfsWizard only
 		  /// a function have to be called and it will
+		  /// a function have to be called, and it will
 		  /// return the needed class.
 		  ///
 		  /// It does not have own \ref run method. When its \ref run method is called
 		  /// it initiates a plain \ref Bfs class, and calls the \ref Bfs::run
-		  /// method of it.
+		  /// It does not have own \ref run() method. When its \ref run() method
 		  /// is called, it initiates a plain \ref Bfs object, and calls the
 		  /// \ref Bfs::run() method of it.
 		  template<class TR>
@@ -914,26 +992,22 @@
-		    ///The type of the underlying digraph.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
-		    //\e
 		    typedef typename Digraph::Node Node;
 		    //\e
 		    typedef typename Digraph::NodeIt NodeIt;
 		    //\e
 		    typedef typename Digraph::Arc Arc;
 		    //\e
 		    typedef typename Digraph::OutArcIt OutArcIt;
 		    ///\brief The type of the map that stores
 		    ///the reached nodes
 		    typedef typename TR::ReachedMap ReachedMap;
 		    ///\brief The type of the map that stores
 		    ///the processed nodes
 		    typedef typename TR::ProcessedMap ProcessedMap;
-		    ///\brief The type of the map that stores the last
+		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    typedef typename TR::PredMap PredMap;
-		    ///The type of the map that stores the dists of the nodes.
+		    ///\brief The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///\brief The type of the map that indicates which nodes are reached.
 		    typedef typename TR::ReachedMap ReachedMap;
 		    ///\brief The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		  public:
 		    /// Constructor.
@@ -953,6 +1027,6 @@
-		    ///Runs Bfs algorithm from a given node.
+		    ///Runs BFS algorithm from a source node.
 		    ///Runs Bfs algorithm from a given node.
 		    ///The node can be given by the \ref source function.
 		    ///Runs BFS algorithm from a source node.
 		    ///The node can be given with the \ref source() function.
 		    void run()
@@ -972,5 +1046,5 @@
-		    ///Runs Bfs algorithm from the given node.
+		    ///Runs BFS algorithm from the given node.
-		    ///Runs Bfs algorithm from the given node.
+		    ///Runs BFS algorithm from the given node.
 		    ///\param s is the given source.
@@ -982,85 +1056,2 @@
 		    template<class T>
 		    struct DefPredMapBase : public Base {
 		      typedef T PredMap;
 		      static PredMap *createPredMap(const Digraph &) { return 0; };
 		      DefPredMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///function for setting PredMap
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting PredMap
 		    ///
 		    template<class T>
 		    BfsWizard<DefPredMapBase<T> > predMap(const T &t)
+		    {
 		      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefPredMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefReachedMapBase : public Base {
 		      typedef T ReachedMap;
 		      static ReachedMap *createReachedMap(const Digraph &) { return 0; };
 		      DefReachedMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///function for setting ReachedMap
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting ReachedMap
 		    ///
 		    template<class T>
 		    BfsWizard<DefReachedMapBase<T> > reachedMap(const T &t)
+		    {
 		      Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefReachedMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefProcessedMapBase : public Base {
 		      typedef T ProcessedMap;
 		      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
 		      DefProcessedMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///function for setting ProcessedMap
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting ProcessedMap
 		    ///
 		    template<class T>
 		    BfsWizard<DefProcessedMapBase<T> > processedMap(const T &t)
+		    {
 		      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefProcessedMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefDistMapBase : public Base {
 		      typedef T DistMap;
 		      static DistMap *createDistMap(const Digraph &) { return 0; };
 		      DefDistMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///function for setting DistMap type
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting DistMap type
 		    ///
 		    template<class T>
 		    BfsWizard<DefDistMapBase<T> > distMap(const T &t)
+		    {
 		      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefDistMapBase<T> >(*this);
+		    }
 		    /// Sets the source node, from which the Bfs algorithm runs.
@@ -1075,2 +1066,74 @@
 		    template<class T>
 		    struct DefPredMapBase : public Base {
 		      typedef T PredMap;
 		      static PredMap *createPredMap(const Digraph &) { return 0; };
 		      DefPredMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting \ref PredMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///for setting \ref PredMap object.
 		    template<class T>
 		    BfsWizard<DefPredMapBase<T> > predMap(const T &t)
+		    {
 		      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefPredMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefReachedMapBase : public Base {
 		      typedef T ReachedMap;
 		      static ReachedMap *createReachedMap(const Digraph &) { return 0; };
 		      DefReachedMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting \ref ReachedMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///for setting \ref ReachedMap object.
 		    template<class T>
 		    BfsWizard<DefReachedMapBase<T> > reachedMap(const T &t)
+		    {
 		      Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefReachedMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefProcessedMapBase : public Base {
 		      typedef T ProcessedMap;
 		      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
 		      DefProcessedMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting \ref ProcessedMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///for setting \ref ProcessedMap object.
 		    template<class T>
 		    BfsWizard<DefProcessedMapBase<T> > processedMap(const T &t)
+		    {
 		      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefProcessedMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefDistMapBase : public Base {
 		      typedef T DistMap;
 		      static DistMap *createDistMap(const Digraph &) { return 0; };
 		      DefDistMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting \ref DistMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///for setting \ref DistMap object.
 		    template<class T>
 		    BfsWizard<DefDistMapBase<T> > distMap(const T &t)
+		    {
 		      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return BfsWizard<DefDistMapBase<T> >(*this);
+		    }
 		  };
@@ -1102,6 +1165,6 @@
 		#ifdef DOXYGEN
-		  /// \brief Visitor class for bfs.
+		  /// \brief Visitor class for BFS.
 		  ///
 		  /// This class defines the interface of the BfsVisit events, and
-		  /// it could be the base of a real Visitor class.
+		  /// it could be the base of a real visitor class.
 		  template <typename _Digraph>
@@ -1111,25 +1174,25 @@
 		    typedef typename Digraph::Node Node;
-		    /// \brief Called when the arc reach a node.
+		    /// \brief Called for the source node(s) of the BFS.
 		    ///
 		    /// It is called when the bfs find an arc which target is not
 		    /// reached yet.
 		    /// This function is called for the source node(s) of the BFS.
 		    void start(const Node& node) {}
 		    /// \brief Called when a node is reached first time.
 		    ///
 		    /// This function is called when a node is reached first time.
 		    void reach(const Node& node) {}
 		    /// \brief Called when a node is processed.
 		    ///
 		    /// This function is called when a node is processed.
 		    void process(const Node& node) {}
 		    /// \brief Called when an arc reaches a new node.
 		    ///
 		    /// This function is called when the BFS finds an arc whose target node
 		    /// is not reached yet.
 		    void discover(const Arc& arc) {}
 		    /// \brief Called when the node reached first time.
 		    ///
 		    /// It is Called when the node reached first time.
 		    void reach(const Node& node) {}
-		    /// \brief Called when the arc examined but target of the arc
+		    /// \brief Called when an arc is examined but its target node is
 		    /// already discovered.
 		    ///
-		    /// It called when the arc examined but the target of the arc
+		    /// This function is called when an arc is examined but its target node is
 		    /// already discovered.
 		    void examine(const Arc& arc) {}
 		    /// \brief Called for the source node of the bfs.
 		    ///
 		    /// It is called for the source node of the bfs.
 		    void start(const Node& node) {}
 		    /// \brief Called when the node processed.
 		    ///
 		    /// It is Called when the node processed.
 		    void process(const Node& node) {}
 		  };
@@ -1141,7 +1204,7 @@
 		    typedef typename Digraph::Node Node;
 		    void start(const Node&) {}
 		    void reach(const Node&) {}
 		    void process(const Node&) {}
 		    void discover(const Arc&) {}
 		    void reach(const Node&) {}
 		    void examine(const Arc&) {}
 		    void start(const Node&) {}
 		    void process(const Node&) {}
@@ -1152,7 +1215,7 @@
 		        Node node;
 		        visitor.start(node);
 		        visitor.reach(node);
 		        visitor.process(node);
 		        visitor.discover(arc);
 		        visitor.reach(node);
 		        visitor.examine(arc);
 		        visitor.start(node);
 		        visitor.process(node);
+		      }
@@ -1166,3 +1229,3 @@
 		  /// Default traits class of BfsVisit class.
-		  /// \tparam _Digraph Digraph type.
+		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  template<class _Digraph>
@@ -1170,3 +1233,3 @@
-		    /// \brief The digraph type the algorithm runs on.
+		    /// \brief The type of the digraph the algorithm runs on.
 		    typedef _Digraph Digraph;
@@ -1176,7 +1239,6 @@
 		    /// The type of the map that indicates which nodes are reached.
 		    /// It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    /// \todo named parameter to set this type, function to read and write.
 		    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    /// \brief Instantiates a ReachedMap.
+		    /// \brief Instantiates a \ref ReachedMap.
 		    ///
@@ -1193,3 +1255,3 @@
 		  ///
-		  /// \brief %BFS Visit algorithm class.
+		  /// \brief %BFS algorithm class with visitor interface.
 		  ///
@@ -1200,12 +1262,12 @@
 		  /// class. It works with callback mechanism, the BfsVisit object calls
-		  /// on every bfs event the \c Visitor class member functions.
+		  /// the member functions of the \c Visitor class on every BFS event.
 		  ///
-		  /// \tparam _Digraph The digraph type the algorithm runs on.
+		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  /// The default value is
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by Bfs, it
 		  /// is only passed to \ref BfsDefaultTraits.
 		  /// \tparam _Visitor The Visitor object for the algorithm. The
 		  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty Visitor which
 		  /// does not observe the Bfs events. If you want to observe the bfs
 		  /// events you should implement your own Visitor class.
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by
 		  /// \ref BfsVisit, it is only passed to \ref BfsVisitDefaultTraits.
 		  /// \tparam _Visitor The Visitor type that is used by the algorithm.
 		  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty visitor, which
 		  /// does not observe the BFS events. If you want to observe the BFS
 		  /// events, you should implement your own visitor class.
 		  /// \tparam _Traits Traits class to set various data types used by the
@@ -1214,3 +1276,3 @@
 		  /// See \ref BfsVisitDefaultTraits for the documentation of
-		  /// a Bfs visit traits class.
+		  /// a BFS visit traits class.
 		#ifdef DOXYGEN
@@ -1228,3 +1290,3 @@
 		    /// This error represents problems in the initialization
-		    /// of the parameters of the algorithms.
+		    /// of the parameters of the algorithm.
 		    class UninitializedParameter : public lemon::UninitializedParameter {
@@ -1237,9 +1299,12 @@
 		    ///The traits class.
 		    typedef _Traits Traits;
 		    ///The type of the digraph the algorithm runs on.
 		    typedef typename Traits::Digraph Digraph;
 		    ///The visitor type used by the algorithm.
 		    typedef _Visitor Visitor;
-		    ///The type of the map indicating which nodes are reached.
+		    ///The type of the map that indicates which nodes are reached.
 		    typedef typename Traits::ReachedMap ReachedMap;
@@ -1253,9 +1318,9 @@
-		    /// Pointer to the underlying digraph.
 		    //Pointer to the underlying digraph.
 		    const Digraph *_digraph;
-		    /// Pointer to the visitor object.
 		    //Pointer to the visitor object.
 		    Visitor *_visitor;
-		    ///Pointer to the map of reached status of the nodes.
 		    //Pointer to the map of reached status of the nodes.
 		    ReachedMap *_reached;
-		    ///Indicates if \ref _reached is locally allocated (\c true) or not.
 		    //Indicates if _reached is locally allocated (true) or not.
 		    bool local_reached;
@@ -1265,5 +1330,4 @@
 		    /// \brief Creates the maps if necessary.
 		    ///
 		    /// Creates the maps if necessary.
 		    ///\todo Better memory allocation (instead of new).
 		    void create_maps() {
@@ -1294,5 +1358,5 @@
 		    /// \brief \ref named-templ-param "Named parameter" for setting
 		    /// ReachedMap type
+		    /// ReachedMap type.
 		    ///
 		    /// \ref named-templ-param "Named parameter" for setting ReachedMap type
+		    /// \ref named-templ-param "Named parameter" for setting ReachedMap type.
 		    template <class T>
@@ -1310,5 +1374,4 @@
 		    ///
 		    /// \param digraph the digraph the algorithm will run on.
 		    /// \param visitor The visitor of the algorithm.
 		    ///
+		    /// \param digraph The digraph the algorithm runs on.
 		    /// \param visitor The visitor object of the algorithm.
 		    BfsVisit(const Digraph& digraph, Visitor& visitor)
@@ -1318,4 +1381,2 @@
 		    /// \brief Destructor.
 		    ///
 		    /// Destructor.
 		    ~BfsVisit() {
@@ -1324,7 +1385,7 @@
-		    /// \brief Sets the map indicating if a node is reached.
+		    /// \brief Sets the map that indicates which nodes are reached.
 		    ///
-		    /// Sets the map indicating if a node is reached.
+		    /// Sets the map that indicates which nodes are reached.
 		    /// If you don't use this function before calling \ref run(),
-		    /// it will allocate one. The destuctor deallocates this
+		    /// it will allocate one. The destructor deallocates this
 		    /// automatically allocated map, of course.
@@ -1341,13 +1402,16 @@
 		  public:
 		    /// \name Execution control
 		    /// The simplest way to execute the algorithm is to use
-		    /// one of the member functions called \c run(...).
+		    /// one of the member functions called \ref lemon::BfsVisit::run()
 		    /// "run()".
 		    /// \n
 		    /// If you need more control on the execution,
 		    /// first you must call \ref init(), then you can adda source node
 		    /// with \ref addSource().
 		    /// Finally \ref start() will perform the actual path
-		    /// computation.
+		    /// If you need more control on the execution, first you must call
 		    /// \ref lemon::BfsVisit::init() "init()", then you can add several
 		    /// source nodes with \ref lemon::BfsVisit::addSource() "addSource()".
 		    /// Finally \ref lemon::BfsVisit::start() "start()" will perform the
 		    /// actual path computation.
 		    /// @{
 		    /// \brief Initializes the internal data structures.
@@ -1355,3 +1419,2 @@
 		    /// Initializes the internal data structures.
 		    ///
 		    void init() {
@@ -1383,3 +1446,3 @@
 		    ///
-		    /// \pre The queue must not be empty!
+		    /// \pre The queue must not be empty.
 		    Node processNextNode() {
@@ -1404,12 +1467,13 @@
 		    ///
-		    /// Processes the next node. And checks that the given target node
+		    /// Processes the next node and checks if the given target node
 		    /// is reached. If the target node is reachable from the processed
 		    /// node then the reached parameter will be set true. The reached
 		    /// parameter should be initially false.
 		    /// node, then the \c reach parameter will be set to \c true.
 		    ///
 		    /// \param target The target node.
-		    /// \retval reach Indicates that the target node is reached.
+		    /// \retval reach Indicates if the target node is reached.
 		    /// It should be initially \c false.
 		    ///
 		    /// \return The processed node.
 		    ///
-		    /// \warning The queue must not be empty!
+		    /// \pre The queue must not be empty.
 		    Node processNextNode(Node target, bool& reach) {
@@ -1435,12 +1499,15 @@
 		    ///
 		    /// Processes the next node. And checks that at least one of
 		    /// reached node has true value in the \c nm node map. If one node
 		    /// with true value is reachable from the processed node then the
 		    /// rnode parameter will be set to the first of such nodes.
 		    /// Processes the next node and checks if at least one of reached
 		    /// nodes has \c true value in the \c nm node map. If one node
 		    /// with \c true value is reachable from the processed node, then the
 		    /// \c rnode parameter will be set to the first of such nodes.
 		    ///
-		    /// \param nm The node map of possible targets.
+		    /// \param nm A \c bool (or convertible) node map that indicates the
 		    /// possible targets.
 		    /// \retval rnode The reached target node.
 		    /// It should be initially \c INVALID.
 		    ///
 		    /// \return The processed node.
 		    ///
-		    /// \warning The queue must not be empty!
+		    /// \pre The queue must not be empty.
 		    template <typename NM>
@@ -1465,9 +1532,7 @@
-		    /// \brief Next node to be processed.
+		    /// \brief The next node to be processed.
 		    ///
 		    /// Next node to be processed.
 		    ///
 		    /// \return The next node to be processed or INVALID if the stack is
 		    /// empty.
-		    Node nextNode() {
+		    /// Returns the next node to be processed or \c INVALID if the queue
 		    /// is empty.
 		    Node nextNode() const {
 		      return _list_front != _list_back ? _list[_list_front + 1] : INVALID;
@@ -1476,7 +1541,7 @@
 		    /// \brief Returns \c false if there are nodes
-		    /// to be processed in the queue
+		    /// to be processed.
 		    ///
 		    /// Returns \c false if there are nodes
 		    /// to be processed in the queue
 		    bool emptyQueue() { return _list_front == _list_back; }
 		    /// to be processed in the queue.
 		    bool emptyQueue() const { return _list_front == _list_back; }
@@ -1485,3 +1550,3 @@
 		    /// Returns the number of the nodes to be processed in the queue.
 		    int queueSize() { return _list_back - _list_front; }
+		    int queueSize() const { return _list_back - _list_front; }
@@ -1491,4 +1556,18 @@
 		    ///
-		    /// \pre init() must be called and at least one node should be added
+		    /// This method runs the %BFS algorithm from the root node(s)
 		    /// in order to compute the shortest path to each node.
 		    ///
 		    /// The algorithm computes
 		    /// - the shortest path tree (forest),
 		    /// - the distance of each node from the root(s).
 		    ///
 		    /// \pre init() must be called and at least one root node should be added
 		    /// with addSource() before using this function.
 		    ///
 		    /// \note <tt>b.start()</tt> is just a shortcut of the following code.
 		    /// \code
 		    ///   while ( !b.emptyQueue() ) {
 		    ///     b.processNextNode();
 		    ///   }
 		    /// \endcode
 		    void start() {
@@ -1497,8 +1576,23 @@
-		    /// \brief Executes the algorithm until \c dest is reached.
+		    /// \brief Executes the algorithm until the given target node is reached.
 		    ///
-		    /// Executes the algorithm until \c dest is reached.
+		    /// Executes the algorithm until the given target node is reached.
 		    ///
 		    /// \pre init() must be called and at least one node should be added
 		    /// with addSource() before using this function.
 		    /// This method runs the %BFS algorithm from the root node(s)
 		    /// in order to compute the shortest path to \c dest.
 		    ///
 		    /// The algorithm computes
 		    /// - the shortest path to \c dest,
 		    /// - the distance of \c dest from the root(s).
 		    ///
 		    /// \pre init() must be called and at least one root node should be
 		    /// added with addSource() before using this function.
 		    ///
 		    /// \note <tt>b.start(t)</tt> is just a shortcut of the following code.
 		    /// \code
 		    ///   bool reach = false;
 		    ///   while ( !b.emptyQueue() && !reach ) {
 		    ///     b.processNextNode(t, reach);
 		    ///   }
 		    /// \endcode
 		    void start(Node dest) {
@@ -1512,4 +1606,5 @@
 		    ///
 		    /// \pre init() must be called and at least one node should be added
 		    /// with addSource() before using this function.
 		    /// This method runs the %BFS algorithm from the root node(s) in
 		    /// order to compute the shortest path to a node \c v with
 		    /// <tt>nm[v]</tt> true, if such a node can be found.
 		    ///
@@ -1521,2 +1616,14 @@
 		    ///\c INVALID if no such node was found.
 		    ///
 		    /// \pre init() must be called and at least one root node should be
 		    /// added with addSource() before using this function.
 		    ///
 		    /// \note <tt>b.start(nm)</tt> is just a shortcut of the following code.
 		    /// \code
 		    ///   Node rnode = INVALID;
 		    ///   while ( !b.emptyQueue() && rnode == INVALID ) {
 		    ///     b.processNextNode(nm, rnode);
 		    ///   }
 		    ///   return rnode;
 		    /// \endcode
 		    template <typename NM>
@@ -1530,6 +1637,12 @@
-		    /// \brief Runs %BFSVisit algorithm from node \c s.
+		    /// \brief Runs the algorithm from the given node.
 		    ///
 		    /// This method runs the %BFS algorithm from a root node \c s.
 		    /// \note b.run(s) is just a shortcut of the following code.
 		    /// This method runs the %BFS algorithm from node \c s
 		    /// in order to compute the shortest path to each node.
 		    ///
 		    /// The algorithm computes
 		    /// - the shortest path tree,
 		    /// - the distance of each node from the root.
 		    ///
 		    /// \note <tt>b.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
@@ -1545,15 +1658,17 @@
-		    /// \brief Runs %BFSVisit algorithm to visit all nodes in the digraph.
+		    /// \brief Runs the algorithm to visit all nodes in the digraph.
 		    ///
 		    /// This method runs the %BFS algorithm in order to
 		    /// compute the %BFS path to each node. The algorithm computes
 		    /// - The %BFS tree.
-		    /// - The distance of each node from the root in the %BFS tree.
+		    /// compute the shortest path to each node.
 		    ///
-		    ///\note b.run() is just a shortcut of the following code.
+		    /// The algorithm computes
 		    /// - the shortest path tree (forest),
 		    /// - the distance of each node from the root(s).
 		    ///
 		    /// \note <tt>b.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  b.init();
 		    ///  for (NodeIt it(digraph); it != INVALID; ++it) {
 		    ///    if (!b.reached(it)) {
-		    ///      b.addSource(it);
+		    ///  for (NodeIt n(gr); n != INVALID; ++n) {
 		    ///    if (!b.reached(n)) {
 		    ///      b.addSource(n);
 		    ///      b.start();
@@ -1571,2 +1686,3 @@
+		    }
 		    ///@}
@@ -1576,15 +1692,16 @@
 		    /// functions.\n
 		    /// Before the use of these functions,
 		    /// either run() or start() must be called.
 		    /// Either \ref lemon::BfsVisit::run() "run()" or
 		    /// \ref lemon::BfsVisit::start() "start()" must be called before
 		    /// using them.
 		    ///@{
 		    /// \brief Checks if a node is reachable from the root.
+		    /// \brief Checks if a node is reachable from the root(s).
 		    ///
 		    /// Returns \c true if \c v is reachable from the root(s).
 		    /// \warning The source nodes are inditated as unreachable.
 		    /// \pre Either \ref run() or \ref start()
 		    /// must be called before using this function.
 		    ///
 		    bool reached(Node v) { return (*_reached)[v]; }
 		    ///@}
 		  };
@@ -1594,2 +1711,1 @@
 		#endif

lemon/dfs.h

Show inline comments

@@ -23,3 +23,3 @@
 		///\file
-		///\brief Dfs algorithm.
+		///\brief DFS algorithm.
@@ -29,9 +29,7 @@
 		#include <lemon/error.h>
 		#include <lemon/assert.h>
 		#include <lemon/maps.h>
 		#include <lemon/concept_check.h>
 		namespace lemon {
 		  ///Default traits class of Dfs class.
@@ -43,20 +41,21 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
-		    ///\brief The type of the map that stores the last
 		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the %DFS paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the %DFS paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<typename GR::Arc> PredMap;
-		    ///Instantiates a PredMap.
+		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \ref PredMap.
-		    ///\param G is the digraph, to which we would like to define the PredMap.
+		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient to initialize
-		    static PredMap *createPredMap(const GR &G)
+		    static PredMap *createPredMap(const Digraph &g)
+		    {
-		      return new PredMap(G);
+		      return new PredMap(g);
+		    }
@@ -67,5 +66,5 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
-		    ///\todo named parameter to set this type, function to read and write.
+		    ///By default it is a NullMap.
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
@@ -75,5 +74,5 @@
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -82,2 +81,3 @@
+		    }
 		    ///The type of the map that indicates which nodes are reached.
@@ -85,28 +85,27 @@
 		    ///The type of the map that indicates which nodes are reached.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \ref ReachedMap.
 		    ///This function instantiates a \ref ReachedMap.
-		    ///\param G is the digraph, to which
+		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ReachedMap.
-		    static ReachedMap *createReachedMap(const GR &G)
+		    static ReachedMap *createReachedMap(const Digraph &g)
+		    {
-		      return new ReachedMap(G);
+		      return new ReachedMap(g);
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \ref DistMap.
 		    ///This function instantiates a \ref DistMap.
 		    ///\param G is the digraph, to which we would like to define
 		    ///the \ref DistMap
-		    static DistMap *createDistMap(const GR &G)
+		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref DistMap.
 		    static DistMap *createDistMap(const Digraph &g)
+		    {
-		      return new DistMap(G);
+		      return new DistMap(g);
+		    }
@@ -119,5 +118,9 @@
 		  ///
 		  ///\tparam GR The digraph type the algorithm runs on. The default value is
 		  ///\ref ListDigraph. The value of GR is not used directly by Dfs, it
-		  ///is only passed to \ref DfsDefaultTraits.
+		  ///There is also a \ref dfs() "function type interface" for the DFS
 		  ///algorithm, which is convenient in the simplier cases and it can be
 		  ///used easier.
 		  ///
 		  ///\tparam GR The type of the digraph the algorithm runs on.
 		  ///The default value is \ref ListDigraph. The value of GR is not used
 		  ///directly by \ref Dfs, it is only passed to \ref DfsDefaultTraits.
 		  ///\tparam TR Traits class to set various data types used by the algorithm.
@@ -136,8 +139,6 @@
 		  public:
 		    /**
 		     * \brief \ref Exception for uninitialized parameters.
+		     *
 		     * This error represents problems in the initialization
 		     * of the parameters of the algorithms.
 		     */
 		    ///\ref Exception for uninitialized parameters.
 		    ///This error represents problems in the initialization of the
 		    ///parameters of the algorithm.
 		    class UninitializedParameter : public lemon::UninitializedParameter {
@@ -149,41 +150,44 @@
 		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
 		    ///\brief The type of the map that stores the predecessor arcs of the
 		    ///DFS paths.
 		    typedef typename TR::PredMap PredMap;
 		    ///The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///The type of the map that indicates which nodes are reached.
 		    typedef typename TR::ReachedMap ReachedMap;
 		    ///The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///The type of the paths.
 		    typedef PredMapPath<Digraph, PredMap> Path;
 		    ///The traits class.
 		    typedef TR Traits;
 		    ///The type of the underlying digraph.
 		    typedef typename TR::Digraph Digraph;
-		    ///\e
 		  private:
 		    typedef typename Digraph::Node Node;
 		    ///\e
 		    typedef typename Digraph::NodeIt NodeIt;
 		    ///\e
 		    typedef typename Digraph::Arc Arc;
 		    ///\e
 		    typedef typename Digraph::OutArcIt OutArcIt;
 		    ///\brief The type of the map that stores the last
 		    ///arcs of the %DFS paths.
 		    typedef typename TR::PredMap PredMap;
 		    ///The type of the map indicating which nodes are reached.
 		    typedef typename TR::ReachedMap ReachedMap;
 		    ///The type of the map indicating which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///The type of the map that stores the dists of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		  private:
-		    /// Pointer to the underlying digraph.
 		    //Pointer to the underlying digraph.
 		    const Digraph *G;
-		    ///Pointer to the map of predecessors arcs.
+		    //Pointer to the map of predecessor arcs.
 		    PredMap *_pred;
-		    ///Indicates if \ref _pred is locally allocated (\c true) or not.
 		    //Indicates if _pred is locally allocated (true) or not.
 		    bool local_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    DistMap *_dist;
-		    ///Indicates if \ref _dist is locally allocated (\c true) or not.
 		    //Indicates if _dist is locally allocated (true) or not.
 		    bool local_dist;
-		    ///Pointer to the map of reached status of the nodes.
 		    //Pointer to the map of reached status of the nodes.
 		    ReachedMap *_reached;
-		    ///Indicates if \ref _reached is locally allocated (\c true) or not.
 		    //Indicates if _reached is locally allocated (true) or not.
 		    bool local_reached;
-		    ///Pointer to the map of processed status of the nodes.
 		    //Pointer to the map of processed status of the nodes.
 		    ProcessedMap *_processed;
-		    ///Indicates if \ref _processed is locally allocated (\c true) or not.
 		    //Indicates if _processed is locally allocated (true) or not.
 		    bool local_processed;
@@ -194,3 +198,2 @@
 		    ///Creates the maps if necessary.
 		    ///\todo Better memory allocation (instead of new).
@@ -231,3 +234,3 @@
 		      typedef T PredMap;
-		      static PredMap *createPredMap(const Digraph &G)
 		      static PredMap *createPredMap(const Digraph &)
+		      {
@@ -237,6 +240,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///PredMap type
+		    ///\ref PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting PredMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref PredMap type.
 		    template <class T>
@@ -246,3 +249,2 @@
 		    template <class T>
@@ -256,8 +258,8 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///DistMap type
+		    ///\ref DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting DistMap
 		    ///type
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref DistMap type.
 		    template <class T>
 		    struct DefDistMap {
+		    struct DefDistMap : public Dfs< Digraph, DefDistMapTraits<T> > {
 		      typedef Dfs<Digraph, DefDistMapTraits<T> > Create;
@@ -274,6 +276,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type
+		    ///\ref ReachedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ReachedMap type.
 		    template <class T>
@@ -292,6 +294,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type
+		    ///\ref ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type.
 		    template <class T>
@@ -303,15 +305,15 @@
 		      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
-		      static ProcessedMap *createProcessedMap(const Digraph &G)
+		      static ProcessedMap *createProcessedMap(const Digraph &g)
+		      {
-		        return new ProcessedMap(G);
+		        return new ProcessedMap(g);
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
-		    ///If you don't set it explicitely, it will be automatically allocated.
+		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
 		    template <class T>
-		    class DefProcessedMapToBeDefaultMap :
+		    struct DefProcessedMapToBeDefaultMap :
 		      public Dfs< Digraph, DefDigraphProcessedMapTraits> {
@@ -326,6 +328,6 @@
 		    ///\param _G the digraph the algorithm will run on.
 		    ///
 		    Dfs(const Digraph& _G) :
 		      G(&_G),
 		    ///Constructor.
 		    ///\param g The digraph the algorithm runs on.
 		    Dfs(const Digraph &g) :
 		      G(&g),
 		      _pred(NULL), local_pred(false),
@@ -345,7 +347,7 @@
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
 		    ///If you don't use this function before calling \ref run(),
-		    ///it will allocate one. The destuctor deallocates this
+		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
@@ -362,7 +364,42 @@
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that indicates which nodes are reached.
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that indicates which nodes are reached.
 		    ///If you don't use this function before calling \ref run(),
-		    ///it will allocate one. The destuctor deallocates this
+		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
 		    ///\return <tt> (*this) </tt>
 		    Dfs &reachedMap(ReachedMap &m)
+		    {
 		      if(local_reached) {
 		        delete _reached;
 		        local_reached=false;
+		      }
 		      _reached = &m;
 		      return *this;
+		    }
 		    ///Sets the map that indicates which nodes are processed.
 		    ///Sets the map that indicates which nodes are processed.
 		    ///If you don't use this function before calling \ref run(),
 		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
 		    ///\return <tt> (*this) </tt>
 		    Dfs &processedMap(ProcessedMap &m)
+		    {
 		      if(local_processed) {
 		        delete _processed;
 		        local_processed=false;
+		      }
 		      _processed = &m;
 		      return *this;
+		    }
 		    ///Sets the map that stores the distances of the nodes.
 		    ///Sets the map that stores the distances of the nodes calculated by
 		    ///the algorithm.
 		    ///If you don't use this function before calling \ref run(),
 		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
@@ -379,46 +416,13 @@
-		    ///Sets the map indicating if a node is reached.
+		  public:
 		    ///Sets the map indicating if a node is reached.
 		    ///If you don't use this function before calling \ref run(),
 		    ///it will allocate one. The destuctor deallocates this
 		    ///automatically allocated map, of course.
 		    ///\return <tt> (*this) </tt>
 		    Dfs &reachedMap(ReachedMap &m)
+		    {
 		      if(local_reached) {
 		        delete _reached;
 		        local_reached=false;
+		      }
 		      _reached = &m;
 		      return *this;
+		    }
 		    ///Sets the map indicating if a node is processed.
 		    ///Sets the map indicating if a node is processed.
 		    ///If you don't use this function before calling \ref run(),
 		    ///it will allocate one. The destuctor deallocates this
 		    ///automatically allocated map, of course.
 		    ///\return <tt> (*this) </tt>
 		    Dfs &processedMap(ProcessedMap &m)
+		    {
 		      if(local_processed) {
 		        delete _processed;
 		        local_processed=false;
+		      }
 		      _processed = &m;
 		      return *this;
+		    }
 		  public:
 		    ///\name Execution control
 		    ///The simplest way to execute the algorithm is to use
-		    ///one of the member functions called \c run(...).
+		    ///one of the member functions called \ref lemon::Dfs::run() "run()".
 		    ///\n
 		    ///If you need more control on the execution,
 		    ///first you must call \ref init(), then you can add a source node
 		    ///with \ref addSource().
 		    ///Finally \ref start() will perform the actual path
-		    ///computation.
+		    ///If you need more control on the execution, first you must call
 		    ///\ref lemon::Dfs::init() "init()", then you can add a source node
 		    ///with \ref lemon::Dfs::addSource() "addSource()".
 		    ///Finally \ref lemon::Dfs::start() "start()" will perform the
 		    ///actual path computation.
@@ -437,3 +441,2 @@
 		        _pred->set(u,INVALID);
 		        // _predNode->set(u,INVALID);
 		        _reached->set(u,false);
@@ -447,6 +450,10 @@
 		    ///
 		    ///\warning dists are wrong (or at least strange)
 		    ///in case of multiple sources.
 		    ///\pre The stack must be empty. (Otherwise the algorithm gives
 		    ///false results.)
 		    ///
 		    ///\warning Distances will be wrong (or at least strange) in case of
 		    ///multiple sources.
 		    void addSource(Node s)
+		    {
 		      LEMON_DEBUG(emptyQueue(), "The stack is not empty.");
 		      if(!(*_reached)[s])
@@ -473,3 +480,3 @@
 		    ///
-		    ///\pre The stack must not be empty!
+		    ///\pre The stack must not be empty.
 		    Arc processNextArc()
@@ -499,2 +506,3 @@
+		    }
 		    ///Next arc to be processed.
@@ -503,5 +511,5 @@
 		    ///
 		    ///\return The next arc to be processed or INVALID if the stack is
 		    /// empty.
-		    OutArcIt nextArc()
+		    ///\return The next arc to be processed or \c INVALID if the stack
 		    ///is empty.
 		    OutArcIt nextArc() const
+		    {
@@ -511,11 +519,12 @@
 		    ///\brief Returns \c false if there are nodes
-		    ///to be processed in the queue
+		    ///to be processed.
 		    ///
 		    ///Returns \c false if there are nodes
 		    ///to be processed in the queue
 		    bool emptyQueue() { return _stack_head<0; }
 		    ///to be processed in the queue (stack).
 		    bool emptyQueue() const { return _stack_head<0; }
 		    ///Returns the number of the nodes to be processed.
 		    ///Returns the number of the nodes to be processed in the queue.
 		    int queueSize() { return _stack_head+1; }
 		    ///Returns the number of the nodes to be processed in the queue (stack).
 		    int queueSize() const { return _stack_head+1; }
@@ -525,12 +534,18 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %DFS algorithm from the root node
 		    ///in order to compute the DFS path to each node.
 		    ///
 		    ///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) in the %DFS tree.
 		    /// The algorithm computes
 		    ///- the %DFS tree,
 		    ///- the distance of each node from the root in the %DFS tree.
 		    ///
 		    ///\pre init() must be called and a root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\note <tt>d.start()</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  while ( !d.emptyQueue() ) {
 		    ///    d.processNextArc();
 		    ///  }
 		    ///\endcode
 		    void start()
@@ -540,16 +555,15 @@
-		    ///Executes the algorithm until \c dest is reached.
+		    ///Executes the algorithm until the given target node is reached.
-		    ///Executes the algorithm until \c dest is reached.
+		    ///Executes the algorithm until the given target node is reached.
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %DFS algorithm from the root node
 		    ///in order to compute the DFS path to \c dest.
 		    ///
 		    ///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) in the %DFS tree.
 		    ///The algorithm computes
 		    ///- the %DFS path to \c dest,
 		    ///- the distance of \c dest from the root in the %DFS tree.
 		    ///
 		    ///\pre init() must be called and a root node should be
 		    ///added with addSource() before using this function.
 		    void start(Node dest)
@@ -564,17 +578,20 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %DFS algorithm from the root node
 		    ///until an arc \c a with <tt>am[a]</tt> true is found.
 		    ///
 		    ///\param em must be a bool (or convertible) arc map. The algorithm
 		    ///will stop when it reaches an arc \c e with <tt>em[e]</tt> true.
 		    ///\param am A \c bool (or convertible) arc map. The algorithm
 		    ///will stop when it reaches an arc \c a with <tt>am[a]</tt> true.
 		    ///
-		    ///\return The reached arc \c e with <tt>em[e]</tt> true or
+		    ///\return The reached arc \c a with <tt>am[a]</tt> true or
 		    ///\c INVALID if no such arc was found.
 		    ///
-		    ///\warning Contrary to \ref Bfs and \ref Dijkstra, \c em is an arc map,
+		    ///\pre init() must be called and a root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\warning Contrary to \ref Bfs and \ref Dijkstra, \c am is an arc map,
 		    ///not a node map.
 		    template<class EM>
 		    Arc start(const EM &em)
 		    template<class ArcBoolMap>
 		    Arc start(const ArcBoolMap &am)
+		    {
-		      while ( !emptyQueue() && !em[_stack[_stack_head]] )
+		      while ( !emptyQueue() && !am[_stack[_stack_head]] )
 		        processNextArc();
@@ -583,40 +600,12 @@
-		    ///Runs %DFS algorithm to visit all nodes in the digraph.
+		    ///Runs the algorithm from the given node.
 		    ///This method runs the %DFS algorithm in order to
 		    ///compute the
 		    ///%DFS path to each node. The algorithm computes
 		    ///- The %DFS tree.
-		    ///- The distance of each node from the root in the %DFS tree.
+		    ///This method runs the %DFS algorithm from node \c s
 		    ///in order to compute the DFS path to each node.
 		    ///
 		    ///\note d.run() is just a shortcut of the following code.
 		    ///\code
 		    ///  d.init();
 		    ///  for (NodeIt it(digraph); it != INVALID; ++it) {
 		    ///    if (!d.reached(it)) {
 		    ///      d.addSource(it);
 		    ///      d.start();
 		    ///    }
 		    ///  }
 		    ///\endcode
 		    void run() {
 		      init();
 		      for (NodeIt it(*G); it != INVALID; ++it) {
 		        if (!reached(it)) {
 		          addSource(it);
 		          start();
+		        }
+		      }
+		    }
 		    ///Runs %DFS algorithm from node \c s.
 		    ///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 in the %DFS tree.
 		    ///The algorithm computes
 		    ///- the %DFS tree,
 		    ///- the distance of each node from the root in the %DFS tree.
 		    ///
 		    ///\note d.run(s) is just a shortcut of the following code.
+		    ///\note <tt>d.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
@@ -634,7 +623,9 @@
-		    ///Finds the %DFS path between \c s and \c t.
+		    ///This method runs the %DFS algorithm from node \c s
 		    ///in order to compute the DFS path to \c t.
 		    ///
 		    ///\return The length of the %DFS s---t path if there exists one,
 		    ///0 otherwise.
-		    ///\note Apart from the return value, d.run(s,t) is
+		    ///\return The length of the <tt>s</tt>--<tt>t</tt> DFS path,
 		    ///if \c t is reachable form \c s, \c 0 otherwise.
 		    ///
 		    ///\note Apart from the return value, <tt>d.run(s,t)</tt> is
 		    ///just a shortcut of the following code.
@@ -652,2 +643,31 @@
 		    ///Runs the algorithm to visit all nodes in the digraph.
 		    ///This method runs the %DFS algorithm in order to compute the
 		    ///%DFS path to each node.
 		    ///
 		    ///The algorithm computes
 		    ///- the %DFS tree,
 		    ///- the distance of each node from the root in the %DFS tree.
 		    ///
 		    ///\note <tt>d.run()</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  d.init();
 		    ///  for (NodeIt n(digraph); n != INVALID; ++n) {
 		    ///    if (!d.reached(n)) {
 		    ///      d.addSource(n);
 		    ///      d.start();
 		    ///    }
 		    ///  }
 		    ///\endcode
 		    void run() {
 		      init();
 		      for (NodeIt it(*G); it != INVALID; ++it) {
 		        if (!reached(it)) {
 		          addSource(it);
 		          start();
+		        }
+		      }
+		    }
 		    ///@}
@@ -657,4 +677,4 @@
 		    ///functions.\n
 		    ///Before the use of these functions,
 		    ///either run() or start() must be called.
 		    ///Either \ref lemon::Dfs::run() "run()" or \ref lemon::Dfs::start()
 		    ///"start()" must be called before using them.
@@ -662,30 +682,33 @@
-		    typedef PredMapPath<Digraph, PredMap> Path;
+		    ///The DFS path to a node.
-		    ///Gives back the shortest path.
+		    ///Returns the DFS path to a node.
 		    ///
 		    ///\warning \c t should be reachable from the root.
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Path path(Node t) const { return Path(*G, *_pred, t); }
 		    ///Gives back the shortest path.
 		    ///\pre The \c t should be reachable from the source.
 		    Path path(Node t)
+		    {
 		      return Path(*G, *_pred, t);
+		    }
 		    ///The distance of a node from the root.
 		    ///The distance of a node from the root(s).
 		    ///Returns the distance of a node from the root(s).
 		    ///\pre \ref run() must be called before using this function.
 		    ///\warning If node \c v is unreachable from the root(s) then the return
 		    ///value of this funcion is undefined.
 		    ///Returns the distance of a node from the root.
 		    ///
 		    ///\warning If node \c v is not reachable from the root, then
 		    ///the return value of this function is undefined.
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    int dist(Node v) const { return (*_dist)[v]; }
 		    ///Returns the 'previous arc' of the %DFS tree.
+		    ///Returns the 'previous arc' of the %DFS tree for a node.
 		    ///For a node \c v it returns the 'previous arc'
 		    ///of the %DFS path,
 		    ///i.e. it returns the last arc of a %DFS path from the root(s) to \c
 		    ///v. It is \ref INVALID
 		    ///if \c v is unreachable from the root(s) or \c v is a root. The
 		    ///%DFS tree used here is equal to the %DFS tree used in
 		    ///This function returns the 'previous arc' of the %DFS tree for the
 		    ///node \c v, i.e. it returns the last arc of a %DFS path from the
 		    ///root to \c v. It is \c INVALID
 		    ///if \c v is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The %DFS tree used here is equal to the %DFS tree used in
 		    ///\ref predNode().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before using
@@ -696,10 +719,10 @@
 		    ///For a node \c v it returns the 'previous node'
 		    ///of the %DFS tree,
 		    ///i.e. it returns the last but one node from a %DFS path from the
 		    ///root(s) to \c v.
 		    ///It is INVALID if \c v is unreachable from the root(s) or
 		    ///if \c v itself a root.
 		    ///The %DFS tree used here is equal to the %DFS
 		    ///tree used in \ref predArc().
 		    ///This function returns the 'previous node' of the %DFS
 		    ///tree for the node \c v, i.e. it returns the last but one node
 		    ///from a %DFS path from the root to \c v. It is \c INVALID
 		    ///if \c v is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The %DFS tree used here is equal to the %DFS tree used in
 		    ///\ref predArc().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
@@ -709,13 +732,18 @@
 		    ///Returns a reference to the NodeMap of distances.
 		    ///Returns a reference to the NodeMap of distances.
 		    ///\pre Either \ref run() or \ref init() must
-		    ///be called before using this function.
+		    ///\brief Returns a const reference to the node map that stores the
 		    ///distances of the nodes.
 		    ///
 		    ///Returns a const reference to the node map that stores the
 		    ///distances of the nodes calculated by the algorithm.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
 		    ///must be called before using this function.
 		    const DistMap &distMap() const { return *_dist;}
 		    ///Returns a reference to the %DFS arc-tree map.
 		    ///Returns a reference to the NodeMap of the arcs of the
 		    ///%DFS tree.
 		    ///\brief Returns a const reference to the node map that stores the
 		    ///predecessor arcs.
 		    ///
 		    ///Returns a const reference to the node map that stores the predecessor
 		    ///arcs, which form the DFS tree.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
@@ -724,10 +752,8 @@
 		    ///Checks if a node is reachable from the root.
+		    ///Checks if a node is reachable from the root(s).
 		    ///Returns \c true if \c v is reachable from the root(s).
 		    ///\warning The source nodes are inditated as unreachable.
 		    ///\pre Either \ref run() or \ref start()
 		    ///must be called before using this function.
 		    ///
 		    bool reached(Node v) { return (*_reached)[v]; }
 		    bool reached(Node v) const { return (*_reached)[v]; }
@@ -736,5 +762,5 @@
-		  ///Default traits class of Dfs function.
+		  ///Default traits class of dfs() function.
-		  ///Default traits class of Dfs function.
+		  ///Default traits class of dfs() function.
 		  ///\tparam GR Digraph type.
@@ -743,8 +769,9 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
-		    ///\brief The type of the map that stores the last
 		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the %DFS paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the %DFS paths.
@@ -752,12 +779,13 @@
 		    ///
 		    typedef NullMap<typename Digraph::Node,typename GR::Arc> PredMap;
 		    ///Instantiates a PredMap.
 		    typedef NullMap<typename Digraph::Node,typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \ref PredMap.
-		    ///\param g is the digraph, to which we would like to define the PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient to initialize
 		#ifdef DOXYGEN
-		    static PredMap *createPredMap(const GR &g)
+		    static PredMap *createPredMap(const Digraph &g)
 		#else
-		    static PredMap *createPredMap(const GR &)
+		    static PredMap *createPredMap(const Digraph &)
 		#endif
@@ -771,5 +799,4 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
@@ -777,7 +804,7 @@
 		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ProcessedMap
+		    ///we would like to define the \ref ProcessedMap.
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -786,2 +813,3 @@
+		    }
 		    ///The type of the map that indicates which nodes are reached.
@@ -789,17 +817,17 @@
 		    ///The type of the map that indicates which nodes are reached.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///\todo named parameter to set this type, function to read and write.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \ref ReachedMap.
 		    ///This function instantiates a \ref ReachedMap.
-		    ///\param G is the digraph, to which
+		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ReachedMap.
-		    static ReachedMap *createReachedMap(const GR &G)
+		    static ReachedMap *createReachedMap(const Digraph &g)
+		    {
-		      return new ReachedMap(G);
+		      return new ReachedMap(g);
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -807,3 +835,3 @@
 		    typedef NullMap<typename Digraph::Node,int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \ref DistMap.
@@ -813,5 +841,5 @@
 		#ifdef DOXYGEN
-		    static DistMap *createDistMap(const GR &g)
+		    static DistMap *createDistMap(const Digraph &g)
 		#else
-		    static DistMap *createDistMap(const GR &)
+		    static DistMap *createDistMap(const Digraph &)
 		#endif
@@ -822,3 +850,3 @@
 		  /// Default traits used by \ref DfsWizard
+		  /// Default traits class used by \ref DfsWizard
@@ -836,16 +864,16 @@
 		  protected:
-		    /// Type of the nodes in the digraph.
+		    //The type of the nodes in the digraph.
 		    typedef typename Base::Digraph::Node Node;
-		    /// Pointer to the underlying digraph.
+		    //Pointer to the digraph the algorithm runs on.
 		    void *_g;
-		    ///Pointer to the map of reached nodes.
 		    //Pointer to the map of reached nodes.
 		    void *_reached;
-		    ///Pointer to the map of processed nodes.
 		    //Pointer to the map of processed nodes.
 		    void *_processed;
-		    ///Pointer to the map of predecessors arcs.
 		    //Pointer to the map of predecessors arcs.
 		    void *_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    void *_dist;
-		    ///Pointer to the source node.
 		    //Pointer to the source node.
 		    Node _source;
@@ -865,4 +893,4 @@
 		    /// Others are initiated to 0.
 		    /// \param g is the initial value of  \ref _g
 		    /// \param s is the initial value of  \ref _source
 		    /// \param g The digraph the algorithm runs on.
 		    /// \param s The source node.
 		    DfsWizardBase(const GR &g, Node s=INVALID) :
@@ -873,7 +901,9 @@
-		  /// A class to make the usage of the Dfs algorithm easier
+		  /// Auxiliary class for the function type interface of 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.
+		  /// This auxiliary class is created to implement the function type
 		  /// interface of \ref Dfs algorithm. It uses the functions and features
 		  /// of the plain \ref Dfs, but it is much simpler to use it.
 		  /// It should only be used through the \ref dfs() function, which makes
 		  /// it easier to use the algorithm.
 		  ///
@@ -886,8 +916,8 @@
 		  /// operator. In the case of \ref DfsWizard only
 		  /// a function have to be called and it will
+		  /// a function have to be called, and it will
 		  /// return the needed class.
 		  ///
 		  /// It does not have own \ref run method. When its \ref run method is called
 		  /// it initiates a plain \ref Dfs object, and calls the \ref Dfs::run
-		  /// method of it.
+		  /// It does not have own \ref run() method. When its \ref run() method
 		  /// is called, it initiates a plain \ref Dfs object, and calls the
 		  /// \ref Dfs::run() method of it.
 		  template<class TR>
@@ -897,26 +927,22 @@
-		    ///The type of the underlying digraph.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
-		    //\e
 		    typedef typename Digraph::Node Node;
 		    //\e
 		    typedef typename Digraph::NodeIt NodeIt;
 		    //\e
 		    typedef typename Digraph::Arc Arc;
 		    //\e
 		    typedef typename Digraph::OutArcIt OutArcIt;
 		    ///\brief The type of the map that stores
 		    ///the reached nodes
 		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    typedef typename TR::PredMap PredMap;
 		    ///\brief The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///\brief The type of the map that indicates which nodes are reached.
 		    typedef typename TR::ReachedMap ReachedMap;
 		    ///\brief The type of the map that stores
 		    ///the processed nodes
 		    ///\brief The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///\brief The type of the map that stores the last
 		    ///arcs of the %DFS paths.
 		    typedef typename TR::PredMap PredMap;
 		    ///The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		  public:
 		    /// Constructor.
@@ -936,6 +962,6 @@
-		    ///Runs Dfs algorithm from a given node.
+		    ///Runs DFS algorithm from a source node.
 		    ///Runs Dfs algorithm from a given node.
 		    ///The node can be given by the \ref source function.
 		    ///Runs DFS algorithm from a source node.
 		    ///The node can be given with the \ref source() function.
 		    void run()
@@ -955,5 +981,5 @@
-		    ///Runs Dfs algorithm from the given node.
+		    ///Runs DFS algorithm from the given node.
-		    ///Runs Dfs algorithm from the given node.
+		    ///Runs DFS algorithm from the given node.
 		    ///\param s is the given source.
@@ -965,2 +991,12 @@
 		    /// Sets the source node, from which the Dfs algorithm runs.
 		    /// Sets the source node, from which the Dfs algorithm runs.
 		    /// \param s is the source node.
 		    DfsWizard<TR> &source(Node s)
+		    {
 		      Base::_source=s;
 		      return *this;
+		    }
 		    template<class T>
@@ -971,9 +1007,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting PredMap type
+		    ///for setting \ref PredMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting PredMap type
 		    ///
 		    ///for setting \ref PredMap object.
 		    template<class T>
@@ -985,3 +1019,2 @@
 		    template<class T>
@@ -992,9 +1025,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting ReachedMap
+		    ///for setting \ref ReachedMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting ReachedMap
 		    ///
 		    ///for setting \ref ReachedMap object.
 		    template<class T>
@@ -1006,3 +1037,2 @@
 		    template<class T>
@@ -1013,9 +1043,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting ProcessedMap
+		    ///for setting \ref ProcessedMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting ProcessedMap
 		    ///
 		    ///for setting \ref ProcessedMap object.
 		    template<class T>
@@ -1033,9 +1061,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting DistMap type
+		    ///for setting \ref DistMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting DistMap type
 		    ///
 		    ///for setting \ref DistMap object.
 		    template<class T>
@@ -1047,12 +1073,2 @@
 		    /// Sets the source node, from which the Dfs algorithm runs.
 		    /// Sets the source node, from which the Dfs algorithm runs.
 		    /// \param s is the source node.
 		    DfsWizard<TR> &source(Node s)
+		    {
 		      Base::_source=s;
 		      return *this;
+		    }
 		  };
@@ -1084,6 +1100,6 @@
 		#ifdef DOXYGEN
-		  /// \brief Visitor class for dfs.
+		  /// \brief Visitor class for DFS.
 		  ///
 		  /// It gives a simple interface for a functional interface for dfs
 		  /// traversal. The traversal on a linear data structure.
 		  /// This class defines the interface of the DfsVisit events, and
 		  /// it could be the base of a real visitor class.
 		  template <typename _Digraph>
@@ -1093,34 +1109,33 @@
 		    typedef typename Digraph::Node Node;
-		    /// \brief Called when the arc reach a node.
+		    /// \brief Called for the source node of the DFS.
 		    ///
 		    /// It is called when the dfs find an arc which target is not
 		    /// reached yet.
 		    /// This function is called for the source node of the DFS.
 		    void start(const Node& node) {}
 		    /// \brief Called when the source node is leaved.
 		    ///
 		    /// This function is called when the source node is leaved.
 		    void stop(const Node& node) {}
 		    /// \brief Called when a node is reached first time.
 		    ///
 		    /// This function is called when a node is reached first time.
 		    void reach(const Node& node) {}
 		    /// \brief Called when an arc reaches a new node.
 		    ///
 		    /// This function is called when the DFS finds an arc whose target node
 		    /// is not reached yet.
 		    void discover(const Arc& arc) {}
 		    /// \brief Called when the node reached first time.
 		    ///
 		    /// It is Called when the node reached first time.
 		    void reach(const Node& node) {}
 		    /// \brief Called when we step back on an arc.
 		    ///
 		    /// It is called when the dfs should step back on the arc.
 		    void backtrack(const Arc& arc) {}
 		    /// \brief Called when we step back from the node.
 		    ///
 		    /// It is called when we step back from the node.
 		    void leave(const Node& node) {}
-		    /// \brief Called when the arc examined but target of the arc
+		    /// \brief Called when an arc is examined but its target node is
 		    /// already discovered.
 		    ///
-		    /// It called when the arc examined but the target of the arc
+		    /// This function is called when an arc is examined but its target node is
 		    /// already discovered.
 		    void examine(const Arc& arc) {}
-		    /// \brief Called for the source node of the dfs.
+		    /// \brief Called when the DFS steps back from a node.
 		    ///
 		    /// It is called for the source node of the dfs.
 		    void start(const Node& node) {}
-		    /// \brief Called when we leave the source node of the dfs.
+		    /// This function is called when the DFS steps back from a node.
 		    void leave(const Node& node) {}
 		    /// \brief Called when the DFS steps back on an arc.
 		    ///
 		    /// It is called when we leave the source node of the dfs.
 		    void stop(const Node& node) {}
+		    /// This function is called when the DFS steps back on an arc.
 		    void backtrack(const Arc& arc) {}
 		  };
@@ -1132,9 +1147,9 @@
 		    typedef typename Digraph::Node Node;
 		    void discover(const Arc&) {}
 		    void reach(const Node&) {}
 		    void backtrack(const Arc&) {}
 		    void leave(const Node&) {}
 		    void examine(const Arc&) {}
 		    void start(const Node&) {}
 		    void stop(const Node&) {}
 		    void reach(const Node&) {}
 		    void discover(const Arc&) {}
 		    void examine(const Arc&) {}
 		    void leave(const Node&) {}
 		    void backtrack(const Arc&) {}
@@ -1145,9 +1160,9 @@
 		        Node node;
 		        visitor.discover(arc);
 		        visitor.reach(node);
 		        visitor.backtrack(arc);
 		        visitor.leave(node);
 		        visitor.examine(arc);
 		        visitor.start(node);
 		        visitor.stop(arc);
 		        visitor.reach(node);
 		        visitor.discover(arc);
 		        visitor.examine(arc);
 		        visitor.leave(node);
 		        visitor.backtrack(arc);
+		      }
@@ -1161,3 +1176,3 @@
 		  /// Default traits class of DfsVisit class.
-		  /// \tparam _Digraph Digraph type.
+		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  template<class _Digraph>
@@ -1165,3 +1180,3 @@
-		    /// \brief The digraph type the algorithm runs on.
+		    /// \brief The type of the digraph the algorithm runs on.
 		    typedef _Digraph Digraph;
@@ -1171,7 +1186,6 @@
 		    /// The type of the map that indicates which nodes are reached.
 		    /// It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    /// \todo named parameter to set this type, function to read and write.
 		    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    /// \brief Instantiates a ReachedMap.
+		    /// \brief Instantiates a \ref ReachedMap.
 		    ///
@@ -1186,5 +1200,6 @@
 		  /// %DFS Visit algorithm class.
 		  /// \ingroup search
 		  ///
 		  /// \brief %DFS algorithm class with visitor interface.
 		  ///
 		  /// This class provides an efficient implementation of the %DFS algorithm
@@ -1194,12 +1209,12 @@
 		  /// class. It works with callback mechanism, the DfsVisit object calls
-		  /// on every dfs event the \c Visitor class member functions.
+		  /// the member functions of the \c Visitor class on every DFS event.
 		  ///
-		  /// \tparam _Digraph The digraph type the algorithm runs on.
+		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  /// The default value is
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by Dfs, it
 		  /// is only passed to \ref DfsDefaultTraits.
 		  /// \tparam _Visitor The Visitor object for the algorithm. The
 		  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty Visitor which
 		  /// does not observe the Dfs events. If you want to observe the dfs
 		  /// events you should implement your own Visitor class.
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by
 		  /// \ref DfsVisit, it is only passed to \ref DfsVisitDefaultTraits.
 		  /// \tparam _Visitor The Visitor type that is used by the algorithm.
 		  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty visitor, which
 		  /// does not observe the DFS events. If you want to observe the DFS
 		  /// events, you should implement your own visitor class.
 		  /// \tparam _Traits Traits class to set various data types used by the
@@ -1208,5 +1223,3 @@
 		  /// See \ref DfsVisitDefaultTraits for the documentation of
 		  /// a Dfs visit traits class.
 		  ///
-		  /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
+		  /// a DFS visit traits class.
 		#ifdef DOXYGEN
@@ -1224,3 +1237,3 @@
 		    /// This error represents problems in the initialization
-		    /// of the parameters of the algorithms.
+		    /// of the parameters of the algorithm.
 		    class UninitializedParameter : public lemon::UninitializedParameter {
@@ -1233,9 +1246,12 @@
 		    ///The traits class.
 		    typedef _Traits Traits;
 		    ///The type of the digraph the algorithm runs on.
 		    typedef typename Traits::Digraph Digraph;
 		    ///The visitor type used by the algorithm.
 		    typedef _Visitor Visitor;
-		    ///The type of the map indicating which nodes are reached.
+		    ///The type of the map that indicates which nodes are reached.
 		    typedef typename Traits::ReachedMap ReachedMap;
@@ -1249,9 +1265,9 @@
-		    /// Pointer to the underlying digraph.
 		    //Pointer to the underlying digraph.
 		    const Digraph *_digraph;
-		    /// Pointer to the visitor object.
 		    //Pointer to the visitor object.
 		    Visitor *_visitor;
-		    ///Pointer to the map of reached status of the nodes.
 		    //Pointer to the map of reached status of the nodes.
 		    ReachedMap *_reached;
-		    ///Indicates if \ref _reached is locally allocated (\c true) or not.
 		    //Indicates if _reached is locally allocated (true) or not.
 		    bool local_reached;
@@ -1261,5 +1277,4 @@
 		    /// \brief Creates the maps if necessary.
 		    ///
 		    /// Creates the maps if necessary.
 		    ///\todo Better memory allocation (instead of new).
 		    void create_maps() {
@@ -1290,5 +1305,5 @@
 		    /// \brief \ref named-templ-param "Named parameter" for setting
 		    /// ReachedMap type
+		    /// ReachedMap type.
 		    ///
 		    /// \ref named-templ-param "Named parameter" for setting ReachedMap type
+		    /// \ref named-templ-param "Named parameter" for setting ReachedMap type.
 		    template <class T>
@@ -1306,5 +1321,4 @@
 		    ///
 		    /// \param digraph the digraph the algorithm will run on.
 		    /// \param visitor The visitor of the algorithm.
 		    ///
+		    /// \param digraph The digraph the algorithm runs on.
 		    /// \param visitor The visitor object of the algorithm.
 		    DfsVisit(const Digraph& digraph, Visitor& visitor)
@@ -1314,4 +1328,2 @@
 		    /// \brief Destructor.
 		    ///
 		    /// Destructor.
 		    ~DfsVisit() {
@@ -1320,7 +1332,7 @@
-		    /// \brief Sets the map indicating if a node is reached.
+		    /// \brief Sets the map that indicates which nodes are reached.
 		    ///
-		    /// Sets the map indicating if a node is reached.
+		    /// Sets the map that indicates which nodes are reached.
 		    /// If you don't use this function before calling \ref run(),
-		    /// it will allocate one. The destuctor deallocates this
+		    /// it will allocate one. The destructor deallocates this
 		    /// automatically allocated map, of course.
@@ -1337,13 +1349,16 @@
 		  public:
 		    /// \name Execution control
 		    /// The simplest way to execute the algorithm is to use
-		    /// one of the member functions called \c run(...).
+		    /// one of the member functions called \ref lemon::DfsVisit::run()
 		    /// "run()".
 		    /// \n
 		    /// If you need more control on the execution,
 		    /// first you must call \ref init(), then you can adda source node
 		    /// with \ref addSource().
 		    /// Finally \ref start() will perform the actual path
-		    /// computation.
+		    /// If you need more control on the execution, first you must call
 		    /// \ref lemon::DfsVisit::init() "init()", then you can add several
 		    /// source nodes with \ref lemon::DfsVisit::addSource() "addSource()".
 		    /// Finally \ref lemon::DfsVisit::start() "start()" will perform the
 		    /// actual path computation.
 		    /// @{
 		    /// \brief Initializes the internal data structures.
@@ -1351,3 +1366,2 @@
 		    /// Initializes the internal data structures.
 		    ///
 		    void init() {
@@ -1361,6 +1375,14 @@
-		    /// \brief Adds a new source node.
 		    ///Adds a new source node.
 		    ///Adds a new source node to the set of nodes to be processed.
 		    ///
 		    /// Adds a new source node to the set of nodes to be processed.
 		    void addSource(Node s) {
 		    ///\pre The stack must be empty. (Otherwise the algorithm gives
 		    ///false results.)
 		    ///
 		    ///\warning Distances will be wrong (or at least strange) in case of
 		    ///multiple sources.
 		    void addSource(Node s)
+		    {
 		      LEMON_DEBUG(emptyQueue(), "The stack is not empty.");
 		      if(!(*_reached)[s]) {
@@ -1385,3 +1407,3 @@
 		    ///
-		    /// \pre The stack must not be empty!
+		    /// \pre The stack must not be empty.
 		    Arc processNextArc() {
@@ -1419,3 +1441,3 @@
 		    /// empty.
 		    Arc nextArc() {
+		    Arc nextArc() const {
 		      return _stack_head >= 0 ? _stack[_stack_head] : INVALID;
@@ -1424,7 +1446,7 @@
 		    /// \brief Returns \c false if there are nodes
-		    /// to be processed in the queue
+		    /// to be processed.
 		    ///
 		    /// Returns \c false if there are nodes
 		    /// to be processed in the queue
 		    bool emptyQueue() { return _stack_head < 0; }
 		    /// to be processed in the queue (stack).
 		    bool emptyQueue() const { return _stack_head < 0; }
@@ -1432,4 +1454,4 @@
 		    ///
 		    /// Returns the number of the nodes to be processed in the queue.
 		    int queueSize() { return _stack_head + 1; }
 		    /// Returns the number of the nodes to be processed in the queue (stack).
 		    int queueSize() const { return _stack_head + 1; }
@@ -1439,4 +1461,18 @@
 		    ///
 		    /// \pre init() must be called and at least one node should be added
 		    /// with addSource() before using this function.
 		    /// This method runs the %DFS algorithm from the root node
 		    /// in order to compute the %DFS path to each node.
 		    ///
 		    /// The algorithm computes
 		    /// - the %DFS tree,
 		    /// - the distance of each node from the root in the %DFS tree.
 		    ///
 		    /// \pre init() must be called and a root node should be
 		    /// added with addSource() before using this function.
 		    ///
 		    /// \note <tt>d.start()</tt> is just a shortcut of the following code.
 		    /// \code
 		    ///   while ( !d.emptyQueue() ) {
 		    ///     d.processNextArc();
 		    ///   }
 		    /// \endcode
 		    void start() {
@@ -1445,7 +1481,14 @@
-		    /// \brief Executes the algorithm until \c dest is reached.
+		    /// \brief Executes the algorithm until the given target node is reached.
 		    ///
-		    /// Executes the algorithm until \c dest is reached.
+		    /// Executes the algorithm until the given target node is reached.
 		    ///
-		    /// \pre init() must be called and at least one node should be added
+		    /// This method runs the %DFS algorithm from the root node
 		    /// 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 in the %DFS tree.
 		    ///
 		    /// \pre init() must be called and a root node should be added
 		    /// with addSource() before using this function.
@@ -1460,16 +1503,19 @@
 		    ///
-		    /// \pre init() must be called and at least one node should be added
+		    /// This method runs the %DFS algorithm from the root node
 		    /// until an arc \c a with <tt>am[a]</tt> true is found.
 		    ///
 		    /// \param am A \c bool (or convertible) arc map. The algorithm
 		    /// will stop when it reaches an arc \c a with <tt>am[a]</tt> true.
 		    ///
 		    /// \return The reached arc \c a with <tt>am[a]</tt> true or
 		    /// \c INVALID if no such arc was found.
 		    ///
 		    /// \pre init() must be called and a root node should be added
 		    /// with addSource() before using this function.
 		    ///
 		    /// \param em must be a bool (or convertible) arc map. The algorithm
 		    /// will stop when it reaches an arc \c e with <tt>em[e]</tt> true.
 		    ///
 		    ///\return The reached arc \c e with <tt>em[e]</tt> true or
 		    ///\c INVALID if no such arc was found.
 		    ///
-		    /// \warning Contrary to \ref Bfs and \ref Dijkstra, \c em is an arc map,
+		    /// \warning Contrary to \ref Bfs and \ref Dijkstra, \c am is an arc map,
 		    /// not a node map.
 		    template <typename EM>
 		    Arc start(const EM &em) {
-		      while ( !emptyQueue() && !em[_stack[_stack_head]] )
+		    template <typename AM>
 		    Arc start(const AM &am) {
 		      while ( !emptyQueue() && !am[_stack[_stack_head]] )
 		        processNextArc();
@@ -1478,6 +1524,12 @@
-		    /// \brief Runs %DFSVisit algorithm from node \c s.
+		    /// \brief Runs the algorithm from the given node.
 		    ///
 		    /// This method runs the %DFS algorithm from a root node \c s.
 		    /// \note d.run(s) is just a shortcut of the following code.
 		    /// This method runs the %DFS algorithm from 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 in the %DFS tree.
 		    ///
 		    /// \note <tt>d.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
@@ -1493,15 +1545,39 @@
-		    /// \brief Runs %DFSVisit algorithm to visit all nodes in the digraph.
+		    /// \brief Finds the %DFS path between \c s and \c t.
 		    /// This method runs the %DFS algorithm from node \c s
 		    /// in order to compute the DFS path to \c t.
 		    ///
 		    /// \return The length of the <tt>s</tt>--<tt>t</tt> DFS path,
 		    /// if \c t is reachable form \c s, \c 0 otherwise.
 		    ///
 		    /// \note Apart from the return value, <tt>d.run(s,t)</tt> is
 		    /// just a shortcut of the following code.
 		    ///\code
 		    ///   d.init();
 		    ///   d.addSource(s);
 		    ///   d.start(t);
 		    ///\endcode
 		    int run(Node s,Node t) {
 		      init();
 		      addSource(s);
 		      start(t);
 		      return reached(t)?_stack_head+1:0;
+		    }
 		    /// \brief Runs the algorithm to visit all nodes in the digraph.
 		    /// This method runs the %DFS algorithm in order to
 		    /// compute the %DFS path to each node. The algorithm computes
 		    /// - The %DFS tree.
-		    /// - The distance of each node from the root in the %DFS tree.
+		    /// compute the %DFS path to each node.
 		    ///
-		    ///\note d.run() is just a shortcut of the following code.
+		    /// The algorithm computes
 		    /// - the %DFS tree,
 		    /// - the distance of each node from the root in the %DFS tree.
 		    ///
 		    /// \note <tt>d.run()</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  d.init();
 		    ///  for (NodeIt it(digraph); it != INVALID; ++it) {
 		    ///    if (!d.reached(it)) {
-		    ///      d.addSource(it);
+		    ///   for (NodeIt n(digraph); n != INVALID; ++n) {
 		    ///     if (!d.reached(n)) {
 		    ///       d.addSource(n);
 		    ///      d.start();
@@ -1519,2 +1595,3 @@
+		    }
 		    ///@}
@@ -1524,17 +1601,18 @@
 		    /// functions.\n
 		    /// Before the use of these functions,
 		    /// either run() or start() must be called.
 		    /// Either \ref lemon::DfsVisit::run() "run()" or
 		    /// \ref lemon::DfsVisit::start() "start()" must be called before
 		    /// using them.
 		    ///@{
-		    /// \brief Checks if a node is reachable from the root.
 		    /// \brief Checks if a node is reachable from the root(s).
 		    ///
 		    /// Returns \c true if \c v is reachable from the root(s).
 		    /// \warning The source nodes are inditated as unreachable.
 		    /// \pre Either \ref run() or \ref start()
 		    /// must be called before using this function.
 		    ///
 		    bool reached(Node v) { return (*_reached)[v]; }
 		    ///@}
 		  };
 		} //END OF NAMESPACE LEMON
@@ -1542,2 +1620,1 @@
 		#endif

lemon/dijkstra.h

Show inline comments

@@ -35,6 +35,6 @@
-		  /// \brief Default OperationTraits for the Dijkstra algorithm class.
+		  /// \brief Default operation traits for the Dijkstra algorithm class.
 		  ///
 		  /// It defines all computational operations and constants which are
 		  /// used in the Dijkstra algorithm.
 		  /// This operation traits class defines all computational operations and
 		  /// constants which are used in the Dijkstra algorithm.
 		  template <typename Value>
@@ -49,3 +49,3 @@
+		    }
 		    /// \brief Gives back true only if the first value less than the second.
+		    /// \brief Gives back true only if the first value is less than the second.
 		    static bool less(const Value& left, const Value& right) {
@@ -55,6 +55,9 @@
-		  /// \brief Widest path OperationTraits for the Dijkstra algorithm class.
+		  /// \brief Widest path operation traits for the Dijkstra algorithm class.
 		  ///
 		  /// It defines all computational operations and constants which are
 		  /// used in the Dijkstra algorithm for widest path computation.
 		  /// This operation traits class defines all computational operations and
 		  /// constants which are used in the Dijkstra algorithm for widest path
 		  /// computation.
 		  ///
 		  /// \see DijkstraDefaultOperationTraits
 		  template <typename Value>
@@ -69,3 +72,3 @@
+		    }
 		    /// \brief Gives back true only if the first value less than the second.
+		    /// \brief Gives back true only if the first value is less than the second.
 		    static bool less(const Value& left, const Value& right) {
@@ -78,4 +81,4 @@
 		  ///Default traits class of Dijkstra class.
 		  ///\tparam GR Digraph type.
 		  ///\tparam LM Type of length map.
 		  ///\tparam GR The type of the digraph.
 		  ///\tparam LM The type of the length map.
 		  template<class GR, class LM>
@@ -83,4 +86,5 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
 		    ///The type of the map that stores the arc lengths.
@@ -90,28 +94,29 @@
 		    typedef LM LengthMap;
 		    //The type of the length of the arcs.
+		    ///The type of the length of the arcs.
 		    typedef typename LM::Value Value;
 		    /// Operation traits for Dijkstra algorithm.
-		    /// It defines the used operation by the algorithm.
+		    /// This class defines the operations that are used in the algorithm.
 		    /// \see DijkstraDefaultOperationTraits
 		    typedef DijkstraDefaultOperationTraits<Value> OperationTraits;
 		    /// The cross reference type used by heap.
 		    /// The cross reference type used by the heap.
 		    /// The cross reference type used by heap.
+		    /// The cross reference type used by the heap.
 		    /// Usually it is \c Digraph::NodeMap<int>.
 		    typedef typename Digraph::template NodeMap<int> HeapCrossRef;
 		    ///Instantiates a HeapCrossRef.
+		    ///Instantiates a \ref HeapCrossRef.
 		    ///This function instantiates a \c HeapCrossRef.
 		    /// \param G is the digraph, to which we would like to define the
 		    /// HeapCrossRef.
 		    static HeapCrossRef *createHeapCrossRef(const GR &G)
 		    ///This function instantiates a \ref HeapCrossRef.
 		    /// \param g is the digraph, to which we would like to define the
 		    /// \ref HeapCrossRef.
 		    static HeapCrossRef *createHeapCrossRef(const Digraph &g)
+		    {
-		      return new HeapCrossRef(G);
+		      return new HeapCrossRef(g);
+		    }
 		    ///The heap type used by Dijkstra algorithm.
+		    ///The heap type used by the Dijkstra algorithm.
 		    ///The heap type used by Dijkstra algorithm.
+		    ///The heap type used by the Dijkstra algorithm.
 		    ///
@@ -120,29 +125,31 @@
 		    typedef BinHeap<typename LM::Value, HeapCrossRef, std::less<Value> > Heap;
 		    ///Instantiates a \ref Heap.
-		    static Heap *createHeap(HeapCrossRef& R)
+		    ///This function instantiates a \ref Heap.
 		    static Heap *createHeap(HeapCrossRef& r)
+		    {
-		      return new Heap(R);
+		      return new Heap(r);
+		    }
-		    ///\brief The type of the map that stores the last
+		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<typename GR::Arc> PredMap;
-		    ///Instantiates a PredMap.
+		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \c PredMap.
 		    ///\param G is the digraph, to which we would like to define the PredMap.
 		    ///This function instantiates a \ref PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient for the initialization
-		    static PredMap *createPredMap(const GR &G)
+		    static PredMap *createPredMap(const Digraph &g)
+		    {
-		      return new PredMap(G);
+		      return new PredMap(g);
+		    }
-		    ///The type of the map that stores whether a nodes is processed.
+		    ///The type of the map that indicates which nodes are processed.
-		    ///The type of the map that stores whether a nodes is processed.
+		    ///The type of the map that indicates which nodes are processed.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -151,13 +158,12 @@
 		    ///Dijkstra::processed() should read this.
 		    ///\todo named parameter to set this type, function to read and write.
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
-		    ///This function instantiates a \c ProcessedMap.
+		    ///This function instantiates a \ref ProcessedMap.
 		    ///\param g is the digraph, to which
-		    ///we would like to define the \c ProcessedMap
+		    ///we would like to define the \ref ProcessedMap
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -166,16 +172,16 @@
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \ref DistMap.
 		    ///This function instantiates a \ref DistMap.
-		    ///\param G is the digraph, to which we would like to define
+		    ///\param g is the digraph, to which we would like to define
 		    ///the \ref DistMap
-		    static DistMap *createDistMap(const GR &G)
+		    static DistMap *createDistMap(const Digraph &g)
+		    {
-		      return new DistMap(G);
+		      return new DistMap(g);
+		    }
@@ -186,3 +192,4 @@
 		  /// \ingroup shortest_path
 		  ///This class provides an efficient implementation of %Dijkstra algorithm.
+		  ///This class provides an efficient implementation of the %Dijkstra algorithm.
 		  ///
 		  ///The arc lengths are passed to the algorithm using a
@@ -190,25 +197,25 @@
 		  ///so it is easy to change it to any kind of length.
 		  ///
 		  ///The type of the length is determined by the
 		  ///\ref concepts::ReadMap::Value "Value" of the length map.
 		  ///
 		  ///It is also possible to change the underlying priority heap.
 		  ///
 		  ///\tparam GR The digraph type the algorithm runs on. The default value
 		  ///is \ref ListDigraph. The value of GR is not used directly by
 		  ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
 		  ///\tparam LM This read-only ArcMap determines the lengths of the
 		  ///There is also a \ref dijkstra() "function type interface" for the
 		  ///%Dijkstra algorithm, which is convenient in the simplier cases and
 		  ///it can be used easier.
 		  ///
 		  ///\tparam GR The type of the digraph the algorithm runs on.
 		  ///The default value is \ref ListDigraph.
 		  ///The value of GR is not used directly by \ref Dijkstra, it is only
 		  ///passed to \ref DijkstraDefaultTraits.
 		  ///\tparam LM A readable arc map that determines the lengths of the
 		  ///arcs. It is read once for each arc, so the map may involve in
-		  ///relatively time consuming process to compute the arc length if
+		  ///relatively time consuming process to compute the arc lengths if
 		  ///it is necessary. The default map type is \ref
 		  ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".  The value
 		  ///of LM is not used directly by Dijkstra, it is only passed to \ref
 		  ///DijkstraDefaultTraits.
 		  ///\tparam TR Traits class to set
 		  ///various data types used by the algorithm.  The default traits
 		  ///class is \ref DijkstraDefaultTraits
 		  ///"DijkstraDefaultTraits<GR,LM>".  See \ref
 		  ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
 		  ///class.
 		  ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
 		  ///The value of LM is not used directly by \ref Dijkstra, it is only
 		  ///passed to \ref DijkstraDefaultTraits.
 		  ///\tparam TR Traits class to set various data types used by the algorithm.
 		  ///The default traits class is \ref DijkstraDefaultTraits
 		  ///"DijkstraDefaultTraits<GR,LM>". See \ref DijkstraDefaultTraits
 		  ///for the documentation of a Dijkstra traits class.
 		#ifdef DOXYGEN
@@ -222,8 +229,6 @@
 		  public:
 		    /**
 		     * \brief \ref Exception for uninitialized parameters.
+		     *
 		     * This error represents problems in the initialization
 		     * of the parameters of the algorithms.
 		     */
 		    ///\ref Exception for uninitialized parameters.
 		    ///This error represents problems in the initialization of the
 		    ///parameters of the algorithm.
 		    class UninitializedParameter : public lemon::UninitializedParameter {
@@ -235,13 +240,4 @@
 		    typedef TR Traits;
 		    ///The type of the underlying digraph.
 		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
 		    ///\e
 		    typedef typename Digraph::Node Node;
 		    ///\e
 		    typedef typename Digraph::NodeIt NodeIt;
 		    ///\e
 		    typedef typename Digraph::Arc Arc;
 		    ///\e
 		    typedef typename Digraph::OutArcIt OutArcIt;
@@ -251,39 +247,51 @@
 		    typedef typename TR::LengthMap LengthMap;
 		    ///\brief The type of the map that stores the last
 		    ///arcs of the shortest paths.
 		    ///\brief The type of the map that stores the predecessor arcs of the
 		    ///shortest paths.
 		    typedef typename TR::PredMap PredMap;
-		    ///The type of the map indicating if a node is processed.
+		    ///The type of the map that stores the distances of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///The type of the map that stores the dists of the nodes.
 		    typedef typename TR::DistMap DistMap;
 		    ///The type of the paths.
 		    typedef PredMapPath<Digraph, PredMap> Path;
 		    ///The cross reference type used for the current heap.
 		    typedef typename TR::HeapCrossRef HeapCrossRef;
-		    ///The heap type used by the dijkstra algorithm.
 		    ///The heap type used by the algorithm.
 		    typedef typename TR::Heap Heap;
 		    ///The operation traits.
+		    ///The operation traits class.
 		    typedef typename TR::OperationTraits OperationTraits;
 		    ///The traits class.
 		    typedef TR Traits;
 		  private:
-		    /// Pointer to the underlying digraph.
 		    typedef typename Digraph::Node Node;
 		    typedef typename Digraph::NodeIt NodeIt;
 		    typedef typename Digraph::Arc Arc;
 		    typedef typename Digraph::OutArcIt OutArcIt;
 		    //Pointer to the underlying digraph.
 		    const Digraph *G;
-		    /// Pointer to the length map
+		    //Pointer to the length map.
 		    const LengthMap *length;
-		    ///Pointer to the map of predecessors arcs.
 		    //Pointer to the map of predecessors arcs.
 		    PredMap *_pred;
-		    ///Indicates if \ref _pred is locally allocated (\c true) or not.
 		    //Indicates if _pred is locally allocated (true) or not.
 		    bool local_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    DistMap *_dist;
-		    ///Indicates if \ref _dist is locally allocated (\c true) or not.
 		    //Indicates if _dist is locally allocated (true) or not.
 		    bool local_dist;
-		    ///Pointer to the map of processed status of the nodes.
 		    //Pointer to the map of processed status of the nodes.
 		    ProcessedMap *_processed;
-		    ///Indicates if \ref _processed is locally allocated (\c true) or not.
 		    //Indicates if _processed is locally allocated (true) or not.
 		    bool local_processed;
-		    ///Pointer to the heap cross references.
 		    //Pointer to the heap cross references.
 		    HeapCrossRef *_heap_cross_ref;
-		    ///Indicates if \ref _heap_cross_ref is locally allocated (\c true) or not.
 		    //Indicates if _heap_cross_ref is locally allocated (true) or not.
 		    bool local_heap_cross_ref;
-		    ///Pointer to the heap.
 		    //Pointer to the heap.
 		    Heap *_heap;
-		    ///Indicates if \ref _heap is locally allocated (\c true) or not.
 		    //Indicates if _heap is locally allocated (true) or not.
 		    bool local_heap;
@@ -291,3 +299,2 @@
 		    ///Creates the maps if necessary.
 		    ///\todo Better memory allocation (instead of new).
@@ -333,6 +340,7 @@
 		    };
 		    ///\ref named-templ-param "Named parameter" for setting PredMap type
-		    ///\ref named-templ-param "Named parameter" for setting PredMap type
+		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref PredMap type.
 		    template <class T>
@@ -351,6 +359,7 @@
 		    };
 		    ///\ref named-templ-param "Named parameter" for setting DistMap type
-		    ///\ref named-templ-param "Named parameter" for setting DistMap type
+		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref DistMap type.
 		    template <class T>
@@ -364,3 +373,3 @@
 		      typedef T ProcessedMap;
-		      static ProcessedMap *createProcessedMap(const Digraph &G)
 		      static ProcessedMap *createProcessedMap(const Digraph &)
+		      {
@@ -369,6 +378,7 @@
 		    };
 		    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
-		    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
+		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type.
 		    template <class T>
@@ -381,13 +391,13 @@
 		      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
-		      static ProcessedMap *createProcessedMap(const Digraph &G)
+		      static ProcessedMap *createProcessedMap(const Digraph &g)
+		      {
-		        return new ProcessedMap(G);
+		        return new ProcessedMap(g);
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter"
 		    ///for setting the ProcessedMap type to be Digraph::NodeMap<bool>.
-		    ///If you don't set it explicitely, it will be automatically allocated.
+		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
 		    template <class T>
@@ -415,4 +425,3 @@
 		    ///\ref named-templ-param "Named parameter" for setting heap and cross
 		    ///reference type
 		    ///
 		    ///reference type.
 		    template <class H, class CR = typename Digraph::template NodeMap<int> >
@@ -455,6 +464,6 @@
 		    /// \brief \ref named-templ-param "Named parameter" for setting
 		    /// OperationTraits type
+		    ///\ref OperationTraits type
 		    ///
 		    /// \ref named-templ-param "Named parameter" for setting OperationTraits
 		    /// type
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///\ref OperationTraits type.
 		    template <class T>
@@ -468,3 +477,2 @@
 		  protected:
@@ -477,6 +485,7 @@
 		    ///\param _G the digraph the algorithm will run on.
 		    ///\param _length the length map used by the algorithm.
 		    Dijkstra(const Digraph& _G, const LengthMap& _length) :
 		      G(&_G), length(&_length),
 		    ///Constructor.
 		    ///\param _g The digraph the algorithm runs on.
 		    ///\param _length The length map used by the algorithm.
 		    Dijkstra(const Digraph& _g, const LengthMap& _length) :
 		      G(&_g), length(&_length),
 		      _pred(NULL), local_pred(false),
@@ -508,7 +517,7 @@
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
-		    ///Sets the map storing the predecessor arcs.
+		    ///Sets the map that stores the predecessor arcs.
 		    ///If you don't use this function before calling \ref run(),
-		    ///it will allocate one. The destuctor deallocates this
+		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
@@ -525,7 +534,25 @@
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that indicates which nodes are processed.
-		    ///Sets the map storing the distances calculated by the algorithm.
+		    ///Sets the map that indicates which nodes are processed.
 		    ///If you don't use this function before calling \ref run(),
-		    ///it will allocate one. The destuctor deallocates this
+		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
 		    ///\return <tt> (*this) </tt>
 		    Dijkstra &processedMap(ProcessedMap &m)
+		    {
 		      if(local_processed) {
 		        delete _processed;
 		        local_processed=false;
+		      }
 		      _processed = &m;
 		      return *this;
+		    }
 		    ///Sets the map that stores the distances of the nodes.
 		    ///Sets the map that stores the distances of the nodes calculated by the
 		    ///algorithm.
 		    ///If you don't use this function before calling \ref run(),
 		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated map, of course.
@@ -546,3 +573,3 @@
 		    ///If you don't use this function before calling \ref run(),
-		    ///it will allocate one. The destuctor deallocates this
+		    ///it will allocate one. The destructor deallocates this
 		    ///automatically allocated heap and cross reference, of course.
@@ -565,2 +592,3 @@
 		  private:
 		    void finalizeNodeData(Node v,Value dst)
@@ -573,13 +601,11 @@
 		    typedef PredMapPath<Digraph, PredMap> Path;
 		    ///\name Execution control
 		    ///The simplest way to execute the algorithm is to use
 		    ///one of the member functions called \c run(...).
 		    ///The simplest way to execute the algorithm is to use one of the
 		    ///member functions called \ref lemon::Dijkstra::run() "run()".
 		    ///\n
 		    ///If you need more control on the execution,
 		    ///first you must call \ref init(), then you can add several source nodes
 		    ///with \ref addSource().
 		    ///Finally \ref start() will perform the actual path
-		    ///computation.
+		    ///If you need more control on the execution, first you must call
 		    ///\ref lemon::Dijkstra::init() "init()", then you can add several
 		    ///source nodes with \ref lemon::Dijkstra::addSource() "addSource()".
 		    ///Finally \ref lemon::Dijkstra::start() "start()" will perform the
 		    ///actual path computation.
@@ -605,6 +631,5 @@
 		    ///Adds a new source node to the priority heap.
 		    ///
 		    ///The optional second parameter is the initial distance of the node.
 		    ///
-		    ///It checks if the node has already been added to the heap and
+		    ///The function checks if the node has already been added to the heap and
 		    ///it is pushed to the heap only if either it was not in the heap
@@ -627,3 +652,3 @@
 		    ///
-		    ///\warning The priority heap must not be empty!
+		    ///\warning The priority heap must not be empty.
 		    Node processNextNode()
@@ -658,9 +683,7 @@
-		    ///Next node to be processed.
+		    ///The next node to be processed.
 		    ///Next node to be processed.
 		    ///
 		    ///\return The next node to be processed or INVALID if the priority heap
 		    /// is empty.
-		    Node nextNode()
+		    ///Returns the next node to be processed or \c INVALID if the
 		    ///priority heap is empty.
 		    Node nextNode() const
+		    {
@@ -670,12 +693,13 @@
 		    ///\brief Returns \c false if there are nodes
-		    ///to be processed in the priority heap
+		    ///to be processed.
 		    ///
 		    ///Returns \c false if there are nodes
 		    ///to be processed in the priority heap
 		    bool emptyQueue() { return _heap->empty(); }
 		    ///to be processed in the priority heap.
 		    bool emptyQueue() const { return _heap->empty(); }
 		    ///Returns the number of the nodes to be processed in the priority heap
 		    ///Returns the number of the nodes to be processed in the priority heap
+		    ///Returns the number of the nodes to be processed in the priority heap.
 		    ///
 		    int queueSize() { return _heap->size(); }
+		    int queueSize() const { return _heap->size(); }
@@ -685,31 +709,36 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %Dijkstra algorithm from the root node(s)
 		    ///in order to compute the shortest path to each node.
 		    ///
 		    ///The algorithm computes
 		    ///- the shortest path tree (forest),
 		    ///- the distance of each node from the root(s).
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    ///
 		    ///\note <tt>d.start()</tt> is just a shortcut of the following code.
 		    ///\code
 		    ///  while ( !d.emptyQueue() ) {
 		    ///    d.processNextNode();
 		    ///  }
 		    ///\endcode
 		    void start()
+		    {
 		      while ( !emptyQueue() ) processNextNode();
+		    }
 		    ///Executes the algorithm until the given target node is reached.
 		    ///Executes the algorithm until the given target node is reached.
 		    ///
 		    ///This method runs the %Dijkstra algorithm from the root node(s)
 		    ///in order to
 		    ///compute the
 		    ///shortest path to each node. The algorithm computes
 		    ///- The shortest path tree.
-		    ///- The distance of each node from the root(s).
+		    ///in order to compute the shortest path to \c dest.
 		    ///
 		    void start()
+		    {
 		      while ( !_heap->empty() ) processNextNode();
+		    }
 		    ///Executes the algorithm until \c dest is reached.
 		    ///Executes the algorithm until \c dest is reached.
 		    ///The algorithm computes
 		    ///- the shortest path to \c dest,
 		    ///- the distance of \c dest from the root(s).
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///
 		    ///This method runs the %Dijkstra algorithm from the root node(s)
 		    ///in order to
 		    ///compute the
 		    ///shortest path to \c dest. The algorithm computes
 		    ///- The shortest path to \c  dest.
 		    ///- The distance of \c dest from the root(s).
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    void start(Node dest)
@@ -724,6 +753,7 @@
 		    ///
 		    ///\pre init() must be called and at least one node should be added
 		    ///with addSource() before using this function.
 		    ///This method runs the %Dijkstra algorithm from the root node(s) in
 		    ///order to compute the shortest path to a node \c v with
 		    /// <tt>nm[v]</tt> true, if such a node can be found.
 		    ///
-		    ///\param nm must be a bool (or convertible) node map. The algorithm
+		    ///\param nm A \c bool (or convertible) node map. The algorithm
 		    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
@@ -732,2 +762,5 @@
 		    ///\c INVALID if no such node was found.
 		    ///
 		    ///\pre init() must be called and at least one root node should be
 		    ///added with addSource() before using this function.
 		    template<class NodeBoolMap>
@@ -741,12 +774,12 @@
-		    ///Runs %Dijkstra algorithm from node \c s.
+		    ///Runs the algorithm from the given node.
 		    ///This method runs the %Dijkstra algorithm from a root node \c s
 		    ///in order to
 		    ///compute the
 		    ///shortest path to each node. The algorithm computes
 		    ///- The shortest path tree.
 		    ///- The distance of each node from the root.
 		    ///This method runs the %Dijkstra algorithm from node \c s
 		    ///in order to compute the shortest path to each node.
 		    ///
-		    ///\note d.run(s) is just a shortcut of the following code.
+		    ///The algorithm computes
 		    ///- the shortest path tree,
 		    ///- the distance of each node from the root.
 		    ///
 		    ///\note <tt>d.run(s)</tt> is just a shortcut of the following code.
 		    ///\code
@@ -764,8 +797,10 @@
-		    ///Finds the shortest path between \c s and \c t.
+		    ///This method runs the %Dijkstra algorithm from node \c s
 		    ///in order to compute the shortest path to \c t.
 		    ///
 		    ///\return The length of the shortest s---t path if there exists one,
 		    ///0 otherwise.
 		    ///\note Apart from the return value, d.run(s) is
 		    ///just a shortcut of the following code.
 		    ///\return The length of the shortest <tt>s</tt>--<tt>t</tt> path,
 		    ///if \c t is reachable form \c s, \c 0 otherwise.
 		    ///
 		    ///\note Apart from the return value, <tt>d.run(s,t)</tt> is just a
 		    ///shortcut of the following code.
 		    ///\code
@@ -787,4 +822,5 @@
 		    ///functions.\n
 		    ///Before the use of these functions,
 		    ///either run() or start() must be called.
 		    ///Either \ref lemon::Dijkstra::run() "run()" or
 		    ///\ref lemon::Dijkstra::start() "start()" must be called before
 		    ///using them.
@@ -792,44 +828,48 @@
-		    ///Gives back the shortest path.
+		    ///The shortest path to a node.
 		    ///Gives back the shortest path.
 		    ///\pre The \c t should be reachable from the source.
 		    Path path(Node t)
+		    {
 		      return Path(*G, *_pred, t);
+		    }
 		    ///Returns the shortest path to a node.
 		    ///
 		    ///\warning \c t should be reachable from the root(s).
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Path path(Node t) const { return Path(*G, *_pred, t); }
 		    ///The distance of a node from the root.
+		    ///The distance of a node from the root(s).
 		    ///Returns the distance of a node from the root.
 		    ///\pre \ref run() must be called before using this function.
 		    ///\warning If node \c v in unreachable from the root the return value
 		    ///of this funcion is undefined.
 		    ///Returns the distance of a node from the root(s).
 		    ///
 		    ///\warning If node \c v is not reachable from the root(s), then
 		    ///the return value of this function is undefined.
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Value dist(Node v) const { return (*_dist)[v]; }
-		    ///The current distance of a node from the root.
+		    ///Returns the 'previous arc' of the shortest path tree for a node.
 		    ///Returns the current distance of a node from the root.
 		    ///It may be decreased in the following processes.
 		    ///\pre \c node should be reached but not processed
 		    Value currentDist(Node v) const { return (*_heap)[v]; }
 		    ///Returns the 'previous arc' of the shortest path tree.
 		    ///For a node \c v it returns the 'previous arc' of the shortest path tree,
 		    ///i.e. it returns the last arc of a shortest path from the root to \c
 		    ///v. It is \ref INVALID
 		    ///if \c v is unreachable from the root or if \c v=s. The
 		    ///shortest path tree used here is equal to the shortest path tree used in
 		    ///\ref predNode().  \pre \ref run() must be called before using
 		    ///this function.
 		    ///This function returns the 'previous arc' of the shortest path
 		    ///tree for the node \c v, i.e. it returns the last arc of a
 		    ///shortest path from the root(s) to \c v. It is \c INVALID if \c v
 		    ///is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The shortest path tree used here is equal to the shortest path
 		    ///tree used in \ref predNode().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
 		    Arc predArc(Node v) const { return (*_pred)[v]; }
 		    ///Returns the 'previous node' of the shortest path tree.
+		    ///Returns the 'previous node' of the shortest path tree for a node.
 		    ///For a node \c v it returns the 'previous node' of the shortest path tree,
 		    ///i.e. it returns the last but one node from a shortest path from the
 		    ///root to \c /v. It is INVALID if \c v is unreachable from the root or if
 		    ///\c v=s. The shortest path tree used here is equal to the shortest path
-		    ///tree used in \ref predArc().  \pre \ref run() must be called before
+		    ///This function returns the 'previous node' of the shortest path
 		    ///tree for the node \c v, i.e. it returns the last but one node
 		    ///from a shortest path from the root(s) to \c v. It is \c INVALID
 		    ///if \c v is not reachable from the root(s) or if \c v is a root.
 		    ///
 		    ///The shortest path tree used here is equal to the shortest path
 		    ///tree used in \ref predArc().
 		    ///
 		    ///\pre Either \ref run() or \ref start() must be called before
 		    ///using this function.
@@ -838,22 +878,29 @@
 		    ///Returns a reference to the NodeMap of distances.
 		    ///Returns a reference to the NodeMap of distances. \pre \ref run() must
 		    ///be called before using this function.
 		    ///\brief Returns a const reference to the node map that stores the
 		    ///distances of the nodes.
 		    ///
 		    ///Returns a const reference to the node map that stores the distances
 		    ///of the nodes calculated by the algorithm.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
 		    ///must be called before using this function.
 		    const DistMap &distMap() const { return *_dist;}
 		    ///Returns a reference to the shortest path tree map.
 		    ///Returns a reference to the NodeMap of the arcs of the
 		    ///shortest path tree.
-		    ///\pre \ref run() must be called before using this function.
+		    ///\brief Returns a const reference to the node map that stores the
 		    ///predecessor arcs.
 		    ///
 		    ///Returns a const reference to the node map that stores the predecessor
 		    ///arcs, which form the shortest path tree.
 		    ///
 		    ///\pre Either \ref run() or \ref init()
 		    ///must be called before using this function.
 		    const PredMap &predMap() const { return *_pred;}
 		    ///Checks if a node is reachable from the root.
+		    ///Checks if a node is reachable from the root(s).
 		    ///Returns \c true if \c v is reachable from the root.
 		    ///\warning The source nodes are inditated as unreached.
 		    ///\pre \ref run() must be called before using this function.
 		    ///
-		    bool reached(Node v) { return (*_heap_cross_ref)[v] != Heap::PRE_HEAP; }
+		    ///Returns \c true if \c v is reachable from the root(s).
 		    ///\pre Either \ref run() or \ref start()
 		    ///must be called before using this function.
 		    bool reached(Node v) const { return (*_heap_cross_ref)[v] !=
 		                                        Heap::PRE_HEAP; }
@@ -863,5 +910,13 @@
 		    ///path to \c v has already found.
 		    ///\pre \ref run() must be called before using this function.
 		    ///
-		    bool processed(Node v) { return (*_heap_cross_ref)[v] == Heap::POST_HEAP; }
+		    ///\pre Either \ref run() or \ref start()
 		    ///must be called before using this function.
 		    bool processed(Node v) const { return (*_heap_cross_ref)[v] ==
 		                                          Heap::POST_HEAP; }
 		    ///The current distance of a node from the root(s).
 		    ///Returns the current distance of a node from the root(s).
 		    ///It may be decreased in the following processes.
 		    ///\pre \c v should be reached but not processed.
 		    Value currentDist(Node v) const { return (*_heap)[v]; }
@@ -871,10 +926,7 @@
 		  ///Default traits class of dijkstra() function.
 		  ///Default traits class of Dijkstra function.
 		  ///Default traits class of Dijkstra function.
 		  ///\tparam GR Digraph type.
-		  ///\tparam LM Type of length map.
+		  ///Default traits class of dijkstra() function.
 		  ///\tparam GR The type of the digraph.
 		  ///\tparam LM The type of the length map.
 		  template<class GR, class LM>
@@ -882,3 +934,3 @@
+		  {
-		    ///The digraph type the algorithm runs on.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef GR Digraph;
@@ -889,30 +941,30 @@
 		    typedef LM LengthMap;
 		    //The type of the length of the arcs.
+		    ///The type of the length of the arcs.
 		    typedef typename LM::Value Value;
 		    /// Operation traits for Dijkstra algorithm.
-		    /// It defines the used operation by the algorithm.
+		    /// This class defines the operations that are used in the algorithm.
 		    /// \see DijkstraDefaultOperationTraits
 		    typedef DijkstraDefaultOperationTraits<Value> OperationTraits;
 		    ///The heap type used by Dijkstra algorithm.
 		    /// The cross reference type used by heap.
+		    /// The cross reference type used by the heap.
 		    /// The cross reference type used by heap.
+		    /// The cross reference type used by the heap.
 		    /// Usually it is \c Digraph::NodeMap<int>.
 		    typedef typename Digraph::template NodeMap<int> HeapCrossRef;
 		    ///Instantiates a HeapCrossRef.
+		    ///Instantiates a \ref HeapCrossRef.
 		    ///This function instantiates a \ref HeapCrossRef.
-		    /// \param G is the digraph, to which we would like to define the
+		    /// \param g is the digraph, to which we would like to define the
 		    /// HeapCrossRef.
 		    /// \todo The digraph alone may be insufficient for the initialization
-		    static HeapCrossRef *createHeapCrossRef(const GR &G)
+		    static HeapCrossRef *createHeapCrossRef(const Digraph &g)
+		    {
-		      return new HeapCrossRef(G);
+		      return new HeapCrossRef(g);
+		    }
 		    ///The heap type used by Dijkstra algorithm.
+		    ///The heap type used by the Dijkstra algorithm.
 		    ///The heap type used by Dijkstra algorithm.
+		    ///The heap type used by the Dijkstra algorithm.
 		    ///
@@ -920,27 +972,31 @@
 		    ///\sa Dijkstra
-		    typedef BinHeap<typename LM::Value, typename GR::template NodeMap<int>,
+		    typedef BinHeap<Value, typename Digraph::template NodeMap<int>,
 		                    std::less<Value> > Heap;
-		    static Heap *createHeap(HeapCrossRef& R)
+		    ///Instantiates a \ref Heap.
 		    ///This function instantiates a \ref Heap.
 		    /// \param r is the HeapCrossRef which is used.
 		    static Heap *createHeap(HeapCrossRef& r)
+		    {
-		      return new Heap(R);
+		      return new Heap(r);
+		    }
-		    ///\brief The type of the map that stores the last
+		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///
-		    ///The type of the map that stores the last
+		    ///The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef NullMap <typename GR::Node,typename GR::Arc> PredMap;
-		    ///Instantiates a PredMap.
+		    typedef NullMap <typename Digraph::Node,typename Digraph::Arc> PredMap;
 		    ///Instantiates a \ref PredMap.
 		    ///This function instantiates a \ref PredMap.
 		    ///\param g is the digraph, to which we would like to define the PredMap.
 		    ///\todo The digraph alone may be insufficient for the initialization
 		    ///\param g is the digraph, to which we would like to define the
 		    ///\ref PredMap.
 		    ///\todo The digraph alone may be insufficient to initialize
 		#ifdef DOXYGEN
-		    static PredMap *createPredMap(const GR &g)
+		    static PredMap *createPredMap(const Digraph &g)
 		#else
-		    static PredMap *createPredMap(const GR &)
+		    static PredMap *createPredMap(const Digraph &)
 		#endif
@@ -949,5 +1005,6 @@
+		    }
 		    ///The type of the map that stores whether a nodes is processed.
-		    ///The type of the map that stores whether a nodes is processed.
+		    ///The type of the map that indicates which nodes are processed.
 		    ///The type of the map that indicates which nodes are processed.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -958,3 +1015,3 @@
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \ref ProcessedMap.
@@ -962,7 +1019,7 @@
 		    ///\param g is the digraph, to which
 		    ///we would like to define the \ref ProcessedMap
+		    ///we would like to define the \ref ProcessedMap.
 		#ifdef DOXYGEN
-		    static ProcessedMap *createProcessedMap(const GR &g)
+		    static ProcessedMap *createProcessedMap(const Digraph &g)
 		#else
-		    static ProcessedMap *createProcessedMap(const GR &)
+		    static ProcessedMap *createProcessedMap(const Digraph &)
 		#endif
@@ -971,9 +1028,9 @@
+		    }
 		    ///The type of the map that stores the dists of the nodes.
-		    ///The type of the map that stores the dists of the nodes.
+		    ///The type of the map that stores the distances of the nodes.
 		    ///The type of the map that stores the distances of the nodes.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///
 		    typedef NullMap<typename Digraph::Node,typename LM::Value> DistMap;
-		    ///Instantiates a DistMap.
+		    typedef NullMap<typename Digraph::Node,Value> DistMap;
 		    ///Instantiates a \ref DistMap.
@@ -983,5 +1040,5 @@
 		#ifdef DOXYGEN
-		    static DistMap *createDistMap(const GR &g)
+		    static DistMap *createDistMap(const Digraph &g)
 		#else
-		    static DistMap *createDistMap(const GR &)
+		    static DistMap *createDistMap(const Digraph &)
 		#endif
@@ -992,3 +1049,3 @@
 		  /// Default traits used by \ref DijkstraWizard
+		  /// Default traits class used by \ref DijkstraWizard
@@ -1004,17 +1061,16 @@
+		  {
 		    typedef DijkstraWizardDefaultTraits<GR,LM> Base;
 		  protected:
-		    /// Type of the nodes in the digraph.
+		    //The type of the nodes in the digraph.
 		    typedef typename Base::Digraph::Node Node;
-		    /// Pointer to the underlying digraph.
+		    //Pointer to the digraph the algorithm runs on.
 		    void *_g;
-		    /// Pointer to the length map
 		    //Pointer to the length map
 		    void *_length;
-		    ///Pointer to the map of predecessors arcs.
 		    //Pointer to the map of predecessors arcs.
 		    void *_pred;
-		    ///Pointer to the map of distances.
 		    //Pointer to the map of distances.
 		    void *_dist;
-		    ///Pointer to the source node.
 		    //Pointer to the source node.
 		    Node _source;
@@ -1034,5 +1090,5 @@
 		    /// Others are initiated to 0.
 		    /// \param g is the initial value of  \ref _g
 		    /// \param l is the initial value of  \ref _length
-		    /// \param s is the initial value of  \ref _source
+		    /// \param g The digraph the algorithm runs on.
 		    /// \param l The length map.
 		    /// \param s The source node.
 		    DijkstraWizardBase(const GR &g,const LM &l, Node s=INVALID) :
@@ -1044,7 +1100,9 @@
-		  /// A class to make the usage of Dijkstra algorithm easier
+		  /// Auxiliary class for the function type interface of Dijkstra algorithm.
 		  /// This class is created to make it easier to use Dijkstra algorithm.
 		  /// It uses the functions and features of the plain \ref Dijkstra,
-		  /// but it is much simpler to use it.
+		  /// This auxiliary class is created to implement the function type
 		  /// interface of \ref Dijkstra algorithm. It uses the functions and features
 		  /// of the plain \ref Dijkstra, but it is much simpler to use it.
 		  /// It should only be used through the \ref dijkstra() function, which makes
 		  /// it easier to use the algorithm.
 		  ///
@@ -1057,8 +1115,8 @@
 		  /// operator. In the case of \ref DijkstraWizard only
 		  /// a function have to be called and it will
+		  /// a function have to be called, and it will
 		  /// return the needed class.
 		  ///
 		  /// It does not have own \ref run method. When its \ref run method is called
 		  /// it initiates a plain \ref Dijkstra class, and calls the \ref
-		  /// Dijkstra::run method of it.
+		  /// It does not have own \ref run() method. When its \ref run() method
 		  /// is called, it initiates a plain \ref Dijkstra object, and calls the
 		  /// \ref Dijkstra::run() method of it.
 		  template<class TR>
@@ -1068,11 +1126,8 @@
-		    ///The type of the underlying digraph.
+		    ///The type of the digraph the algorithm runs on.
 		    typedef typename TR::Digraph Digraph;
-		    //\e
 		    typedef typename Digraph::Node Node;
 		    //\e
 		    typedef typename Digraph::NodeIt NodeIt;
 		    //\e
 		    typedef typename Digraph::Arc Arc;
 		    //\e
 		    typedef typename Digraph::OutArcIt OutArcIt;
@@ -1083,10 +1138,14 @@
 		    typedef typename LengthMap::Value Value;
-		    ///\brief The type of the map that stores the last
+		    ///\brief The type of the map that stores the predecessor
 		    ///arcs of the shortest paths.
 		    typedef typename TR::PredMap PredMap;
-		    ///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;
 		    ///The type of the map that indicates which nodes are processed.
 		    typedef typename TR::ProcessedMap ProcessedMap;
 		    ///The heap type used by the dijkstra algorithm.
 		    typedef typename TR::Heap Heap;
 		  public:
 		    /// Constructor.
@@ -1106,6 +1165,6 @@
-		    ///Runs Dijkstra algorithm from a given node.
+		    ///Runs Dijkstra algorithm from a source node.
 		    ///Runs Dijkstra algorithm from a given node.
 		    ///The node can be given by the \ref source function.
 		    ///Runs Dijkstra algorithm from a source node.
 		    ///The node can be given with the \ref source() function.
 		    void run()
@@ -1131,2 +1190,12 @@
 		    /// Sets the source node, from which the Dijkstra algorithm runs.
 		    /// Sets the source node, from which the Dijkstra algorithm runs.
 		    /// \param s is the source node.
 		    DijkstraWizard<TR> &source(Node s)
+		    {
 		      Base::_source=s;
 		      return *this;
+		    }
 		    template<class T>
@@ -1137,9 +1206,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting PredMap type
+		    ///for setting \ref PredMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting PredMap type
 		    ///
 		    ///for setting \ref PredMap object.
 		    template<class T>
@@ -1152,2 +1219,20 @@
 		    template<class T>
 		    struct DefProcessedMapBase : public Base {
 		      typedef T ProcessedMap;
 		      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
 		      DefProcessedMapBase(const TR &b) : TR(b) {}
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
 		    ///for setting \ref ProcessedMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///for setting \ref ProcessedMap object.
 		    template<class T>
 		    DijkstraWizard<DefProcessedMapBase<T> > processedMap(const T &t)
+		    {
 		      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
 		      return DijkstraWizard<DefProcessedMapBase<T> >(*this);
+		    }
 		    template<class T>
 		    struct DefDistMapBase : public Base {
@@ -1157,9 +1242,7 @@
 		    };
 		    ///\brief \ref named-templ-param "Named parameter"
-		    ///function for setting DistMap type
+		    ///for setting \ref DistMap object.
 		    ///
 		    /// \ref named-templ-param "Named parameter"
 		    ///function for setting DistMap type
 		    ///
 		    ///for setting \ref DistMap object.
 		    template<class T>
@@ -1171,12 +1254,2 @@
 		    /// Sets the source node, from which the Dijkstra algorithm runs.
 		    /// Sets the source node, from which the Dijkstra algorithm runs.
 		    /// \param s is the source node.
 		    DijkstraWizard<TR> &source(Node s)
+		    {
 		      Base::_source=s;
 		      return *this;
+		    }
 		  };

0 comments (0 inline)

RhodeCode

Login to your account