[Lemon-commits] Alpar Juttner: Remove todo-s and convert them to...
Lemon HG
hg at lemon.cs.elte.hu
Fri Sep 26 10:20:57 CEST 2008
details: http://lemon.cs.elte.hu/hg/lemon/rev/e7f8647ce760
changeset: 280:e7f8647ce760
user: Alpar Juttner <alpar [at] cs.elte.hu>
date: Mon Jul 14 15:23:11 2008 +0100
description:
Remove todo-s and convert them to trac tickets
diffstat:
15 files changed, 7 insertions(+), 53 deletions(-)
lemon/bfs.h | 9 ++-------
lemon/bits/base_extender.h | 3 ---
lemon/bits/vector_map.h | 3 +--
lemon/concept_check.h | 2 --
lemon/concepts/path.h | 1 -
lemon/dfs.h | 9 ++-------
lemon/dijkstra.h | 12 +-----------
lemon/error.h | 2 --
lemon/graph_to_eps.h | 5 -----
lemon/list_graph.h | 4 +---
lemon/maps.h | 4 ----
lemon/random.h | 1 -
lemon/smart_graph.h | 1 -
lemon/time_measure.h | 2 --
lemon/tolerance.h | 2 --
diffs (truncated from 353 to 300 lines):
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/bfs.h
--- a/lemon/bfs.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/bfs.h Mon Jul 14 15:23:11 2008 +0100
@@ -53,7 +53,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient to initialize
static PredMap *createPredMap(const Digraph &g)
{
return new PredMap(g);
@@ -63,7 +62,6 @@
///The type of the map that indicates which nodes are processed.
///It must meet the \ref concepts::WriteMap "WriteMap" concept.
- ///By default it is a NullMap.
typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
///Instantiates a \ref ProcessedMap.
@@ -195,8 +193,7 @@
int _queue_head,_queue_tail,_queue_next_dist;
int _curr_dist;
- ///Creates the maps if necessary.
- ///\todo Better memory allocation (instead of new).
+ //Creates the maps if necessary.
void create_maps()
{
if(!_pred) {
@@ -847,7 +844,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient to initialize
#ifdef DOXYGEN
static PredMap *createPredMap(const Digraph &g)
#else
@@ -1332,8 +1328,7 @@
std::vector<typename Digraph::Node> _list;
int _list_front, _list_back;
- ///Creates the maps if necessary.
- ///\todo Better memory allocation (instead of new).
+ //Creates the maps if necessary.
void create_maps() {
if(!_reached) {
local_reached = true;
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/bits/base_extender.h
--- a/lemon/bits/base_extender.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/bits/base_extender.h Mon Jul 14 15:23:11 2008 +0100
@@ -105,9 +105,6 @@
/// Returns whether the given directed arc has the same orientation
/// as the corresponding edge.
- ///
- /// \todo reference to the corresponding point of the undirected digraph
- /// concept. "What does the direction of an edge mean?"
static bool direction(const Arc &a) { return a.forward; }
using Parent::first;
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/bits/vector_map.h
--- a/lemon/bits/vector_map.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/bits/vector_map.h Mon Jul 14 15:23:11 2008 +0100
@@ -42,10 +42,9 @@
/// automatically updates the map when a key is added to or erased from
/// the map. This map type uses the std::vector to store the values.
///
- /// \tparam _Notifier The AlterationNotifier that will notify this map.
+ /// \tparam _Graph The graph this map is attached to.
/// \tparam _Item The item type of the graph items.
/// \tparam _Value The value type of the map.
- /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
template <typename _Graph, typename _Item, typename _Value>
class VectorMap
: public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/concept_check.h
--- a/lemon/concept_check.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/concept_check.h Mon Jul 14 15:23:11 2008 +0100
@@ -36,8 +36,6 @@
///\file
///\brief Basic utilities for concept checking.
///
-///\todo Are we still using BOOST concept checking utility?
-///Is the BOOST copyright notice necessary?
#ifndef LEMON_CONCEPT_CHECK_H
#define LEMON_CONCEPT_CHECK_H
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/concepts/path.h
--- a/lemon/concepts/path.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/concepts/path.h Mon Jul 14 15:23:11 2008 +0100
@@ -20,7 +20,6 @@
///\file
///\brief Classes for representing paths in digraphs.
///
-///\todo Iterators have obsolete style
#ifndef LEMON_CONCEPT_PATH_H
#define LEMON_CONCEPT_PATH_H
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/dfs.h
--- a/lemon/dfs.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/dfs.h Mon Jul 14 15:23:11 2008 +0100
@@ -54,7 +54,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient to initialize
static PredMap *createPredMap(const Digraph &g)
{
return new PredMap(g);
@@ -64,7 +63,6 @@
///The type of the map that indicates which nodes are processed.
///It must meet the \ref concepts::WriteMap "WriteMap" concept.
- ///By default it is a NullMap.
typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
///Instantiates a \ref ProcessedMap.
@@ -195,8 +193,7 @@
std::vector<typename Digraph::OutArcIt> _stack;
int _stack_head;
- ///Creates the maps if necessary.
- ///\todo Better memory allocation (instead of new).
+ //Creates the maps if necessary.
void create_maps()
{
if(!_pred) {
@@ -782,7 +779,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient to initialize
#ifdef DOXYGEN
static PredMap *createPredMap(const Digraph &g)
#else
@@ -1279,8 +1275,7 @@
std::vector<typename Digraph::Arc> _stack;
int _stack_head;
- ///Creates the maps if necessary.
- ///\todo Better memory allocation (instead of new).
+ //Creates the maps if necessary.
void create_maps() {
if(!_reached) {
local_reached = true;
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/dijkstra.h
--- a/lemon/dijkstra.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/dijkstra.h Mon Jul 14 15:23:11 2008 +0100
@@ -143,7 +143,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient for the initialization
static PredMap *createPredMap(const Digraph &g)
{
return new PredMap(g);
@@ -154,8 +153,6 @@
///The type of the map that indicates which nodes are processed.
///It must meet the \ref concepts::WriteMap "WriteMap" concept.
///By default it is a NullMap.
- ///\todo If it is set to a real map,
- ///Dijkstra::processed() should read this.
typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
///Instantiates a \ref ProcessedMap.
@@ -296,8 +293,7 @@
//Indicates if _heap is locally allocated (true) or not.
bool local_heap;
- ///Creates the maps if necessary.
- ///\todo Better memory allocation (instead of new).
+ //Creates the maps if necessary.
void create_maps()
{
if(!_pred) {
@@ -957,7 +953,6 @@
///This function instantiates a \ref HeapCrossRef.
/// \param g is the digraph, to which we would like to define the
/// HeapCrossRef.
- /// \todo The digraph alone may be insufficient for the initialization
static HeapCrossRef *createHeapCrossRef(const Digraph &g)
{
return new HeapCrossRef(g);
@@ -993,7 +988,6 @@
///This function instantiates a \ref PredMap.
///\param g is the digraph, to which we would like to define the
///\ref PredMap.
- ///\todo The digraph alone may be insufficient to initialize
#ifdef DOXYGEN
static PredMap *createPredMap(const Digraph &g)
#else
@@ -1008,9 +1002,6 @@
///The type of the map that indicates which nodes are processed.
///It must meet the \ref concepts::WriteMap "WriteMap" concept.
///By default it is a NullMap.
- ///\todo If it is set to a real map,
- ///Dijkstra::processed() should read this.
- ///\todo named parameter to set this type, function to read and write.
typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
///Instantiates a \ref ProcessedMap.
@@ -1054,7 +1045,6 @@
/// as well as the \ref Dijkstra class.
/// The \ref DijkstraWizardBase is a class to be the default traits of the
/// \ref DijkstraWizard class.
- /// \todo More named parameters are required...
template<class GR,class LM>
class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LM>
{
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/error.h
--- a/lemon/error.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/error.h Mon Jul 14 15:23:11 2008 +0100
@@ -102,8 +102,6 @@
protected:
///\e
- ///\todo The good solution is boost::shared_ptr...
- ///
mutable std::auto_ptr<std::ostringstream> buf;
///\e
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/graph_to_eps.h
--- a/lemon/graph_to_eps.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/graph_to_eps.h Mon Jul 14 15:23:11 2008 +0100
@@ -666,7 +666,6 @@
///this function calls the algorithm itself, i.e. in this case
///it draws the graph.
void run() {
- //\todo better 'epsilon' would be nice here.
const double EPSILON=1e-9;
if(dontPrint) return;
@@ -707,7 +706,6 @@
double max_w=0;
for(ArcIt e(g);e!=INVALID;++e)
max_w=std::max(double(_arcWidths[e]),max_w);
- //\todo better 'epsilon' would be nice here.
if(max_w>EPSILON) {
_arcWidthScale/=max_w;
}
@@ -717,7 +715,6 @@
double max_s=0;
for(NodeIt n(g);n!=INVALID;++n)
max_s=std::max(double(_nodeSizes[n]),max_s);
- //\todo better 'epsilon' would be nice here.
if(max_s>EPSILON) {
_nodeScale/=max_s;
}
@@ -873,7 +870,6 @@
<< -bb.left() << ' ' << -bb.bottom() << " translate\n";
}
else {
- //\todo Verify centering
double sc= std::min((A4HEIGHT-2*A4BORDER)/bb.width(),
(A4WIDTH-2*A4BORDER)/bb.height());
os << ((A4WIDTH -2*A4BORDER)-sc*bb.height())/2 + A4BORDER << ' '
@@ -906,7 +902,6 @@
dim2::Point<double>
dvec(mycoords[g.target(*i)]-mycoords[g.source(*i)]);
double l=std::sqrt(dvec.normSquare());
- //\todo better 'epsilon' would be nice here.
dim2::Point<double> d(dvec/std::max(l,EPSILON));
dim2::Point<double> m;
// m=dim2::Point<double>(mycoords[g.target(*i)]+
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/list_graph.h
--- a/lemon/list_graph.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/list_graph.h Mon Jul 14 15:23:11 2008 +0100
@@ -501,10 +501,8 @@
///valid. However <tt>InArcIt</tt>s and <tt>OutArcIt</tt>s may
///be invalidated.
///
- ///\warning This functionality cannot be used together with the
+ ///\warning This functionality cannot be used in conjunction with the
///Snapshot feature.
- ///
- ///\todo It could be implemented in a bit faster way.
Node split(Node n, bool connect = true) {
Node b = addNode();
for(OutArcIt e(*this,n);e!=INVALID;) {
diff -r 7abfb55f1ecc -r e7f8647ce760 lemon/maps.h
--- a/lemon/maps.h Mon Sep 22 10:56:01 2008 +0200
+++ b/lemon/maps.h Mon Jul 14 15:23:11 2008 +0100
@@ -484,8 +484,6 @@
/// function.
///
/// \sa CombineMap
- ///
- /// \todo Check the requirements.
template <typename M1, typename M2>
class ComposeMap : public MapBase<typename M2::Key, typename M1::Value> {
const M1 &_m1;
@@ -540,8 +538,6 @@
/// function.
///
/// \sa ComposeMap
- ///
- /// \todo Check the requirements.
template<typename M1, typename M2, typename F,
typename V = typename F::result_type>
class CombineMap : public MapBase<typename M1::Key, V> {
More information about the Lemon-commits
mailing list