# HG changeset patch # User Peter Kovacs # Date 1241654879 -7200 # Node ID 3adf5e2d1e62e87e255185722497c068d6fa93c0 # Parent e01957e96c6796a11d9f3bbf751eea8ae274221c Small doc improvements (#257) diff -r e01957e96c67 -r 3adf5e2d1e62 doc/groups.dox --- a/doc/groups.dox Wed Apr 29 19:22:14 2009 +0100 +++ b/doc/groups.dox Thu May 07 02:07:59 2009 +0200 @@ -335,8 +335,13 @@ In most cases the \ref Preflow "Preflow" algorithm provides the fastest method for computing a maximum flow. All implementations -provides functions to also query the minimum cut, which is the dual -problem of the maximum flow. +also provide functions to query the minimum cut, which is the dual +problem of maximum flow. + +\ref Circulation is a preflow push-relabel algorithm implemented directly +for finding feasible circulations, which is a somewhat different problem, +but it is strongly related to maximum flow. +For more information, see \ref Circulation. */ /** @@ -541,10 +546,10 @@ /** @defgroup spantree Minimum Spanning Tree Algorithms @ingroup algs -\brief Algorithms for finding a minimum cost spanning tree in a graph. +\brief Algorithms for finding minimum cost spanning trees and arborescences. -This group contains the algorithms for finding a minimum cost spanning -tree in a graph. +This group contains the algorithms for finding minimum cost spanning +trees and arborescences. */ /** diff -r e01957e96c67 -r 3adf5e2d1e62 doc/mainpage.dox --- a/doc/mainpage.dox Wed Apr 29 19:22:14 2009 +0100 +++ b/doc/mainpage.dox Thu May 07 02:07:59 2009 +0200 @@ -41,14 +41,10 @@ \subsection howtoread How to read the documentation -If you want to get a quick start and see the most important features then -take a look at our \ref quicktour -"Quick Tour to LEMON" which will guide you along. - -If you already feel like using our library, see the +If you would like to get to know the library, see LEMON Tutorial. -If you know what you are looking for then try to find it under the +If you know what you are looking for, then try to find it under the Modules section. If you are a user of the old (0.x) series of LEMON, please check out the diff -r e01957e96c67 -r 3adf5e2d1e62 lemon/matching.h --- a/lemon/matching.h Wed Apr 29 19:22:14 2009 +0100 +++ b/lemon/matching.h Thu May 07 02:07:59 2009 +0200 @@ -499,7 +499,7 @@ /// /// This function runs the original Edmonds' algorithm. /// - /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be + /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be /// called before using this function. void startSparse() { for(NodeIt n(_graph); n != INVALID; ++n) { @@ -518,7 +518,7 @@ /// This function runs Edmonds' algorithm with a heuristic of postponing /// shrinks, therefore resulting in a faster algorithm for dense graphs. /// - /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be + /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be /// called before using this function. void startDense() { for(NodeIt n(_graph); n != INVALID; ++n) {