Changeset 781:d4d182ab75bd in lemon-0.x for src/hugo/bfs.h

Timestamp:

09/01/04 17:37:36 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1074

Message:

Changes in the doc.

File:

• src/hugo/bfs.h (modified) (9 diffs)

src/hugo/bfs.h

@@ -17 +17 @@
 /// @{
 
-  ///%Bfs algorithm class.
-
-  ///This class provides an efficient implementation of %Bfs 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.
+  ///%BFS algorithm class.
+
+  ///This class provides an efficient implementation of %BFS algorithm.
+  ///\param GR The graph type the algorithm runs on.
+  ///This class does the same as Dijkstra does with constant 1 edge length,
+  ///but it is faster.
   ///
-  ///The type of the length is determined by the \c ValueType of the length map.
-  ///
-  ///It is also possible to change the underlying priority heap.
-  ///
-  ///\param GR The graph type the algorithm runs on.
-  ///\param LM This read-only
-  ///EdgeMap
-  ///determines the
-  ///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. The default map type is
-  ///\ref GraphSkeleton::EdgeMap "Graph::EdgeMap<int>"
-  ///\param Heap The heap type used by the %Bfs
-  ///algorithm. The default
-  ///is using \ref BinHeap "binary heap".
-  ///
-  ///\author Jacint Szabo and Alpar Juttner
-  ///\todo We need a typedef-names should be standardized. (-:
-  ///\todo Type of \c PredMap, \c PredNodeMap and \c DistMap
-  ///should not be fixed. (Problematic to solve).
+  ///\author Alpar Juttner
 
 #ifdef DOXYGEN
@@ -81 +62 @@
 
 
-    ///Initialize maps.
-    
-    ///\todo Error if \c G or are \c NULL.
-    ///\todo Better memory allocation (instead of new).
+    ///Initializes the maps.
     void init_maps() 
     {
-//       if(!length) {
-//      local_length = true;
-//      length = new LM(G);
-//       }
       if(!predecessor) {
         local_predecessor = true;
@@ -115 +89 @@
     ~Bfs() 
     {
-      //      if(local_length) delete length;
       if(local_predecessor) delete predecessor;
       if(local_pred_node) delete pred_node;
@@ -125 +98 @@
     ///Sets the graph the algorithm will run on.
     ///\return <tt> (*this) </tt>
+    ///\bug What about maps?
+    ///\todo It may be unnecessary
     Bfs &setGraph(const Graph &_G) 
     {
@@ -130 +105 @@
       return *this;
     }
-    ///Sets the length map.
-
     ///Sets the map storing the predecessor edges.
 
@@ -187 +160 @@
   ///This method runs the %BFS algorithm from a root node \c s
   ///in order to
-  ///compute the
+  ///compute a
   ///shortest path to each node. The algorithm computes
-  ///- The shortest path tree.
+  ///- The %BFS tree.
   ///- The distance of each node from the root.
  
@@ -233 +206 @@
     int dist(Node v) const { return (*distance)[v]; }
 
-    ///Returns the 'previous edge' of the shortest path tree.
-
-    ///For a node \c v it returns the 'previous edge' of the shortest path tree,
-    ///i.e. it returns the last edge from a shortest path from the root to \c
+    ///Returns the 'previous edge' of the %BFS path tree.
+
+    ///For a node \c v it returns the 'previous edge' of the %BFS tree,
+    ///i.e. it returns the last edge 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
+    ///%BFS tree used here is equal to the %BFS tree used in
     ///\ref predNode(Node v).  \pre \ref run() must be called before using
     ///this function.
     Edge pred(Node v) const { return (*predecessor)[v]; }
 
-    ///Returns the 'previous node' of the shortest path tree.
-
-    ///For a node \c v it returns the 'previous node' of the shortest path tree,
+    ///Returns the 'previous node' of the %BFS tree.
+
+    ///For a node \c v it returns the 'previous node' on the %BFS 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
+    ///\c v=s. The shortest path tree used here is equal to the %BFS
     ///tree used in \ref pred(Node v).  \pre \ref run() must be called before
     ///using this function.
@@ -260 +233 @@
     const DistMap &distMap() const { return *distance;}
  
-    ///Returns a reference to the shortest path tree map.
+    ///Returns a reference to the %BFS tree map.
 
     ///Returns a reference to the NodeMap of the edges of the
-    ///shortest path tree.
+    ///%BFS tree.
     ///\pre \ref run() must be called before using this function.
     const PredMap &predMap() const { return *predecessor;}
  
-    ///Returns a reference to the map of nodes of shortest paths.
-
-    ///Returns a reference to the NodeMap of the last but one nodes of the
-    ///shortest path tree.
+    ///Returns a reference to the map of last but one nodes of shortest paths.
+
+    ///Returns a reference to the NodeMap of the last but one nodes on the
+    ///%BFS tree.
     ///\pre \ref run() must be called before using this function.
     const PredNodeMap &predNodeMap() const { return *pred_node;}
@@ -285 +258 @@
   };
   
-
-  // **********************************************************************
-  //  IMPLEMENTATIONS
-  // **********************************************************************
-
 /// @}