Remove todo-s and convert them to trac tickets
authorAlpar Juttner <alpar@cs.elte.hu>
Mon, 14 Jul 2008 15:23:11 +0100
changeset 280e7f8647ce760
parent 277 7abfb55f1ecc
child 281 e9b4fbe163f5
Remove todo-s and convert them to trac tickets
lemon/bfs.h
lemon/bits/base_extender.h
lemon/bits/vector_map.h
lemon/concept_check.h
lemon/concepts/path.h
lemon/dfs.h
lemon/dijkstra.h
lemon/error.h
lemon/graph_to_eps.h
lemon/list_graph.h
lemon/maps.h
lemon/random.h
lemon/smart_graph.h
lemon/time_measure.h
lemon/tolerance.h
     1.1 --- a/lemon/bfs.h	Mon Sep 22 10:56:01 2008 +0200
     1.2 +++ b/lemon/bfs.h	Mon Jul 14 15:23:11 2008 +0100
     1.3 @@ -53,7 +53,6 @@
     1.4      ///This function instantiates a \ref PredMap.
     1.5      ///\param g is the digraph, to which we would like to define the
     1.6      ///\ref PredMap.
     1.7 -    ///\todo The digraph alone may be insufficient to initialize
     1.8      static PredMap *createPredMap(const Digraph &g)
     1.9      {
    1.10        return new PredMap(g);
    1.11 @@ -63,7 +62,6 @@
    1.12  
    1.13      ///The type of the map that indicates which nodes are processed.
    1.14      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    1.15 -    ///By default it is a NullMap.
    1.16      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    1.17      ///Instantiates a \ref ProcessedMap.
    1.18  
    1.19 @@ -195,8 +193,7 @@
    1.20      int _queue_head,_queue_tail,_queue_next_dist;
    1.21      int _curr_dist;
    1.22  
    1.23 -    ///Creates the maps if necessary.
    1.24 -    ///\todo Better memory allocation (instead of new).
    1.25 +    //Creates the maps if necessary.
    1.26      void create_maps()
    1.27      {
    1.28        if(!_pred) {
    1.29 @@ -847,7 +844,6 @@
    1.30      ///This function instantiates a \ref PredMap.
    1.31      ///\param g is the digraph, to which we would like to define the
    1.32      ///\ref PredMap.
    1.33 -    ///\todo The digraph alone may be insufficient to initialize
    1.34  #ifdef DOXYGEN
    1.35      static PredMap *createPredMap(const Digraph &g)
    1.36  #else
    1.37 @@ -1332,8 +1328,7 @@
    1.38      std::vector<typename Digraph::Node> _list;
    1.39      int _list_front, _list_back;
    1.40  
    1.41 -    ///Creates the maps if necessary.
    1.42 -    ///\todo Better memory allocation (instead of new).
    1.43 +    //Creates the maps if necessary.
    1.44      void create_maps() {
    1.45        if(!_reached) {
    1.46          local_reached = true;
     2.1 --- a/lemon/bits/base_extender.h	Mon Sep 22 10:56:01 2008 +0200
     2.2 +++ b/lemon/bits/base_extender.h	Mon Jul 14 15:23:11 2008 +0100
     2.3 @@ -105,9 +105,6 @@
     2.4  
     2.5      /// Returns whether the given directed arc has the same orientation
     2.6      /// as the corresponding edge.
     2.7 -    ///
     2.8 -    /// \todo reference to the corresponding point of the undirected digraph
     2.9 -    /// concept. "What does the direction of an edge mean?"
    2.10      static bool direction(const Arc &a) { return a.forward; }
    2.11  
    2.12      using Parent::first;
     3.1 --- a/lemon/bits/vector_map.h	Mon Sep 22 10:56:01 2008 +0200
     3.2 +++ b/lemon/bits/vector_map.h	Mon Jul 14 15:23:11 2008 +0100
     3.3 @@ -42,10 +42,9 @@
     3.4    /// automatically updates the map when a key is added to or erased from
     3.5    /// the map. This map type uses the std::vector to store the values.
     3.6    ///
     3.7 -  /// \tparam _Notifier The AlterationNotifier that will notify this map.
     3.8 +  /// \tparam _Graph The graph this map is attached to.
     3.9    /// \tparam _Item The item type of the graph items.
    3.10    /// \tparam _Value The value type of the map.
    3.11 -  /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
    3.12    template <typename _Graph, typename _Item, typename _Value>
    3.13    class VectorMap
    3.14      : public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
     4.1 --- a/lemon/concept_check.h	Mon Sep 22 10:56:01 2008 +0200
     4.2 +++ b/lemon/concept_check.h	Mon Jul 14 15:23:11 2008 +0100
     4.3 @@ -36,8 +36,6 @@
     4.4  ///\file
     4.5  ///\brief Basic utilities for concept checking.
     4.6  ///
     4.7 -///\todo Are we still using BOOST concept checking utility?
     4.8 -///Is the BOOST copyright notice necessary?
     4.9  
    4.10  #ifndef LEMON_CONCEPT_CHECK_H
    4.11  #define LEMON_CONCEPT_CHECK_H
     5.1 --- a/lemon/concepts/path.h	Mon Sep 22 10:56:01 2008 +0200
     5.2 +++ b/lemon/concepts/path.h	Mon Jul 14 15:23:11 2008 +0100
     5.3 @@ -20,7 +20,6 @@
     5.4  ///\file
     5.5  ///\brief Classes for representing paths in digraphs.
     5.6  ///
     5.7 -///\todo Iterators have obsolete style
     5.8  
     5.9  #ifndef LEMON_CONCEPT_PATH_H
    5.10  #define LEMON_CONCEPT_PATH_H
     6.1 --- a/lemon/dfs.h	Mon Sep 22 10:56:01 2008 +0200
     6.2 +++ b/lemon/dfs.h	Mon Jul 14 15:23:11 2008 +0100
     6.3 @@ -54,7 +54,6 @@
     6.4      ///This function instantiates a \ref PredMap.
     6.5      ///\param g is the digraph, to which we would like to define the
     6.6      ///\ref PredMap.
     6.7 -    ///\todo The digraph alone may be insufficient to initialize
     6.8      static PredMap *createPredMap(const Digraph &g)
     6.9      {
    6.10        return new PredMap(g);
    6.11 @@ -64,7 +63,6 @@
    6.12  
    6.13      ///The type of the map that indicates which nodes are processed.
    6.14      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    6.15 -    ///By default it is a NullMap.
    6.16      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    6.17      ///Instantiates a \ref ProcessedMap.
    6.18  
    6.19 @@ -195,8 +193,7 @@
    6.20      std::vector<typename Digraph::OutArcIt> _stack;
    6.21      int _stack_head;
    6.22  
    6.23 -    ///Creates the maps if necessary.
    6.24 -    ///\todo Better memory allocation (instead of new).
    6.25 +    //Creates the maps if necessary.
    6.26      void create_maps()
    6.27      {
    6.28        if(!_pred) {
    6.29 @@ -782,7 +779,6 @@
    6.30      ///This function instantiates a \ref PredMap.
    6.31      ///\param g is the digraph, to which we would like to define the
    6.32      ///\ref PredMap.
    6.33 -    ///\todo The digraph alone may be insufficient to initialize
    6.34  #ifdef DOXYGEN
    6.35      static PredMap *createPredMap(const Digraph &g)
    6.36  #else
    6.37 @@ -1279,8 +1275,7 @@
    6.38      std::vector<typename Digraph::Arc> _stack;
    6.39      int _stack_head;
    6.40  
    6.41 -    ///Creates the maps if necessary.
    6.42 -    ///\todo Better memory allocation (instead of new).
    6.43 +    //Creates the maps if necessary.
    6.44      void create_maps() {
    6.45        if(!_reached) {
    6.46          local_reached = true;
     7.1 --- a/lemon/dijkstra.h	Mon Sep 22 10:56:01 2008 +0200
     7.2 +++ b/lemon/dijkstra.h	Mon Jul 14 15:23:11 2008 +0100
     7.3 @@ -143,7 +143,6 @@
     7.4      ///This function instantiates a \ref PredMap.
     7.5      ///\param g is the digraph, to which we would like to define the
     7.6      ///\ref PredMap.
     7.7 -    ///\todo The digraph alone may be insufficient for the initialization
     7.8      static PredMap *createPredMap(const Digraph &g)
     7.9      {
    7.10        return new PredMap(g);
    7.11 @@ -154,8 +153,6 @@
    7.12      ///The type of the map that indicates which nodes are processed.
    7.13      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    7.14      ///By default it is a NullMap.
    7.15 -    ///\todo If it is set to a real map,
    7.16 -    ///Dijkstra::processed() should read this.
    7.17      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    7.18      ///Instantiates a \ref ProcessedMap.
    7.19  
    7.20 @@ -296,8 +293,7 @@
    7.21      //Indicates if _heap is locally allocated (true) or not.
    7.22      bool local_heap;
    7.23  
    7.24 -    ///Creates the maps if necessary.
    7.25 -    ///\todo Better memory allocation (instead of new).
    7.26 +    //Creates the maps if necessary.
    7.27      void create_maps()
    7.28      {
    7.29        if(!_pred) {
    7.30 @@ -957,7 +953,6 @@
    7.31      ///This function instantiates a \ref HeapCrossRef.
    7.32      /// \param g is the digraph, to which we would like to define the
    7.33      /// HeapCrossRef.
    7.34 -    /// \todo The digraph alone may be insufficient for the initialization
    7.35      static HeapCrossRef *createHeapCrossRef(const Digraph &g)
    7.36      {
    7.37        return new HeapCrossRef(g);
    7.38 @@ -993,7 +988,6 @@
    7.39      ///This function instantiates a \ref PredMap.
    7.40      ///\param g is the digraph, to which we would like to define the
    7.41      ///\ref PredMap.
    7.42 -    ///\todo The digraph alone may be insufficient to initialize
    7.43  #ifdef DOXYGEN
    7.44      static PredMap *createPredMap(const Digraph &g)
    7.45  #else
    7.46 @@ -1008,9 +1002,6 @@
    7.47      ///The type of the map that indicates which nodes are processed.
    7.48      ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
    7.49      ///By default it is a NullMap.
    7.50 -    ///\todo If it is set to a real map,
    7.51 -    ///Dijkstra::processed() should read this.
    7.52 -    ///\todo named parameter to set this type, function to read and write.
    7.53      typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
    7.54      ///Instantiates a \ref ProcessedMap.
    7.55  
    7.56 @@ -1054,7 +1045,6 @@
    7.57    /// as well as the \ref Dijkstra class.
    7.58    /// The \ref DijkstraWizardBase is a class to be the default traits of the
    7.59    /// \ref DijkstraWizard class.
    7.60 -  /// \todo More named parameters are required...
    7.61    template<class GR,class LM>
    7.62    class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LM>
    7.63    {
     8.1 --- a/lemon/error.h	Mon Sep 22 10:56:01 2008 +0200
     8.2 +++ b/lemon/error.h	Mon Jul 14 15:23:11 2008 +0100
     8.3 @@ -102,8 +102,6 @@
     8.4    protected:
     8.5      ///\e
     8.6  
     8.7 -    ///\todo The good solution is boost::shared_ptr...
     8.8 -    ///
     8.9      mutable std::auto_ptr<std::ostringstream> buf;
    8.10  
    8.11      ///\e
     9.1 --- a/lemon/graph_to_eps.h	Mon Sep 22 10:56:01 2008 +0200
     9.2 +++ b/lemon/graph_to_eps.h	Mon Jul 14 15:23:11 2008 +0100
     9.3 @@ -666,7 +666,6 @@
     9.4    ///this function calls the algorithm itself, i.e. in this case
     9.5    ///it draws the graph.
     9.6    void run() {
     9.7 -    //\todo better 'epsilon' would be nice here.
     9.8      const double EPSILON=1e-9;
     9.9      if(dontPrint) return;
    9.10  
    9.11 @@ -707,7 +706,6 @@
    9.12        double max_w=0;
    9.13        for(ArcIt e(g);e!=INVALID;++e)
    9.14          max_w=std::max(double(_arcWidths[e]),max_w);
    9.15 -      //\todo better 'epsilon' would be nice here.
    9.16        if(max_w>EPSILON) {
    9.17          _arcWidthScale/=max_w;
    9.18        }
    9.19 @@ -717,7 +715,6 @@
    9.20        double max_s=0;
    9.21        for(NodeIt n(g);n!=INVALID;++n)
    9.22          max_s=std::max(double(_nodeSizes[n]),max_s);
    9.23 -      //\todo better 'epsilon' would be nice here.
    9.24        if(max_s>EPSILON) {
    9.25          _nodeScale/=max_s;
    9.26        }
    9.27 @@ -873,7 +870,6 @@
    9.28             << -bb.left() << ' ' << -bb.bottom() << " translate\n";
    9.29        }
    9.30        else {
    9.31 -        //\todo Verify centering
    9.32          double sc= std::min((A4HEIGHT-2*A4BORDER)/bb.width(),
    9.33                    (A4WIDTH-2*A4BORDER)/bb.height());
    9.34          os << ((A4WIDTH -2*A4BORDER)-sc*bb.height())/2 + A4BORDER << ' '
    9.35 @@ -906,7 +902,6 @@
    9.36            dim2::Point<double>
    9.37              dvec(mycoords[g.target(*i)]-mycoords[g.source(*i)]);
    9.38            double l=std::sqrt(dvec.normSquare());
    9.39 -          //\todo better 'epsilon' would be nice here.
    9.40            dim2::Point<double> d(dvec/std::max(l,EPSILON));
    9.41            dim2::Point<double> m;
    9.42  //           m=dim2::Point<double>(mycoords[g.target(*i)]+
    10.1 --- a/lemon/list_graph.h	Mon Sep 22 10:56:01 2008 +0200
    10.2 +++ b/lemon/list_graph.h	Mon Jul 14 15:23:11 2008 +0100
    10.3 @@ -501,10 +501,8 @@
    10.4      ///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s may
    10.5      ///be invalidated.
    10.6      ///
    10.7 -    ///\warning This functionality cannot be used together with the
    10.8 +    ///\warning This functionality cannot be used in conjunction with the
    10.9      ///Snapshot feature.
   10.10 -    ///
   10.11 -    ///\todo It could be implemented in a bit faster way.
   10.12      Node split(Node n, bool connect = true) {
   10.13        Node b = addNode();
   10.14        for(OutArcIt e(*this,n);e!=INVALID;) {
    11.1 --- a/lemon/maps.h	Mon Sep 22 10:56:01 2008 +0200
    11.2 +++ b/lemon/maps.h	Mon Jul 14 15:23:11 2008 +0100
    11.3 @@ -484,8 +484,6 @@
    11.4    /// function.
    11.5    ///
    11.6    /// \sa CombineMap
    11.7 -  ///
    11.8 -  /// \todo Check the requirements.
    11.9    template <typename M1, typename M2>
   11.10    class ComposeMap : public MapBase<typename M2::Key, typename M1::Value> {
   11.11      const M1 &_m1;
   11.12 @@ -540,8 +538,6 @@
   11.13    /// function.
   11.14    ///
   11.15    /// \sa ComposeMap
   11.16 -  ///
   11.17 -  /// \todo Check the requirements.
   11.18    template<typename M1, typename M2, typename F,
   11.19             typename V = typename F::result_type>
   11.20    class CombineMap : public MapBase<typename M1::Key, V> {
    12.1 --- a/lemon/random.h	Mon Sep 22 10:56:01 2008 +0200
    12.2 +++ b/lemon/random.h	Mon Jul 14 15:23:11 2008 +0100
    12.3 @@ -821,7 +821,6 @@
    12.4      /// Standard Gauss distribution.
    12.5      /// \note The Cartesian form of the Box-Muller
    12.6      /// transformation is used to generate a random normal distribution.
    12.7 -    /// \todo Consider using the "ziggurat" method instead.
    12.8      double gauss()
    12.9      {
   12.10        double V1,V2,S;
    13.1 --- a/lemon/smart_graph.h	Mon Sep 22 10:56:01 2008 +0200
    13.2 +++ b/lemon/smart_graph.h	Mon Jul 14 15:23:11 2008 +0100
    13.3 @@ -300,7 +300,6 @@
    13.4      ///may be invalidated.
    13.5      ///\warning This functionality cannot be used together with the Snapshot
    13.6      ///feature.
    13.7 -    ///\todo It could be implemented in a bit faster way.
    13.8      Node split(Node n, bool connect = true)
    13.9      {
   13.10        Node b = addNode();
    14.1 --- a/lemon/time_measure.h	Mon Sep 22 10:56:01 2008 +0200
    14.2 +++ b/lemon/time_measure.h	Mon Jul 14 15:23:11 2008 +0100
    14.3 @@ -292,7 +292,6 @@
    14.4    ///\note If you want to measure the running time of the execution of a certain
    14.5    ///function, consider the usage of \ref TimeReport instead.
    14.6    ///
    14.7 -  ///\todo This shouldn't be Unix (Linux) specific.
    14.8    ///\sa TimeReport
    14.9    class Timer
   14.10    {
   14.11 @@ -487,7 +486,6 @@
   14.12    ///
   14.13    ///\sa Timer
   14.14    ///\sa NoTimeReport
   14.15 -  ///\todo There is no test case for this
   14.16    class TimeReport : public Timer
   14.17    {
   14.18      std::string _title;
    15.1 --- a/lemon/tolerance.h	Mon Sep 22 10:56:01 2008 +0200
    15.2 +++ b/lemon/tolerance.h	Mon Jul 14 15:23:11 2008 +0100
    15.3 @@ -24,8 +24,6 @@
    15.4  ///\brief A basic tool to handle the anomalies of calculation with
    15.5  ///floating point numbers.
    15.6  ///
    15.7 -///\todo It should be in a module like "Basic tools"
    15.8 -
    15.9  
   15.10  namespace lemon {
   15.11