Trim the documentation (#359) 1.2
authorPeter Kovacs <kpeter@inf.elte.hu>
Thu, 18 Mar 2010 00:29:35 +0100
branch1.2
changeset 8827af2ae7c1428
parent 878 f802439d2b58
child 884 3ed8f7c8bed8
Trim the documentation (#359)
doc/groups.dox
     1.1 --- a/doc/groups.dox	Wed Mar 17 14:07:28 2010 +0100
     1.2 +++ b/doc/groups.dox	Thu Mar 18 00:29:35 2010 +0100
     1.3 @@ -294,14 +294,6 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 -@defgroup matrices Matrices
     1.8 -@ingroup auxdat
     1.9 -\brief Two dimensional data storages implemented in LEMON.
    1.10 -
    1.11 -This group contains two dimensional data storages implemented in LEMON.
    1.12 -*/
    1.13 -
    1.14 -/**
    1.15  @defgroup algs Algorithms
    1.16  \brief This group contains the several algorithms
    1.17  implemented in LEMON.
    1.18 @@ -334,10 +326,6 @@
    1.19     from a source node when arc lenghts can be either positive or negative,
    1.20     but the digraph should not contain directed cycles with negative total
    1.21     length.
    1.22 - - \ref FloydWarshall "Floyd-Warshall" and \ref Johnson "Johnson" algorithms
    1.23 -   for solving the \e all-pairs \e shortest \e paths \e problem when arc
    1.24 -   lenghts can be either positive or negative, but the digraph should
    1.25 -   not contain directed cycles with negative total length.
    1.26   - \ref Suurballe A successive shortest path algorithm for finding
    1.27     arc-disjoint paths between two nodes having minimum total length.
    1.28  */
    1.29 @@ -371,20 +359,10 @@
    1.30      \quad \forall u\in V\setminus\{s,t\} \f]
    1.31  \f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f]
    1.32  
    1.33 -LEMON contains several algorithms for solving maximum flow problems:
    1.34 -- \ref EdmondsKarp Edmonds-Karp algorithm
    1.35 -  \ref edmondskarp72theoretical.
    1.36 -- \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm
    1.37 -  \ref goldberg88newapproach.
    1.38 -- \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees
    1.39 -  \ref dinic70algorithm, \ref sleator83dynamic.
    1.40 -- \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees
    1.41 -  \ref goldberg88newapproach, \ref sleator83dynamic.
    1.42 -
    1.43 -In most cases the \ref Preflow algorithm provides the
    1.44 -fastest method for computing a maximum flow. All implementations
    1.45 -also provide functions to query the minimum cut, which is the dual
    1.46 -problem of maximum flow.
    1.47 +\ref Preflow is an efficient implementation of Goldberg-Tarjan's
    1.48 +preflow push-relabel algorithm \ref goldberg88newapproach for finding
    1.49 +maximum flows. It also provides functions to query the minimum cut,
    1.50 +which is the dual problem of maximum flow.
    1.51  
    1.52  \ref Circulation is a preflow push-relabel algorithm implemented directly
    1.53  for finding feasible circulations, which is a somewhat different problem,
    1.54 @@ -441,8 +419,6 @@
    1.55  
    1.56  - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
    1.57    in directed graphs.
    1.58 -- \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
    1.59 -  calculating minimum cut in undirected graphs.
    1.60  - \ref GomoryHu "Gomory-Hu tree computation" for calculating
    1.61    all-pairs minimum cut in undirected graphs.
    1.62  
    1.63 @@ -505,16 +481,6 @@
    1.64  maximum cardinality matching.
    1.65  
    1.66  The matching algorithms implemented in LEMON:
    1.67 -- \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm
    1.68 -  for calculating maximum cardinality matching in bipartite graphs.
    1.69 -- \ref PrBipartiteMatching Push-relabel algorithm
    1.70 -  for calculating maximum cardinality matching in bipartite graphs.
    1.71 -- \ref MaxWeightedBipartiteMatching
    1.72 -  Successive shortest path algorithm for calculating maximum weighted
    1.73 -  matching and maximum weighted bipartite matching in bipartite graphs.
    1.74 -- \ref MinCostMaxBipartiteMatching
    1.75 -  Successive shortest path algorithm for calculating minimum cost maximum
    1.76 -  matching in bipartite graphs.
    1.77  - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating
    1.78    maximum cardinality matching in general graphs.
    1.79  - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating
    1.80 @@ -559,15 +525,6 @@
    1.81  */
    1.82  
    1.83  /**
    1.84 -@defgroup approx Approximation Algorithms
    1.85 -@ingroup algs
    1.86 -\brief Approximation algorithms.
    1.87 -
    1.88 -This group contains the approximation and heuristic algorithms
    1.89 -implemented in LEMON.
    1.90 -*/
    1.91 -
    1.92 -/**
    1.93  @defgroup auxalg Auxiliary Algorithms
    1.94  @ingroup algs
    1.95  \brief Auxiliary algorithms implemented in LEMON.
    1.96 @@ -599,23 +556,6 @@
    1.97  */
    1.98  
    1.99  /**
   1.100 -@defgroup lp_utils Tools for Lp and Mip Solvers
   1.101 -@ingroup lp_group
   1.102 -\brief Helper tools to the Lp and Mip solvers.
   1.103 -
   1.104 -This group adds some helper tools to general optimization framework
   1.105 -implemented in LEMON.
   1.106 -*/
   1.107 -
   1.108 -/**
   1.109 -@defgroup metah Metaheuristics
   1.110 -@ingroup gen_opt_group
   1.111 -\brief Metaheuristics for LEMON library.
   1.112 -
   1.113 -This group contains some metaheuristic optimization tools.
   1.114 -*/
   1.115 -
   1.116 -/**
   1.117  @defgroup utils Tools and Utilities
   1.118  \brief Tools and utilities for programming in LEMON
   1.119