COIN-OR::LEMON - Graph Library

Changeset 882:7af2ae7c1428 in lemon-1.2 for doc/groups.dox


Ignore:
Timestamp:
03/18/10 00:29:35 (9 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
1.2
Phase:
public
Message:

Trim the documentation (#359)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r877 r882  
    295295
    296296/**
    297 @defgroup matrices Matrices
    298 @ingroup auxdat
    299 \brief Two dimensional data storages implemented in LEMON.
    300 
    301 This group contains two dimensional data storages implemented in LEMON.
    302 */
    303 
    304 /**
    305297@defgroup algs Algorithms
    306298\brief This group contains the several algorithms
     
    335327   but the digraph should not contain directed cycles with negative total
    336328   length.
    337  - \ref FloydWarshall "Floyd-Warshall" and \ref Johnson "Johnson" algorithms
    338    for solving the \e all-pairs \e shortest \e paths \e problem when arc
    339    lenghts can be either positive or negative, but the digraph should
    340    not contain directed cycles with negative total length.
    341329 - \ref Suurballe A successive shortest path algorithm for finding
    342330   arc-disjoint paths between two nodes having minimum total length.
     
    372360\f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f]
    373361
    374 LEMON contains several algorithms for solving maximum flow problems:
    375 - \ref EdmondsKarp Edmonds-Karp algorithm
    376   \ref edmondskarp72theoretical.
    377 - \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm
    378   \ref goldberg88newapproach.
    379 - \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees
    380   \ref dinic70algorithm, \ref sleator83dynamic.
    381 - \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees
    382   \ref goldberg88newapproach, \ref sleator83dynamic.
    383 
    384 In most cases the \ref Preflow algorithm provides the
    385 fastest method for computing a maximum flow. All implementations
    386 also provide functions to query the minimum cut, which is the dual
    387 problem of maximum flow.
     362\ref Preflow is an efficient implementation of Goldberg-Tarjan's
     363preflow push-relabel algorithm \ref goldberg88newapproach for finding
     364maximum flows. It also provides functions to query the minimum cut,
     365which is the dual problem of maximum flow.
    388366
    389367\ref Circulation is a preflow push-relabel algorithm implemented directly
     
    442420- \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
    443421  in directed graphs.
    444 - \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
    445   calculating minimum cut in undirected graphs.
    446422- \ref GomoryHu "Gomory-Hu tree computation" for calculating
    447423  all-pairs minimum cut in undirected graphs.
     
    506482
    507483The matching algorithms implemented in LEMON:
    508 - \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm
    509   for calculating maximum cardinality matching in bipartite graphs.
    510 - \ref PrBipartiteMatching Push-relabel algorithm
    511   for calculating maximum cardinality matching in bipartite graphs.
    512 - \ref MaxWeightedBipartiteMatching
    513   Successive shortest path algorithm for calculating maximum weighted
    514   matching and maximum weighted bipartite matching in bipartite graphs.
    515 - \ref MinCostMaxBipartiteMatching
    516   Successive shortest path algorithm for calculating minimum cost maximum
    517   matching in bipartite graphs.
    518484- \ref MaxMatching Edmond's blossom shrinking algorithm for calculating
    519485  maximum cardinality matching in general graphs.
     
    560526
    561527/**
    562 @defgroup approx Approximation Algorithms
    563 @ingroup algs
    564 \brief Approximation algorithms.
    565 
    566 This group contains the approximation and heuristic algorithms
    567 implemented in LEMON.
    568 */
    569 
    570 /**
    571528@defgroup auxalg Auxiliary Algorithms
    572529@ingroup algs
     
    597554The currently supported solvers are \ref glpk, \ref clp, \ref cbc,
    598555\ref cplex, \ref soplex.
    599 */
    600 
    601 /**
    602 @defgroup lp_utils Tools for Lp and Mip Solvers
    603 @ingroup lp_group
    604 \brief Helper tools to the Lp and Mip solvers.
    605 
    606 This group adds some helper tools to general optimization framework
    607 implemented in LEMON.
    608 */
    609 
    610 /**
    611 @defgroup metah Metaheuristics
    612 @ingroup gen_opt_group
    613 \brief Metaheuristics for LEMON library.
    614 
    615 This group contains some metaheuristic optimization tools.
    616556*/
    617557
Note: See TracChangeset for help on using the changeset viewer.