author Peter Kovacs Thu, 07 May 2009 02:07:59 +0200 changeset 651 3adf5e2d1e62 parent 646 e01957e96c67 child 652 e2f99a473998
Small doc improvements (#257)
 doc/groups.dox file | annotate | diff | comparison | revisions doc/mainpage.dox file | annotate | diff | comparison | revisions lemon/matching.h file | annotate | diff | comparison | revisions
     1.1 --- a/doc/groups.dox	Wed Apr 29 19:22:14 2009 +0100
1.2 +++ b/doc/groups.dox	Thu May 07 02:07:59 2009 +0200
1.3 @@ -335,8 +335,13 @@
1.4
1.5  In most cases the \ref Preflow "Preflow" algorithm provides the
1.6  fastest method for computing a maximum flow. All implementations
1.7 -provides functions to also query the minimum cut, which is the dual
1.8 -problem of the maximum flow.
1.9 +also provide functions to query the minimum cut, which is the dual
1.10 +problem of maximum flow.
1.11 +
1.12 +\ref Circulation is a preflow push-relabel algorithm implemented directly
1.13 +for finding feasible circulations, which is a somewhat different problem,
1.14 +but it is strongly related to maximum flow.
1.15 +For more information, see \ref Circulation.
1.16  */
1.17
1.18  /**
1.19 @@ -541,10 +546,10 @@
1.20  /**
1.21  @defgroup spantree Minimum Spanning Tree Algorithms
1.22  @ingroup algs
1.23 -\brief Algorithms for finding a minimum cost spanning tree in a graph.
1.24 +\brief Algorithms for finding minimum cost spanning trees and arborescences.
1.25
1.26 -This group contains the algorithms for finding a minimum cost spanning
1.27 -tree in a graph.
1.28 +This group contains the algorithms for finding minimum cost spanning
1.29 +trees and arborescences.
1.30  */
1.31
1.32  /**

     2.1 --- a/doc/mainpage.dox	Wed Apr 29 19:22:14 2009 +0100
2.2 +++ b/doc/mainpage.dox	Thu May 07 02:07:59 2009 +0200
2.3 @@ -41,14 +41,10 @@
2.4
2.5  \subsection howtoread How to read the documentation
2.6
2.7 -If you want to get a quick start and see the most important features then
2.8 -take a look at our \ref quicktour
2.9 -"Quick Tour to LEMON" which will guide you along.
2.10 -
2.11 -If you already feel like using our library, see the
2.12 +If you would like to get to know the library, see
2.13  <a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
2.14
2.15 -If you know what you are looking for then try to find it under the
2.16 +If you know what you are looking for, then try to find it under the
2.17  <a class="el" href="modules.html">Modules</a> section.
2.18
2.19  If you are a user of the old (0.x) series of LEMON, please check out the

     3.1 --- a/lemon/matching.h	Wed Apr 29 19:22:14 2009 +0100
3.2 +++ b/lemon/matching.h	Thu May 07 02:07:59 2009 +0200
3.3 @@ -499,7 +499,7 @@
3.4      ///
3.5      /// This function runs the original Edmonds' algorithm.
3.6      ///
3.7 -    /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be
3.8 +    /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be
3.9      /// called before using this function.
3.10      void startSparse() {
3.11        for(NodeIt n(_graph); n != INVALID; ++n) {
3.12 @@ -518,7 +518,7 @@
3.13      /// This function runs Edmonds' algorithm with a heuristic of postponing
3.14      /// shrinks, therefore resulting in a faster algorithm for dense graphs.
3.15      ///
3.16 -    /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be
3.17 +    /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be
3.18      /// called before using this function.
3.19      void startDense() {
3.20        for(NodeIt n(_graph); n != INVALID; ++n) {