1.1 --- a/doc/named-param.dox Thu Aug 11 13:20:52 2005 +0000
1.2 +++ b/doc/named-param.dox Thu Aug 11 14:31:06 2005 +0000
1.3 @@ -1,8 +1,8 @@
1.4 -*!
1.5 +/*!
1.6
1.7 \page named-param Named Parameters
1.8
1.9 -\section named-func-param Named "Function" Parameters
1.10 +\section named-func-param Named Function Parameters
1.11
1.12 C++ makes it possible to use default parameter values when calling a
1.13 function. In such a case we do not have to give value for parameters,
1.14 @@ -42,24 +42,27 @@
1.15
1.16 The usage is the following.
1.17
1.18 -We have to define a class, let's call it named_fn. Let us assume that
1.19 -we would like to use a parameter, called X. In the named_fn class we
1.20 -have to define an _X attribute, and a function X. The function
1.21 -expects a parameter with the type of _X, and sets the value of
1.22 -_X. After setting the value the function returns the class itself. The
1.23 -class also have to have a function, called for example run(), we have
1.24 +We have to define a class, let's call it \c named_fn. Let us assume that
1.25 +we would like to use a parameter, called \c X. In the \c named_fn class we
1.26 +have to define an \c _X attribute, and a function \c X. The function
1.27 +expects a parameter with the type of \c _X, and sets the value of
1.28 +\c _X. After setting the value the function returns the class itself. The
1.29 +class also have to have a function, called for example <tt>run()</tt>, we have
1.30 to implement here the original function itself. The constructor of the
1.31 -class have to give all the attributes like _X the default values of
1.32 +class have to give all the attributes like \c _X the default values of
1.33 them.
1.34
1.35 If we instantiate this class, the default values will be set for the
1.36 attributes (originally the parameters), initially. If we call function
1.37 -X, we get a class with the modified parameter value of
1.38 -X. Therefore we can modify any parameter-value, independent from the
1.39 -order. To run the algorithm we have to call the run() function at the
1.40 +\c X, we get a class with the modified parameter value of
1.41 +\c X. Therefore we can modify any parameter-value, independent from the
1.42 +order. To run the algorithm we have to call the <tt>run()</tt> function at the
1.43 end of the row.
1.44
1.45 -Example: named_fn().id(3).val(2).run();
1.46 +Example:
1.47 +\code
1.48 +named_fn().id(3).val(2).run();
1.49 +\endcode
1.50
1.51 \section traits-classes Traits Classes
1.52
1.53 @@ -92,7 +95,7 @@
1.54 The result will be an instantiated Dijkstra class, in which the
1.55 DistMap and the PredMap is modified.
1.56
1.57 -\section named-templ-func-param Named "Function" Template Parameters
1.58 +\section named-templ-func-param Named Function Template Parameters
1.59
1.60 If the class has so called wizard functions, the new class with the
1.61 modified tpye of attributes can be returned by the appropriate wizard
2.1 --- a/lemon/bfs.h Thu Aug 11 13:20:52 2005 +0000
2.2 +++ b/lemon/bfs.h Thu Aug 11 14:31:06 2005 +0000
2.3 @@ -265,8 +265,7 @@
2.4 ///\ref named-templ-param "Named parameter" for setting PredMap type
2.5 ///
2.6 template <class T>
2.7 - class DefPredMap : public Bfs< Graph,
2.8 - DefPredMapTraits<T> > { };
2.9 + class DefPredMap : public Bfs< Graph, DefPredMapTraits<T> > { };
2.10
2.11 // template <class T>
2.12 // struct DefPredNodeMapTraits : public Traits {
3.1 --- a/lemon/concept/graph.h Thu Aug 11 13:20:52 2005 +0000
3.2 +++ b/lemon/concept/graph.h Thu Aug 11 14:31:06 2005 +0000
3.3 @@ -314,8 +314,6 @@
3.4
3.5 /// This constructor sets the iterator to the first outgoing edge of
3.6 /// the node.
3.7 - ///@param n the node
3.8 - ///@param g the graph
3.9 OutEdgeIt(const StaticGraph&, const Node&) { }
3.10 /// Edge -> OutEdgeIt conversion
3.11
3.12 @@ -363,8 +361,6 @@
3.13
3.14 /// This constructor set the iterator to the first incoming edge of
3.15 /// the node.
3.16 - ///@param n the node
3.17 - ///@param g the graph
3.18 InEdgeIt(const StaticGraph&, const Node&) { }
3.19 /// Edge -> InEdgeIt conversion
3.20
4.1 --- a/lemon/concept/path.h Thu Aug 11 13:20:52 2005 +0000
4.2 +++ b/lemon/concept/path.h Thu Aug 11 14:31:06 2005 +0000
4.3 @@ -52,9 +52,9 @@
4.4 class NodeIt;
4.5 class EdgeIt;
4.6
4.7 - /// \param _G The graph in which the path is.
4.8 + /// \param _g The graph in which the path is.
4.9 ///
4.10 - Path(const Graph &) {}
4.11 + Path(const Graph &_g) {}
4.12
4.13 /// Length of the path.
4.14 int length() const {return 0;}
4.15 @@ -181,7 +181,7 @@
4.16
4.17 Path &P;
4.18
4.19 - ///\param _P the path you want to fill in.
4.20 + ///\param _p the path you want to fill in.
4.21 ///
4.22
4.23 Builder(Path &_p) : P(_p) {}
5.1 --- a/lemon/concept/undir_graph.h Thu Aug 11 13:20:52 2005 +0000
5.2 +++ b/lemon/concept/undir_graph.h Thu Aug 11 14:31:06 2005 +0000
5.3 @@ -314,7 +314,6 @@
5.4 /// This constructor sets the iterator to the first edge.
5.5
5.6 /// This constructor sets the iterator to the first edge of \c g.
5.7 - ///@param g the graph
5.8 UndirEdgeIt(const UndirGraph&) { }
5.9 /// UndirEdge -> UndirEdgeIt conversion
5.10
5.11 @@ -362,8 +361,6 @@
5.12
5.13 /// This constructor set the iterator to the first incident edge of
5.14 /// the node.
5.15 - ///@param n the node
5.16 - ///@param g the graph
5.17 IncEdgeIt(const UndirGraph&, const Node&) { }
5.18 /// UndirEdge -> IncEdgeIt conversion
5.19