Removing todos
authordeba
Fri, 04 Nov 2005 15:00:19 +0000
changeset 1765f15b3c09481c
parent 1764 7dac7356c023
child 1766 6c59b1386fe8
Removing todos
lemon/belmann_ford.h
lemon/bfs.h
lemon/dfs.h
lemon/dijkstra.h
lemon/floyd_warshall.h
lemon/johnson.h
     1.1 --- a/lemon/belmann_ford.h	Fri Nov 04 14:49:14 2005 +0000
     1.2 +++ b/lemon/belmann_ford.h	Fri Nov 04 15:00:19 2005 +0000
     1.3 @@ -21,7 +21,6 @@
     1.4  /// \file
     1.5  /// \brief BelmannFord algorithm.
     1.6  ///
     1.7 -/// \todo getPath() should be implemented! (also for BFS and DFS)
     1.8  
     1.9  #include <lemon/list_graph.h>
    1.10  #include <lemon/invalid.h>
    1.11 @@ -494,7 +493,7 @@
    1.12      /// This function copies the shortest path to \c t into \c p.
    1.13      /// If it \c t is a source itself or unreachable, then it does not
    1.14      /// alter \c p.
    1.15 -    /// \todo Is it the right way to handle unreachable nodes?
    1.16 +    ///
    1.17      /// \return Returns \c true if a path to \c t was actually copied to \c p,
    1.18      /// \c false otherwise.
    1.19      /// \sa DirPath
    1.20 @@ -528,7 +527,6 @@
    1.21      /// path tree used in \ref predNode(). 
    1.22      /// \pre \ref run() must be called before using
    1.23      /// this function.
    1.24 -    /// \todo predEdge could be a better name.
    1.25      Edge predEdge(Node v) const { return (*_pred)[v]; }
    1.26  
    1.27      /// \brief Returns the 'previous node' of the shortest path tree.
     2.1 --- a/lemon/bfs.h	Fri Nov 04 14:49:14 2005 +0000
     2.2 +++ b/lemon/bfs.h	Fri Nov 04 15:00:19 2005 +0000
     2.3 @@ -192,7 +192,6 @@
     2.4  
     2.5      ///Creates the maps if necessary.
     2.6      
     2.7 -    ///\todo Error if \c G are \c NULL.
     2.8      ///\todo Better memory allocation (instead of new).
     2.9      void create_maps() 
    2.10      {
    2.11 @@ -610,7 +609,6 @@
    2.12      ///This function copies the shortest path to \c t into \c p.
    2.13      ///If \c t is a source itself or unreachable, then it does not
    2.14      ///alter \c p.
    2.15 -    ///\todo Is it the right way to handle unreachable nodes?
    2.16      ///\return Returns \c true if a path to \c t was actually copied to \c p,
    2.17      ///\c false otherwise.
    2.18      ///\sa DirPath
    2.19 @@ -647,7 +645,6 @@
    2.20      ///\ref predNode().
    2.21      ///\pre Either \ref run() or \ref start() must be called before using
    2.22      ///this function.
    2.23 -    ///\todo predEdge could be a better name.
    2.24      Edge predEdge(Node v) const { return (*_pred)[v];}
    2.25  
    2.26      ///Returns the 'previous node' of the shortest path tree.
     3.1 --- a/lemon/dfs.h	Fri Nov 04 14:49:14 2005 +0000
     3.2 +++ b/lemon/dfs.h	Fri Nov 04 15:00:19 2005 +0000
     3.3 @@ -192,7 +192,6 @@
     3.4  
     3.5      ///Creates the maps if necessary.
     3.6      
     3.7 -    ///\todo Error if \c G are \c NULL.
     3.8      ///\todo Better memory allocation (instead of new).
     3.9      void create_maps() 
    3.10      {
    3.11 @@ -508,14 +507,10 @@
    3.12      ///
    3.13      ///Returns \c false if there are nodes
    3.14      ///to be processed in the queue
    3.15 -    ///
    3.16 -    ///\todo This should be called emptyStack() or some "neutral" name.
    3.17      bool emptyQueue() { return _stack_head<0; }
    3.18      ///Returns the number of the nodes to be processed.
    3.19      
    3.20      ///Returns the number of the nodes to be processed in the queue.
    3.21 -    ///
    3.22 -    ///\todo This should be called stackSize() or some "neutral" name.
    3.23      int queueSize() { return _stack_head+1; }
    3.24      
    3.25      ///Executes the algorithm.
    3.26 @@ -631,7 +626,6 @@
    3.27      ///This function copies the path to \c t on the DFS tree  into \c p.
    3.28      ///If \c t is a source itself or unreachable, then it does not
    3.29      ///alter \c p.
    3.30 -    ///\todo Is this the right way to handle unreachable nodes?
    3.31      ///
    3.32      ///\return Returns \c true if a path to \c t was actually copied to \c p,
    3.33      ///\c false otherwise.
    3.34 @@ -669,7 +663,6 @@
    3.35      ///\ref predNode().
    3.36      ///\pre Either \ref run() or \ref start() must be called before using
    3.37      ///this function.
    3.38 -    ///\todo predEdge could be a better name.
    3.39      Edge predEdge(Node v) const { return (*_pred)[v];}
    3.40  
    3.41      ///Returns the 'previous node' of the %DFS tree.
    3.42 @@ -1381,15 +1374,11 @@
    3.43      ///
    3.44      /// Returns \c false if there are nodes
    3.45      /// to be processed in the queue
    3.46 -    ///
    3.47 -    /// \todo This should be called emptyStack() or some "neutral" name.
    3.48      bool emptyQueue() { return _stack_head < 0; }
    3.49  
    3.50      /// \brief Returns the number of the nodes to be processed.
    3.51      ///
    3.52      /// Returns the number of the nodes to be processed in the queue.
    3.53 -    ///
    3.54 -    ///\todo This should be called stackSize() or some "neutral" name.
    3.55      int queueSize() { return _stack_head + 1; }
    3.56      
    3.57      /// \brief Executes the algorithm.
     4.1 --- a/lemon/dijkstra.h	Fri Nov 04 14:49:14 2005 +0000
     4.2 +++ b/lemon/dijkstra.h	Fri Nov 04 15:00:19 2005 +0000
     4.3 @@ -21,7 +21,6 @@
     4.4  ///\file
     4.5  ///\brief Dijkstra algorithm.
     4.6  ///
     4.7 -///\todo getPath() should be implemented! (also for BFS and DFS)
     4.8  ///\todo dijkstraZero() solution should be revised.
     4.9  
    4.10  #include <lemon/list_graph.h>
    4.11 @@ -246,7 +245,6 @@
    4.12  
    4.13      ///Creates the maps if necessary.
    4.14      
    4.15 -    ///\todo Error if \c G or are \c NULL. What about \c length?
    4.16      ///\todo Better memory allocation (instead of new).
    4.17      void create_maps() 
    4.18      {
    4.19 @@ -723,7 +721,6 @@
    4.20      ///This function copies the shortest path to \c t into \c p.
    4.21      ///If it \c t is a source itself or unreachable, then it does not
    4.22      ///alter \c p.
    4.23 -    ///\todo Is it the right way to handle unreachable nodes?
    4.24      ///\return Returns \c true if a path to \c t was actually copied to \c p,
    4.25      ///\c false otherwise.
    4.26      ///\sa DirPath
    4.27 @@ -758,7 +755,6 @@
    4.28      ///shortest path tree used here is equal to the shortest path tree used in
    4.29      ///\ref predNode().  \pre \ref run() must be called before using
    4.30      ///this function.
    4.31 -    ///\todo predEdge could be a better name.
    4.32      Edge predEdge(Node v) const { return (*_pred)[v]; }
    4.33  
    4.34      ///Returns the 'previous node' of the shortest path tree.
     5.1 --- a/lemon/floyd_warshall.h	Fri Nov 04 14:49:14 2005 +0000
     5.2 +++ b/lemon/floyd_warshall.h	Fri Nov 04 15:00:19 2005 +0000
     5.3 @@ -21,7 +21,6 @@
     5.4  /// \file
     5.5  /// \brief FloydWarshall algorithm.
     5.6  ///
     5.7 -/// \todo getPath() should be implemented! (also for BFS and DFS)
     5.8  
     5.9  #include <lemon/list_graph.h>
    5.10  #include <lemon/graph_utils.h>
    5.11 @@ -479,7 +478,6 @@
    5.12      /// This function copies the shortest path to \c t into \c p.
    5.13      /// If it \c t is a source itself or unreachable, then it does not
    5.14      /// alter \c p.
    5.15 -    /// \todo Is it the right way to handle unreachable nodes?
    5.16      /// \return Returns \c true if a path to \c t was actually copied to \c p,
    5.17      /// \c false otherwise.
    5.18      /// \sa DirPath
    5.19 @@ -517,7 +515,6 @@
    5.20      /// or if \c node=root. The shortest path tree used here is equal to the 
    5.21      /// shortest path tree used in \ref predNode(). 
    5.22      /// \pre \ref run() must be called before using this function.
    5.23 -    /// \todo predEdge could be a better name.
    5.24      Edge predEdge(Node root, Node node) const { 
    5.25        return (*_pred)(root, node); 
    5.26      }
     6.1 --- a/lemon/johnson.h	Fri Nov 04 14:49:14 2005 +0000
     6.2 +++ b/lemon/johnson.h	Fri Nov 04 15:00:19 2005 +0000
     6.3 @@ -625,7 +625,6 @@
     6.4      /// This function copies the shortest path to \c t into \c p.
     6.5      /// If it \c t is a source itself or unreachable, then it does not
     6.6      /// alter \c p.
     6.7 -    /// \todo Is it the right way to handle unreachable nodes?
     6.8      /// \return Returns \c true if a path to \c t was actually copied to \c p,
     6.9      /// \c false otherwise.
    6.10      /// \sa DirPath
    6.11 @@ -663,7 +662,6 @@
    6.12      /// or if \c node=root. The shortest path tree used here is equal to the 
    6.13      /// shortest path tree used in \ref predNode(). 
    6.14      /// \pre \ref run() must be called before using this function.
    6.15 -    /// \todo predEdge could be a better name.
    6.16      Edge predEdge(Node root, Node node) const { 
    6.17        return (*_pred)(root, node); 
    6.18      }