# HG changeset patch # User Alpar Juttner # Date 1376067360 -7200 # Node ID fbdde70389dae32969982eb47116c91b77d3a2be # Parent 00f6088403c00795d6889ebe9ba0f28e9a713092 Trim the documentation diff -r 00f6088403c0 -r fbdde70389da doc/groups.dox --- a/doc/groups.dox Fri Aug 09 14:39:40 2013 +0200 +++ b/doc/groups.dox Fri Aug 09 18:56:00 2013 +0200 @@ -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 - \cite edmondskarp72theoretical. -- \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm - \cite goldberg88newapproach. -- \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees - \cite dinic70algorithm, \cite sleator83dynamic. -- \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees - \cite goldberg88newapproach, \cite 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 \cite 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, @@ -519,16 +497,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 @@ -653,23 +621,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