Changeset 802:bc0c74eeb151 in lemon-0.x for src/hugo/bfs.h

Timestamp:

09/05/04 22:11:47 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

• Changes in doc
• setGraph(...) finally removed from Dijkstra, Bfs and Dfs.

File:

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

src/hugo/bfs.h

@@ -35 +35 @@
     ///The type of the underlying graph.
     typedef GR Graph;
+    ///.
     typedef typename Graph::Node Node;
+    ///.
     typedef typename Graph::NodeIt NodeIt;
+    ///.
     typedef typename Graph::Edge Edge;
+    ///.
     typedef typename Graph::OutEdgeIt OutEdgeIt;
     
@@ -50 +54 @@
 
   private:
+    /// Pointer to the underlying graph.
     const Graph *G;
+    ///Pointer to the map of predecessors edges.
     PredMap *predecessor;
+    ///Indicates if \ref predecessor is locally allocated (\c true) or not.
     bool local_predecessor;
+    ///Pointer to the map of predecessors nodes.
     PredNodeMap *pred_node;
+    ///Indicates if \ref pred_node is locally allocated (\c true) or not.
     bool local_pred_node;
+    ///Pointer to the map of distances.
     DistMap *distance;
+    ///Indicates if \ref distance is locally allocated (\c true) or not.
     bool local_distance;
 
-    //The source node of the last execution.
+    ///The source node of the last execution.
     Node source;
 
@@ -80 +91 @@
     
   public :    
+    ///Constructor.
+    
+    ///\param _G the graph the algorithm will run on.
     Bfs(const Graph& _G) :
       G(&_G),
@@ -87 +101 @@
     { }
     
+    ///Destructor.
     ~Bfs() 
     {
@@ -94 +109 @@
     }
 
-    ///Sets the graph the algorithm will run on.
-
-    ///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) 
-    {
-      G = &_G;
-      return *this;
-    }
     ///Sets the map storing the predecessor edges.
 
@@ -250 +254 @@
 
     ///Returns \c true if \c v is reachable from the root.
-    ///\warning The root node is reported to be reached!
+    ///\note The root node is reported to be reached!
     ///
     ///\pre \ref run() must be called before using this function.