COIN-OR::LEMON - Graph Library

Changeset 559:c5fd2d996909 in lemon-1.2 for doc/groups.dox


Ignore:
Timestamp:
03/29/09 23:08:20 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Various doc improvements (#248)

  • Rename all the ugly template parameters (too long and/or starting with an underscore).
  • Rename function parameters starting with an underscore.
  • Extend the doc for many classes.
  • Use LaTeX-style O(...) expressions only for the complicated ones.
  • A lot of small unification changes.
  • Small fixes.
  • Some other improvements.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r455 r559  
    2121/**
    2222@defgroup datas Data Structures
    23 This group describes the several data structures implemented in LEMON.
     23This group contains the several data structures implemented in LEMON.
    2424*/
    2525
     
    143143\brief Graph types between real graphs and graph adaptors.
    144144
    145 This group describes some graph types between real graphs and graph adaptors.
     145This group contains some graph types between real graphs and graph adaptors.
    146146These classes wrap graphs to give new functionality as the adaptors do it.
    147147On the other hand they are not light-weight structures as the adaptors.
     
    153153\brief Map structures implemented in LEMON.
    154154
    155 This group describes the map structures implemented in LEMON.
     155This group contains the map structures implemented in LEMON.
    156156
    157157LEMON provides several special purpose maps and map adaptors that e.g. combine
     
    166166\brief Special graph-related maps.
    167167
    168 This group describes maps that are specifically designed to assign
     168This group contains maps that are specifically designed to assign
    169169values to the nodes and arcs/edges of graphs.
    170170
     
    178178\brief Tools to create new maps from existing ones
    179179
    180 This group describes map adaptors that are used to create "implicit"
     180This group contains map adaptors that are used to create "implicit"
    181181maps from other maps.
    182182
     
    241241\brief Two dimensional data storages implemented in LEMON.
    242242
    243 This group describes two dimensional data storages implemented in LEMON.
     243This group contains two dimensional data storages implemented in LEMON.
    244244*/
    245245
     
    249249\brief %Path structures implemented in LEMON.
    250250
    251 This group describes the path structures implemented in LEMON.
     251This group contains the path structures implemented in LEMON.
    252252
    253253LEMON provides flexible data structures to work with paths.
     
    265265\brief Auxiliary data structures implemented in LEMON.
    266266
    267 This group describes some data structures implemented in LEMON in
     267This group contains some data structures implemented in LEMON in
    268268order to make it easier to implement combinatorial algorithms.
    269269*/
     
    271271/**
    272272@defgroup algs Algorithms
    273 \brief This group describes the several algorithms
     273\brief This group contains the several algorithms
    274274implemented in LEMON.
    275275
    276 This group describes the several algorithms
     276This group contains the several algorithms
    277277implemented in LEMON.
    278278*/
     
    283283\brief Common graph search algorithms.
    284284
    285 This group describes the common graph search algorithms, namely
     285This group contains the common graph search algorithms, namely
    286286\e breadth-first \e search (BFS) and \e depth-first \e search (DFS).
    287287*/
     
    292292\brief Algorithms for finding shortest paths.
    293293
    294 This group describes the algorithms for finding shortest paths in digraphs.
     294This group contains the algorithms for finding shortest paths in digraphs.
    295295
    296296 - \ref Dijkstra algorithm for finding shortest paths from a source node
     
    313313\brief Algorithms for finding maximum flows.
    314314
    315 This group describes the algorithms for finding maximum flows and
     315This group contains the algorithms for finding maximum flows and
    316316feasible circulations.
    317317
     
    346346\brief Algorithms for finding minimum cost flows and circulations.
    347347
    348 This group describes the algorithms for finding minimum cost flows and
     348This group contains the algorithms for finding minimum cost flows and
    349349circulations.
    350350
     
    383383\brief Algorithms for finding minimum cut in graphs.
    384384
    385 This group describes the algorithms for finding minimum cut in graphs.
     385This group contains the algorithms for finding minimum cut in graphs.
    386386
    387387The \e minimum \e cut \e problem is to find a non-empty and non-complete
     
    400400- \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
    401401  calculating minimum cut in undirected graphs.
    402 - \ref GomoryHuTree "Gomory-Hu tree computation" for calculating
     402- \ref GomoryHu "Gomory-Hu tree computation" for calculating
    403403  all-pairs minimum cut in undirected graphs.
    404404
     
    412412\brief Algorithms for discovering the graph properties
    413413
    414 This group describes the algorithms for discovering the graph properties
     414This group contains the algorithms for discovering the graph properties
    415415like connectivity, bipartiteness, euler property, simplicity etc.
    416416
     
    424424\brief Algorithms for planarity checking, embedding and drawing
    425425
    426 This group describes the algorithms for planarity checking,
     426This group contains the algorithms for planarity checking,
    427427embedding and drawing.
    428428
     
    475475\brief Algorithms for finding a minimum cost spanning tree in a graph.
    476476
    477 This group describes the algorithms for finding a minimum cost spanning
     477This group contains the algorithms for finding a minimum cost spanning
    478478tree in a graph.
    479479*/
     
    484484\brief Auxiliary algorithms implemented in LEMON.
    485485
    486 This group describes some algorithms implemented in LEMON
     486This group contains some algorithms implemented in LEMON
    487487in order to make it easier to implement complex algorithms.
    488488*/
     
    493493\brief Approximation algorithms.
    494494
    495 This group describes the approximation and heuristic algorithms
     495This group contains the approximation and heuristic algorithms
    496496implemented in LEMON.
    497497*/
     
    499499/**
    500500@defgroup gen_opt_group General Optimization Tools
    501 \brief This group describes some general optimization frameworks
     501\brief This group contains some general optimization frameworks
    502502implemented in LEMON.
    503503
    504 This group describes some general optimization frameworks
     504This group contains some general optimization frameworks
    505505implemented in LEMON.
    506506*/
     
    511511\brief Lp and Mip solver interfaces for LEMON.
    512512
    513 This group describes Lp and Mip solver interfaces for LEMON. The
     513This group contains Lp and Mip solver interfaces for LEMON. The
    514514various LP solvers could be used in the same manner with this
    515515interface.
     
    530530\brief Metaheuristics for LEMON library.
    531531
    532 This group describes some metaheuristic optimization tools.
     532This group contains some metaheuristic optimization tools.
    533533*/
    534534
     
    545545\brief Simple basic graph utilities.
    546546
    547 This group describes some simple basic graph utilities.
     547This group contains some simple basic graph utilities.
    548548*/
    549549
     
    553553\brief Tools for development, debugging and testing.
    554554
    555 This group describes several useful tools for development,
     555This group contains several useful tools for development,
    556556debugging and testing.
    557557*/
     
    562562\brief Simple tools for measuring the performance of algorithms.
    563563
    564 This group describes simple tools for measuring the performance
     564This group contains simple tools for measuring the performance
    565565of algorithms.
    566566*/
     
    571571\brief Exceptions defined in LEMON.
    572572
    573 This group describes the exceptions defined in LEMON.
     573This group contains the exceptions defined in LEMON.
    574574*/
    575575
     
    578578\brief Graph Input-Output methods
    579579
    580 This group describes the tools for importing and exporting graphs
     580This group contains the tools for importing and exporting graphs
    581581and graph related data. Now it supports the \ref lgf-format
    582582"LEMON Graph Format", the \c DIMACS format and the encapsulated
     
    589589\brief Reading and writing LEMON Graph Format.
    590590
    591 This group describes methods for reading and writing
     591This group contains methods for reading and writing
    592592\ref lgf-format "LEMON Graph Format".
    593593*/
     
    598598\brief General \c EPS drawer and graph exporter
    599599
    600 This group describes general \c EPS drawing methods and special
     600This group contains general \c EPS drawing methods and special
    601601graph exporting tools.
    602602*/
     
    622622\brief Skeleton classes and concept checking classes
    623623
    624 This group describes the data/algorithm skeletons and concept checking
     624This group contains the data/algorithm skeletons and concept checking
    625625classes implemented in LEMON.
    626626
     
    652652\brief Skeleton and concept checking classes for graph structures
    653653
    654 This group describes the skeletons and concept checking classes of LEMON's
     654This group contains the skeletons and concept checking classes of LEMON's
    655655graph structures and helper classes used to implement these.
    656656*/
     
    661661\brief Skeleton and concept checking classes for maps
    662662
    663 This group describes the skeletons and concept checking classes of maps.
     663This group contains the skeletons and concept checking classes of maps.
    664664*/
    665665
Note: See TracChangeset for help on using the changeset viewer.