# HG changeset patch # User Peter Kovacs # Date 1268868575 -3600 # Node ID 7af2ae7c14284cae104937abf8341e22133d29b5 # Parent f802439d2b588218e0fdcc5826a855b8f7c185ce Trim the documentation (#359) diff -r f802439d2b58 -r 7af2ae7c1428 doc/groups.dox --- a/doc/groups.dox Wed Mar 17 14:07:28 2010 +0100 +++ b/doc/groups.dox Thu Mar 18 00:29:35 2010 +0100 @@ -294,14 +294,6 @@ */ /** -@defgroup matrices Matrices -@ingroup auxdat -\brief Two dimensional data storages implemented in LEMON. - -This group contains two dimensional data storages implemented in LEMON. -*/ - -/** @defgroup algs Algorithms \brief This group contains the several algorithms implemented in LEMON. @@ -334,10 +326,6 @@ from a source node when arc lenghts can be either positive or negative, but the digraph should not contain directed cycles with negative total length. - - \ref FloydWarshall "Floyd-Warshall" and \ref Johnson "Johnson" algorithms - for solving the \e all-pairs \e shortest \e paths \e problem when arc - lenghts can be either positive or negative, but the digraph should - not contain directed cycles with negative total length. - \ref Suurballe A successive shortest path algorithm for finding arc-disjoint paths between two nodes having minimum total length. */ @@ -371,20 +359,10 @@ \quad \forall u\in V\setminus\{s,t\} \f] \f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f] -LEMON contains several algorithms for solving maximum flow problems: -- \ref EdmondsKarp Edmonds-Karp algorithm - \ref edmondskarp72theoretical. -- \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm - \ref goldberg88newapproach. -- \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees - \ref dinic70algorithm, \ref sleator83dynamic. -- \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees - \ref goldberg88newapproach, \ref sleator83dynamic. - -In most cases the \ref Preflow algorithm provides the -fastest method for computing a maximum flow. All implementations -also provide functions to query the minimum cut, which is the dual -problem of maximum flow. +\ref Preflow is an efficient implementation of Goldberg-Tarjan's +preflow push-relabel algorithm \ref goldberg88newapproach for finding +maximum flows. It also provides 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, @@ -441,8 +419,6 @@ - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut in directed graphs. -- \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for - calculating minimum cut in undirected graphs. - \ref GomoryHu "Gomory-Hu tree computation" for calculating all-pairs minimum cut in undirected graphs. @@ -505,16 +481,6 @@ maximum cardinality matching. The matching algorithms implemented in LEMON: -- \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm - for calculating maximum cardinality matching in bipartite graphs. -- \ref PrBipartiteMatching Push-relabel algorithm - for calculating maximum cardinality matching in bipartite graphs. -- \ref MaxWeightedBipartiteMatching - Successive shortest path algorithm for calculating maximum weighted - matching and maximum weighted bipartite matching in bipartite graphs. -- \ref MinCostMaxBipartiteMatching - Successive shortest path algorithm for calculating minimum cost maximum - matching in bipartite graphs. - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating maximum cardinality matching in general graphs. - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating @@ -559,15 +525,6 @@ */ /** -@defgroup approx Approximation Algorithms -@ingroup algs -\brief Approximation algorithms. - -This group contains the approximation and heuristic algorithms -implemented in LEMON. -*/ - -/** @defgroup auxalg Auxiliary Algorithms @ingroup algs \brief Auxiliary algorithms implemented in LEMON. @@ -599,23 +556,6 @@ */ /** -@defgroup lp_utils Tools for Lp and Mip Solvers -@ingroup lp_group -\brief Helper tools to the Lp and Mip solvers. - -This group adds some helper tools to general optimization framework -implemented in LEMON. -*/ - -/** -@defgroup metah Metaheuristics -@ingroup gen_opt_group -\brief Metaheuristics for LEMON library. - -This group contains some metaheuristic optimization tools. -*/ - -/** @defgroup utils Tools and Utilities \brief Tools and utilities for programming in LEMON