[Lemon-commits] [lemon_svn] deba: r2297 - hugo/trunk/lemon

[Lemon SVN]

Author: deba
Date: Fri Nov  4 16:00:19 2005
New Revision: 2297

Modified:
   hugo/trunk/lemon/belmann_ford.h
   hugo/trunk/lemon/bfs.h
   hugo/trunk/lemon/dfs.h
   hugo/trunk/lemon/dijkstra.h
   hugo/trunk/lemon/floyd_warshall.h
   hugo/trunk/lemon/johnson.h

Log:
Removing todos



Modified: hugo/trunk/lemon/belmann_ford.h
==============================================================================
--- hugo/trunk/lemon/belmann_ford.h	(original)
+++ hugo/trunk/lemon/belmann_ford.h	Fri Nov  4 16:00:19 2005
@@ -21,7 +21,6 @@
 /// \file
 /// \brief BelmannFord algorithm.
 ///
-/// \todo getPath() should be implemented! (also for BFS and DFS)
 
 #include <lemon/list_graph.h>
 #include <lemon/invalid.h>
@@ -494,7 +493,7 @@
     /// This function copies the shortest path to \c t into \c p.
     /// If it \c t is a source itself or unreachable, then it does not
     /// alter \c p.
-    /// \todo Is it the right way to handle unreachable nodes?
+    ///
     /// \return Returns \c true if a path to \c t was actually copied to \c p,
     /// \c false otherwise.
     /// \sa DirPath
@@ -528,7 +527,6 @@
     /// path tree used in \ref predNode(). 
     /// \pre \ref run() must be called before using
     /// this function.
-    /// \todo predEdge could be a better name.
     Edge predEdge(Node v) const { return (*_pred)[v]; }
 
     /// \brief Returns the 'previous node' of the shortest path tree.

Modified: hugo/trunk/lemon/bfs.h
==============================================================================
--- hugo/trunk/lemon/bfs.h	(original)
+++ hugo/trunk/lemon/bfs.h	Fri Nov  4 16:00:19 2005
@@ -192,7 +192,6 @@
 
     ///Creates the maps if necessary.
     
-    ///\todo Error if \c G are \c NULL.
     ///\todo Better memory allocation (instead of new).
     void create_maps() 
     {
@@ -610,7 +609,6 @@
     ///This function copies the shortest path to \c t into \c p.
     ///If \c t is a source itself or unreachable, then it does not
     ///alter \c p.
-    ///\todo Is it the right way to handle unreachable nodes?
     ///\return Returns \c true if a path to \c t was actually copied to \c p,
     ///\c false otherwise.
     ///\sa DirPath
@@ -647,7 +645,6 @@
     ///\ref predNode().
     ///\pre Either \ref run() or \ref start() must be called before using
     ///this function.
-    ///\todo predEdge could be a better name.
     Edge predEdge(Node v) const { return (*_pred)[v];}
 
     ///Returns the 'previous node' of the shortest path tree.

Modified: hugo/trunk/lemon/dfs.h
==============================================================================
--- hugo/trunk/lemon/dfs.h	(original)
+++ hugo/trunk/lemon/dfs.h	Fri Nov  4 16:00:19 2005
@@ -192,7 +192,6 @@
 
     ///Creates the maps if necessary.
     
-    ///\todo Error if \c G are \c NULL.
     ///\todo Better memory allocation (instead of new).
     void create_maps() 
     {
@@ -508,14 +507,10 @@
     ///
     ///Returns \c false if there are nodes
     ///to be processed in the queue
-    ///
-    ///\todo This should be called emptyStack() or some "neutral" name.
     bool emptyQueue() { 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.
-    ///
-    ///\todo This should be called stackSize() or some "neutral" name.
     int queueSize() { return _stack_head+1; }
     
     ///Executes the algorithm.
@@ -631,7 +626,6 @@
     ///This function copies the path to \c t on the DFS tree  into \c p.
     ///If \c t is a source itself or unreachable, then it does not
     ///alter \c p.
-    ///\todo Is this the right way to handle unreachable nodes?
     ///
     ///\return Returns \c true if a path to \c t was actually copied to \c p,
     ///\c false otherwise.
@@ -669,7 +663,6 @@
     ///\ref predNode().
     ///\pre Either \ref run() or \ref start() must be called before using
     ///this function.
-    ///\todo predEdge could be a better name.
     Edge predEdge(Node v) const { return (*_pred)[v];}
 
     ///Returns the 'previous node' of the %DFS tree.
@@ -1381,15 +1374,11 @@
     ///
     /// Returns \c false if there are nodes
     /// to be processed in the queue
-    ///
-    /// \todo This should be called emptyStack() or some "neutral" name.
     bool emptyQueue() { return _stack_head < 0; }
 
     /// \brief Returns the number of the nodes to be processed.
     ///
     /// Returns the number of the nodes to be processed in the queue.
-    ///
-    ///\todo This should be called stackSize() or some "neutral" name.
     int queueSize() { return _stack_head + 1; }
     
     /// \brief Executes the algorithm.

Modified: hugo/trunk/lemon/dijkstra.h
==============================================================================
--- hugo/trunk/lemon/dijkstra.h	(original)
+++ hugo/trunk/lemon/dijkstra.h	Fri Nov  4 16:00:19 2005
@@ -21,7 +21,6 @@
 ///\file
 ///\brief Dijkstra algorithm.
 ///
-///\todo getPath() should be implemented! (also for BFS and DFS)
 ///\todo dijkstraZero() solution should be revised.
 
 #include <lemon/list_graph.h>
@@ -246,7 +245,6 @@
 
     ///Creates the maps if necessary.
     
-    ///\todo Error if \c G or are \c NULL. What about \c length?
     ///\todo Better memory allocation (instead of new).
     void create_maps() 
     {
@@ -723,7 +721,6 @@
     ///This function copies the shortest path to \c t into \c p.
     ///If it \c t is a source itself or unreachable, then it does not
     ///alter \c p.
-    ///\todo Is it the right way to handle unreachable nodes?
     ///\return Returns \c true if a path to \c t was actually copied to \c p,
     ///\c false otherwise.
     ///\sa DirPath
@@ -758,7 +755,6 @@
     ///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.
-    ///\todo predEdge could be a better name.
     Edge predEdge(Node v) const { return (*_pred)[v]; }
 
     ///Returns the 'previous node' of the shortest path tree.

Modified: hugo/trunk/lemon/floyd_warshall.h
==============================================================================
--- hugo/trunk/lemon/floyd_warshall.h	(original)
+++ hugo/trunk/lemon/floyd_warshall.h	Fri Nov  4 16:00:19 2005
@@ -21,7 +21,6 @@
 /// \file
 /// \brief FloydWarshall algorithm.
 ///
-/// \todo getPath() should be implemented! (also for BFS and DFS)
 
 #include <lemon/list_graph.h>
 #include <lemon/graph_utils.h>
@@ -479,7 +478,6 @@
     /// This function copies the shortest path to \c t into \c p.
     /// If it \c t is a source itself or unreachable, then it does not
     /// alter \c p.
-    /// \todo Is it the right way to handle unreachable nodes?
     /// \return Returns \c true if a path to \c t was actually copied to \c p,
     /// \c false otherwise.
     /// \sa DirPath
@@ -517,7 +515,6 @@
     /// or if \c node=root. 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.
-    /// \todo predEdge could be a better name.
     Edge predEdge(Node root, Node node) const { 
       return (*_pred)(root, node); 
     }

Modified: hugo/trunk/lemon/johnson.h
==============================================================================
--- hugo/trunk/lemon/johnson.h	(original)
+++ hugo/trunk/lemon/johnson.h	Fri Nov  4 16:00:19 2005
@@ -625,7 +625,6 @@
     /// This function copies the shortest path to \c t into \c p.
     /// If it \c t is a source itself or unreachable, then it does not
     /// alter \c p.
-    /// \todo Is it the right way to handle unreachable nodes?
     /// \return Returns \c true if a path to \c t was actually copied to \c p,
     /// \c false otherwise.
     /// \sa DirPath
@@ -663,7 +662,6 @@
     /// or if \c node=root. 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.
-    /// \todo predEdge could be a better name.
     Edge predEdge(Node root, Node node) const { 
       return (*_pred)(root, node); 
     }