[Lemon-commits] [lemon_svn] alpar: r2028 - in hugo/trunk: doc lemon
Lemon SVN
svn at lemon.cs.elte.hu
Mon Nov 6 20:49:37 CET 2006
Author: alpar
Date: Mon Jul 4 18:27:54 2005
New Revision: 2028
Modified:
hugo/trunk/doc/groups.dox
hugo/trunk/doc/license.dox
hugo/trunk/doc/named-param.dox
hugo/trunk/lemon/bfs.h
hugo/trunk/lemon/dfs.h
hugo/trunk/lemon/dijkstra.h
hugo/trunk/lemon/error.h
hugo/trunk/lemon/graph_adaptor.h
hugo/trunk/lemon/graph_utils.h
hugo/trunk/lemon/lp_base.h
hugo/trunk/lemon/maps.h
Log:
Kill several doxygen warnings
Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox (original)
+++ hugo/trunk/doc/groups.dox Mon Jul 4 18:27:54 2005
@@ -66,7 +66,7 @@
Map adaptors are used to create "implicit" maps from other maps.
-Most of them are \ref concept::ReadMap "ReadMap"s. They can
+Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
make arithmetic oprerations between one or two maps (negation, scalig,
addition, multiplication etc.) or e.g. convert a map to another one
of different Value type.
Modified: hugo/trunk/doc/license.dox
==============================================================================
--- hugo/trunk/doc/license.dox (original)
+++ hugo/trunk/doc/license.dox Mon Jul 4 18:27:54 2005
@@ -2,6 +2,6 @@
\page license License Terms
-\verbinclude ../../LICENSE
+\verbinclude ../LICENSE
*/
\ No newline at end of file
Modified: hugo/trunk/doc/named-param.dox
==============================================================================
--- hugo/trunk/doc/named-param.dox (original)
+++ hugo/trunk/doc/named-param.dox Mon Jul 4 18:27:54 2005
@@ -4,13 +4,21 @@
\section named-func-param Named "Function" Parameters
-C++ makes it possible to use default parameter values when calling a function. In such
-a case we do not have to give value for parameters, the program will use the default ones.
-Unfortunately sometimes this is not enough. If we do not want to give values for all the parameters, only
-for some of them we come across problems, because an arbitrary set of parameters cannot be omitted. On the other hand parameters have a fixed order in the head of the function.
-C++ can apply the default values only in the back of the order, if we do not give other value for them.
-So we can not give the function for example the value of the first, and the third parameter, expecting that the program will aplly the default value for the second parameter.
-However sometimes we would like to use some functinos exactly in this way. With a crafty trick and with some little inconvenience this is possible. We have implemented this little trick as an example below.
+C++ makes it possible to use default parameter values when calling a
+function. In such a case we do not have to give value for parameters,
+the program will use the default ones. Unfortunately sometimes this
+is not enough. If we do not want to give values for all the
+parameters, only for some of them we come across problems, because an
+arbitrary set of parameters cannot be omitted. On the other hand
+parameters have a fixed order in the head of the function. C++ can
+apply the default values only in the back of the order, if we do not
+give other value for them. So we can not give the function for
+example the value of the first, and the third parameter, expecting
+that the program will aplly the default value for the second
+parameter. However sometimes we would like to use some functinos
+exactly in this way. With a crafty trick and with some little
+inconvenience this is possible. We have implemented this little trick
+as an example below.
\code
class named_fn
@@ -34,22 +42,41 @@
The usage is the following.
-We have to define a class, let's call it named_fn.
-Let us assume that we would like to use a parameter, called X. In the named_fn class we have to define an _X attribute, and an X function. The function expects a parameter with the type of _X, and sets the value of _X. After setting the value the function returns the class itself. The class also have to have a function, called for example run(), we have to implement here the original function itself. The constructor of the class have to give all the attributes like _X the default values of them.
-
-If we instantiate this class, the default values will be set for the attributes (originally the parameters), initially. If we call the X function, we get a class with the modified parameter value of X. Therefore we can modify any parameter-value, independent from the order. To run the algorithm we have to call the run() function at the end of the row.
+We have to define a class, let's call it named_fn. Let us assume that
+we would like to use a parameter, called X. In the named_fn class we
+have to define an _X attribute, and an X function. The function
+expects a parameter with the type of _X, and sets the value of
+_X. After setting the value the function returns the class itself. The
+class also have to have a function, called for example run(), we have
+to implement here the original function itself. The constructor of the
+class have to give all the attributes like _X the default values of
+them.
+
+If we instantiate this class, the default values will be set for the
+attributes (originally the parameters), initially. If we call the X
+function, we get a class with the modified parameter value of
+X. Therefore we can modify any parameter-value, independent from the
+order. To run the algorithm we have to call the run() function at the
+end of the row.
Example: named_fn().id(3).val(2).run();
\section traits-classes Traits Classes
-The procedure above can also be applied when defining classes. In this case the type of the attributes can be changed.
-Initially we have to define a class with the default attribute types. This is the so called Traits Class. Later on
-the types of these attributes can be changed, as described below. In our software \ref DijkstraDefaultTraits is an example of how a traits class looks like.
+The procedure above can also be applied when defining classes. In this
+case the type of the attributes can be changed. Initially we have to
+define a class with the default attribute types. This is the so called
+Traits Class. Later on the types of these attributes can be changed,
+as described below. In our software \ref lemon::DijkstraDefaultTraits is an
+example of how a traits class looks like.
\section named-templ-param Named Class Template Parameters
-If we would like to change the type of an attribute in a class that was instantiated by using a traits class as a template parameter, and the class contains named parameters, we do not have to reinstantiate the class with new traits class. Instead of that, adaptor classes can be used like in the following cases.
+If we would like to change the type of an attribute in a class that
+was instantiated by using a traits class as a template parameter, and
+the class contains named parameters, we do not have to reinstantiate
+the class with new traits class. Instead of that, adaptor classes can
+be used like in the following cases.
\code
Dijkstra<>::SetPredNodeMap<NullMap<Node,Node> >
@@ -62,11 +89,13 @@
Dijkstra<>::SetDistMap<MyMap>::SetPredMap<NullMap<Node,Edge> >
\endcode
-The result will be an instantiated Dijkstra class, in which the DistMap and the PredMap is modified.
+The result will be an instantiated Dijkstra class, in which the
+DistMap and the PredMap is modified.
\section named-templ-func-param Named "Function" Template Parameters
-If the class has so called wizard functions, the new class with the modified tpye of attributes can be returned
-by the appropriate wizard function. The usage of these wizard functions is the following:
+If the class has so called wizard functions, the new class with the
+modified tpye of attributes can be returned by the appropriate wizard
+function. The usage of these wizard functions is the following:
*/
Modified: hugo/trunk/lemon/bfs.h
==============================================================================
--- hugo/trunk/lemon/bfs.h (original)
+++ hugo/trunk/lemon/bfs.h Mon Jul 4 18:27:54 2005
@@ -84,9 +84,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -659,7 +663,7 @@
///Copies the shortest path to \c t into \c p
///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
+ ///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,
@@ -770,9 +774,13 @@
///Instantiates a PredMap.
///This function instantiates a \ref PredMap.
- ///\param G is the graph, to which we would like to define the PredMap.
+ ///\param g is the graph, to which we would like to define the PredMap.
///\todo The graph alone may be insufficient to initialize
+#ifdef DOXYGEN
+ static PredMap *createPredMap(const GR &g)
+#else
static PredMap *createPredMap(const GR &)
+#endif
{
return new PredMap();
}
@@ -803,9 +811,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -833,8 +845,12 @@
///Instantiates a DistMap.
///This function instantiates a \ref DistMap.
- ///\param G is the graph, to which we would like to define the \ref DistMap
+ ///\param g is the graph, to which we would like to define the \ref DistMap
+#ifdef DOXYGEN
+ static DistMap *createDistMap(const GR &g)
+#else
static DistMap *createDistMap(const GR &)
+#endif
{
return new DistMap();
}
Modified: hugo/trunk/lemon/dfs.h
==============================================================================
--- hugo/trunk/lemon/dfs.h (original)
+++ hugo/trunk/lemon/dfs.h Mon Jul 4 18:27:54 2005
@@ -84,9 +84,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -779,9 +783,13 @@
///Instantiates a PredMap.
///This function instantiates a \ref PredMap.
- ///\param G is the graph, to which we would like to define the PredMap.
+ ///\param g is the graph, to which we would like to define the PredMap.
///\todo The graph alone may be insufficient to initialize
+#ifdef DOXYGEN
+ static PredMap *createPredMap(const GR &g)
+#else
static PredMap *createPredMap(const GR &)
+#endif
{
return new PredMap();
}
@@ -812,9 +820,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -842,8 +854,12 @@
///Instantiates a DistMap.
///This function instantiates a \ref DistMap.
- ///\param G is the graph, to which we would like to define the \ref DistMap
+ ///\param g is the graph, to which we would like to define the \ref DistMap
+#ifdef DOXYGEN
+ static DistMap *createDistMap(const GR &g)
+#else
static DistMap *createDistMap(const GR &)
+#endif
{
return new DistMap();
}
Modified: hugo/trunk/lemon/dijkstra.h
==============================================================================
--- hugo/trunk/lemon/dijkstra.h (original)
+++ hugo/trunk/lemon/dijkstra.h Mon Jul 4 18:27:54 2005
@@ -108,9 +108,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -663,7 +667,7 @@
///Copies the shortest path to \c t into \c p
///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
+ ///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,
@@ -788,9 +792,13 @@
///Instantiates a PredMap.
///This function instantiates a \ref PredMap.
- ///\param G is the graph, to which we would like to define the PredMap.
+ ///\param g is the graph, to which we would like to define the PredMap.
///\todo The graph alone may be insufficient for the initialization
+#ifdef DOXYGEN
+ static PredMap *createPredMap(const GR &g)
+#else
static PredMap *createPredMap(const GR &)
+#endif
{
return new PredMap();
}
@@ -806,9 +814,13 @@
///Instantiates a ProcessedMap.
///This function instantiates a \ref ProcessedMap.
- ///\param G is the graph, to which
+ ///\param g is the graph, to which
///we would like to define the \ref ProcessedMap
+#ifdef DOXYGEN
+ static ProcessedMap *createProcessedMap(const GR &g)
+#else
static ProcessedMap *createProcessedMap(const GR &)
+#endif
{
return new ProcessedMap();
}
@@ -821,8 +833,12 @@
///Instantiates a DistMap.
///This function instantiates a \ref DistMap.
- ///\param G is the graph, to which we would like to define the \ref DistMap
+ ///\param g is the graph, to which we would like to define the \ref DistMap
+#ifdef DOXYGEN
+ static DistMap *createDistMap(const GR &g)
+#else
static DistMap *createDistMap(const GR &)
+#endif
{
return new DistMap();
}
Modified: hugo/trunk/lemon/error.h
==============================================================================
--- hugo/trunk/lemon/error.h (original)
+++ hugo/trunk/lemon/error.h Mon Jul 4 18:27:54 2005
@@ -100,7 +100,9 @@
class ErrorMessage {
protected:
///\e
- ///\todo The good solution is boost:shared_ptr...
+
+ ///\todo The good solution is boost::shared_ptr...
+ ///
mutable
std::auto_ptr<std::ostringstream> buf;
Modified: hugo/trunk/lemon/graph_adaptor.h
==============================================================================
--- hugo/trunk/lemon/graph_adaptor.h (original)
+++ hugo/trunk/lemon/graph_adaptor.h Mon Jul 4 18:27:54 2005
@@ -451,7 +451,7 @@
only such edges is a shortest one. Thus we have to compute a maximum number
of edge-disjoint paths between \c s and \c t in the graph which has edge-set
all the tight edges. The computation will be demonstrated on the following
- graph, which is read from the dimacs file \ref sub_graph_adaptor_demo.dim.
+ graph, which is read from the dimacs file \c sub_graph_adaptor_demo.dim.
The full source code is available in \ref sub_graph_adaptor_demo.cc.
If you are interested in more demo programs, you can use
\ref dim_to_dot.cc to generate .dot files from dimacs files.
Modified: hugo/trunk/lemon/graph_utils.h
==============================================================================
--- hugo/trunk/lemon/graph_utils.h (original)
+++ hugo/trunk/lemon/graph_utils.h Mon Jul 4 18:27:54 2005
@@ -177,7 +177,7 @@
/// ...
/// }
/// \endcode
- /// \todo We may want to use the \ref concept::GraphBase "GraphBase"
+ /// \todo We may want to use the "GraphBase"
/// interface here...
/// \bug Untested ...
template <typename Graph>
@@ -859,10 +859,10 @@
/// \brief The subscript operator.
///
/// The subscript operator.
- /// \param edge The edge
+ /// \param e The edge
/// \return The target of the edge
- Value operator[](const Key& key) {
- return graph.target(key);
+ Value operator[](const Key& e) {
+ return graph.target(e);
}
private:
Modified: hugo/trunk/lemon/lp_base.h
==============================================================================
--- hugo/trunk/lemon/lp_base.h (original)
+++ hugo/trunk/lemon/lp_base.h Mon Jul 4 18:27:54 2005
@@ -399,8 +399,8 @@
///Reference to the lower bound.
///\return
- ///- -\ref INF: the constraint is lower unbounded.
- ///- -\ref NaN: lower bound has not been set.
+ ///- \ref INF "INF": the constraint is lower unbounded.
+ ///- \ref NaN "NaN": lower bound has not been set.
///- finite number: the lower bound
Value &lowerBound() { return _lb; }
///The const version of \ref lowerBound()
@@ -408,8 +408,8 @@
///Reference to the upper bound.
///\return
- ///- -\ref INF: the constraint is upper unbounded.
- ///- -\ref NaN: upper bound has not been set.
+ ///- \ref INF "INF": the constraint is upper unbounded.
+ ///- \ref NaN "NaN": upper bound has not been set.
///- finite number: the upper bound
Value &upperBound() { return _ub; }
///The const version of \ref upperBound()
Modified: hugo/trunk/lemon/maps.h
==============================================================================
--- hugo/trunk/lemon/maps.h (original)
+++ hugo/trunk/lemon/maps.h Mon Jul 4 18:27:54 2005
@@ -227,15 +227,6 @@
///converts the \c Value of a maps to type \c T.
///Its \c Value is inherited from \c M.
///
- ///Actually,
- ///\code
- /// ConvertMap<X> sh(x,v);
- ///\endcode
- ///it is equivalent with
- ///\code
- /// ConstMap<X::Key, X::Value> c_tmp(v);
- /// AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
- ///\endcode
///\bug wrong documentation
template<class M, class T>
class ConvertMap {
@@ -252,14 +243,13 @@
///Constructor
///Constructor
- ///\param _m is the undelying map
- ///\param _v is the convert value
+ ///\param _m is the underlying map
ConvertMap(const M &_m) : m(_m) {};
/// \brief The subscript operator.
///
/// The subscript operator.
- /// \param edge The edge
+ /// \param k The key
/// \return The target of the edge
Value operator[](Key k) const {return m[k];}
};
@@ -297,9 +287,6 @@
typedef typename M1::Value Value;
///Constructor
-
- ///\e
- ///
AddMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
Value operator[](Key k) const {return m1[k]+m2[k];}
};
@@ -386,9 +373,6 @@
typedef typename M1::Value Value;
///Constructor
-
- ///\e
- ///
SubMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
Value operator[](Key k) const {return m1[k]-m2[k];}
};
@@ -426,9 +410,6 @@
typedef typename M1::Value Value;
///Constructor
-
- ///\e
- ///
MulMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
Value operator[](Key k) const {return m1[k]*m2[k];}
};
@@ -512,9 +493,6 @@
typedef typename M1::Value Value;
///Constructor
-
- ///\e
- ///
DivMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
Value operator[](Key k) const {return m1[k]/m2[k];}
};
@@ -560,9 +538,6 @@
typedef typename M1::Value Value;
///Constructor
-
- ///\e
- ///
ComposeMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
Value operator[](Key k) const {return m1[m2[k]];}
};
@@ -615,9 +590,6 @@
typedef V Value;
///Constructor
-
- ///\e
- ///
CombineMap(const M1 &_m1,const M2 &_m2,const F &_f)
: m1(_m1), m2(_m2), f(_f) {};
Value operator[](Key k) const {return f(m1[k],m2[k]);}
@@ -666,9 +638,6 @@
typedef typename M::Value Value;
///Constructor
-
- ///\e
- ///
NegMap(const M &_m) : m(_m) {};
Value operator[](Key k) const {return -m[k];}
};
@@ -720,9 +689,6 @@
typedef typename M::Value Value;
///Constructor
-
- ///\e
- ///
AbsMap(const M &_m) : m(_m) {};
Value operator[](Key k) const {Value tmp=m[k]; return tmp>=0?tmp:-tmp;}
};
@@ -763,9 +729,6 @@
typedef V Value;
///Constructor
-
- ///\e
- ///
FunctorMap(const F &_f) : f(_f) {};
Value operator[](Key k) const {return f(k);}
};
More information about the Lemon-commits
mailing list