Trim the documentation 1.3
authorAlpar Juttner <alpar@cs.elte.hu>
Fri, 09 Aug 2013 18:56:00 +0200
branch1.3
changeset 1095fbdde70389da
parent 1094 00f6088403c0
child 1097 57ab090b6109
Trim the documentation
doc/groups.dox
     1.1 --- a/doc/groups.dox	Fri Aug 09 14:39:40 2013 +0200
     1.2 +++ b/doc/groups.dox	Fri Aug 09 18:56:00 2013 +0200
     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 -  \cite edmondskarp72theoretical.
    1.36 -- \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm
    1.37 -  \cite goldberg88newapproach.
    1.38 -- \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees
    1.39 -  \cite dinic70algorithm, \cite sleator83dynamic.
    1.40 -- \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees
    1.41 -  \cite goldberg88newapproach, \cite 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 \cite 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 @@ -519,16 +497,6 @@
    1.55  maximum cardinality matching.
    1.56  
    1.57  The matching algorithms implemented in LEMON:
    1.58 -- \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm
    1.59 -  for calculating maximum cardinality matching in bipartite graphs.
    1.60 -- \ref PrBipartiteMatching Push-relabel algorithm
    1.61 -  for calculating maximum cardinality matching in bipartite graphs.
    1.62 -- \ref MaxWeightedBipartiteMatching
    1.63 -  Successive shortest path algorithm for calculating maximum weighted
    1.64 -  matching and maximum weighted bipartite matching in bipartite graphs.
    1.65 -- \ref MinCostMaxBipartiteMatching
    1.66 -  Successive shortest path algorithm for calculating minimum cost maximum
    1.67 -  matching in bipartite graphs.
    1.68  - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating
    1.69    maximum cardinality matching in general graphs.
    1.70  - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating
    1.71 @@ -653,23 +621,6 @@
    1.72  */
    1.73  
    1.74  /**
    1.75 -@defgroup lp_utils Tools for Lp and Mip Solvers
    1.76 -@ingroup lp_group
    1.77 -\brief Helper tools to the Lp and Mip solvers.
    1.78 -
    1.79 -This group adds some helper tools to general optimization framework
    1.80 -implemented in LEMON.
    1.81 -*/
    1.82 -
    1.83 -/**
    1.84 -@defgroup metah Metaheuristics
    1.85 -@ingroup gen_opt_group
    1.86 -\brief Metaheuristics for LEMON library.
    1.87 -
    1.88 -This group contains some metaheuristic optimization tools.
    1.89 -*/
    1.90 -
    1.91 -/**
    1.92  @defgroup utils Tools and Utilities
    1.93  \brief Tools and utilities for programming in LEMON
    1.94