Changeset 802:bc0c74eeb151 in lemon-0.x for src/hugo/dijkstra.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/dijkstra.h (modified) (8 diffs)

src/hugo/dijkstra.h

@@ -56 +56 @@
     ///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;
     
@@ -75 +79 @@
 
   private:
+    /// Pointer to the underlying graph.
     const Graph *G;
+    /// Pointer to the length map
     const LM *length;
-    //    bool local_length;
+    ///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;
 
@@ -94 +105 @@
     void init_maps() 
     {
-//       if(!length) {
-//      local_length = true;
-//      length = new LM(G);
-//       }
       if(!predecessor) {
         local_predecessor = true;
@@ -113 +120 @@
     
   public :
-    
+    ///Constructor.
+    
+    ///\param _G the graph the algorithm will run on.
+    ///\param _length the length map used by the algorithm.
     Dijkstra(const Graph& _G, const LM& _length) :
       G(&_G), length(&_length),
@@ -121 +131 @@
     { }
     
+    ///Destructor.
     ~Dijkstra() 
     {
-      //      if(local_length) delete length;
       if(local_predecessor) delete predecessor;
       if(local_pred_node) delete pred_node;
@@ -129 +139 @@
     }
 
-    ///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
-    Dijkstra &setGraph(const Graph &_G) 
-    {
-      G = &_G;
-      return *this;
-    }
     ///Sets the length map.
 
@@ -146 +145 @@
     Dijkstra &setLengthMap(const LM &m) 
     {
-//       if(local_length) {
-//      delete length;
-//      local_length=false;
-//       }
       length = &m;
       return *this;
@@ -318 +313 @@
 
     ///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.
     ///