[Lemon-commits] [lemon_svn] alpar: r326 - hugo/trunk/src/work/alpar/dijkstra

[Lemon SVN]

Author: alpar
Date: Mon Mar 22 11:21:30 2004
New Revision: 326

Modified:
   hugo/trunk/src/work/alpar/dijkstra/dijkstra.h

Log:
DocFix


Modified: hugo/trunk/src/work/alpar/dijkstra/dijkstra.h
==============================================================================
--- hugo/trunk/src/work/alpar/dijkstra/dijkstra.h	(original)
+++ hugo/trunk/src/work/alpar/dijkstra/dijkstra.h	Mon Mar 22 11:21:30 2004
@@ -34,9 +34,9 @@
   
   //Alpar: Changed the order of the parameters
   
-  ///Dijkstra algorithm class.
+  ///%Dijkstra algorithm class.
 
-  ///This class provides an efficient implementation of Dijkstra algorithm.
+  ///This class provides an efficient implementation of %Dijkstra algorithm.
   ///The edge lengths are passed to the algorithm using a
   ///\ref ReadMapSkeleton "readable map",
   ///so it is easy to change it to any kind of length.
@@ -50,7 +50,7 @@
   ///lengths of the edges. It is read once for each edge, so the map
   ///may involve in relatively time consuming process to compute the edge
   ///length if it is necessary.
-  ///\param Heap The heap type used by the Dijkstra
+  ///\param Heap The heap type used by the %Dijkstra
   ///algorithm. The default
   ///is using \ref BinHeap "binary heap".
   template <typename Graph,
@@ -97,19 +97,21 @@
 
     ///Returns the distance of a node from the source.
     ///\pre \ref run() must be called before using this function.
-    ///\warning If node \c v in unreachable from \c s the return value
+    ///\warning If node \c v in unreachable from the source the return value
     ///of this funcion is undefined.
     ValueType dist(Node v) const { return distance[v]; }
     ///Returns the edges of the shortest path tree.
 
     ///For a node \c v it returns the last edge of the shortest path
-    ///from \c s to \c v or INVALID if \c v is unreachable from \c s.
+    ///from the source to \c v or INVALID if \c v is unreachable
+    ///from the source.
     ///\pre \ref run() must be called before using this function.
     Edge pred(Node v) const { return predecessor[v]; }
     ///Returns the nodes of the shortest paths.
 
     ///For a node \c v it returns the last but one node of the shortest path
-    ///from \c s to \c v or INVALID if \c v is unreachable from \c s.
+    ///from the source to \c v or INVALID if \c v is unreachable
+    ///from the source.
     ///\pre \ref run() must be called before using this function.
     Node predNode(Node v) const { return pred_node[v]; }
     
@@ -133,10 +135,10 @@
 
     //    bool reached(Node v) { return reach[v]; }
 
-    ///Chech if a node is reachable from \c s.
+    ///Chechs if a node is reachable from the source.
 
-    ///Returns \c true if \c v is reachable from \c s.
-    ///\warning \c s is reported to be unreached!
+    ///Returns \c true if \c v is reachable from the source.
+    ///\warning the source node is reported to be unreached!
     ///\todo Is this what we want?
     ///\pre \ref run() must be called before using this function.
     ///
@@ -149,13 +151,14 @@
   //  IMPLEMENTATIONS
   // **********************************************************************
 
-  ///Runs Dijkstra algorithm from node \c s.
+  ///Runs %Dijkstra algorithm from node the source.
 
-  ///This method runs the Dijkstra algorithm from node \c s in order to
+  ///This method runs the %Dijkstra algorithm from a source 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.
+  ///- The distance of each node from the source.
   template <typename Graph, typename LengthMap, typename Heap >
   void Dijkstra<Graph,LengthMap,Heap>::run(Node s) {