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

Ignore:
Timestamp:
03/29/09 23:08:20 (11 years ago)
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

Unmodified
Added
Removed
• ## doc/groups.dox

 r455 /** @defgroup datas Data Structures This group describes the several data structures implemented in LEMON. This group contains the several data structures implemented in LEMON. */ \brief Graph types between real graphs and graph adaptors. This group describes some graph types between real graphs and graph adaptors. This group contains some graph types between real graphs and graph adaptors. These classes wrap graphs to give new functionality as the adaptors do it. On the other hand they are not light-weight structures as the adaptors. \brief Map structures implemented in LEMON. This group describes the map structures implemented in LEMON. This group contains the map structures implemented in LEMON. LEMON provides several special purpose maps and map adaptors that e.g. combine \brief Special graph-related maps. This group describes maps that are specifically designed to assign This group contains maps that are specifically designed to assign values to the nodes and arcs/edges of graphs. \brief Tools to create new maps from existing ones This group describes map adaptors that are used to create "implicit" This group contains map adaptors that are used to create "implicit" maps from other maps. \brief Two dimensional data storages implemented in LEMON. This group describes two dimensional data storages implemented in LEMON. This group contains two dimensional data storages implemented in LEMON. */ \brief %Path structures implemented in LEMON. This group describes the path structures implemented in LEMON. This group contains the path structures implemented in LEMON. LEMON provides flexible data structures to work with paths. \brief Auxiliary data structures implemented in LEMON. This group describes some data structures implemented in LEMON in This group contains some data structures implemented in LEMON in order to make it easier to implement combinatorial algorithms. */ /** @defgroup algs Algorithms \brief This group describes the several algorithms \brief This group contains the several algorithms implemented in LEMON. This group describes the several algorithms This group contains the several algorithms implemented in LEMON. */ \brief Common graph search algorithms. This group describes the common graph search algorithms, namely This group contains the common graph search algorithms, namely \e breadth-first \e search (BFS) and \e depth-first \e search (DFS). */ \brief Algorithms for finding shortest paths. This group describes the algorithms for finding shortest paths in digraphs. This group contains the algorithms for finding shortest paths in digraphs. - \ref Dijkstra algorithm for finding shortest paths from a source node \brief Algorithms for finding maximum flows. This group describes the algorithms for finding maximum flows and This group contains the algorithms for finding maximum flows and feasible circulations. \brief Algorithms for finding minimum cost flows and circulations. This group describes the algorithms for finding minimum cost flows and This group contains the algorithms for finding minimum cost flows and circulations. \brief Algorithms for finding minimum cut in graphs. This group describes the algorithms for finding minimum cut in graphs. This group contains the algorithms for finding minimum cut in graphs. The \e minimum \e cut \e problem is to find a non-empty and non-complete - \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for calculating minimum cut in undirected graphs. - \ref GomoryHuTree "Gomory-Hu tree computation" for calculating - \ref GomoryHu "Gomory-Hu tree computation" for calculating all-pairs minimum cut in undirected graphs. \brief Algorithms for discovering the graph properties This group describes the algorithms for discovering the graph properties This group contains the algorithms for discovering the graph properties like connectivity, bipartiteness, euler property, simplicity etc. \brief Algorithms for planarity checking, embedding and drawing This group describes the algorithms for planarity checking, This group contains the algorithms for planarity checking, embedding and drawing. \brief Algorithms for finding a minimum cost spanning tree in a graph. This group describes the algorithms for finding a minimum cost spanning This group contains the algorithms for finding a minimum cost spanning tree in a graph. */ \brief Auxiliary algorithms implemented in LEMON. This group describes some algorithms implemented in LEMON This group contains some algorithms implemented in LEMON in order to make it easier to implement complex algorithms. */ \brief Approximation algorithms. This group describes the approximation and heuristic algorithms This group contains the approximation and heuristic algorithms implemented in LEMON. */ /** @defgroup gen_opt_group General Optimization Tools \brief This group describes some general optimization frameworks \brief This group contains some general optimization frameworks implemented in LEMON. This group describes some general optimization frameworks This group contains some general optimization frameworks implemented in LEMON. */ \brief Lp and Mip solver interfaces for LEMON. This group describes Lp and Mip solver interfaces for LEMON. The This group contains Lp and Mip solver interfaces for LEMON. The various LP solvers could be used in the same manner with this interface. \brief Metaheuristics for LEMON library. This group describes some metaheuristic optimization tools. This group contains some metaheuristic optimization tools. */ \brief Simple basic graph utilities. This group describes some simple basic graph utilities. This group contains some simple basic graph utilities. */ \brief Tools for development, debugging and testing. This group describes several useful tools for development, This group contains several useful tools for development, debugging and testing. */ \brief Simple tools for measuring the performance of algorithms. This group describes simple tools for measuring the performance This group contains simple tools for measuring the performance of algorithms. */ \brief Exceptions defined in LEMON. This group describes the exceptions defined in LEMON. This group contains the exceptions defined in LEMON. */ \brief Graph Input-Output methods This group describes the tools for importing and exporting graphs This group contains the tools for importing and exporting graphs and graph related data. Now it supports the \ref lgf-format "LEMON Graph Format", the \c DIMACS format and the encapsulated \brief Reading and writing LEMON Graph Format. This group describes methods for reading and writing This group contains methods for reading and writing \ref lgf-format "LEMON Graph Format". */ \brief General \c EPS drawer and graph exporter This group describes general \c EPS drawing methods and special This group contains general \c EPS drawing methods and special graph exporting tools. */ \brief Skeleton classes and concept checking classes This group describes the data/algorithm skeletons and concept checking This group contains the data/algorithm skeletons and concept checking classes implemented in LEMON. \brief Skeleton and concept checking classes for graph structures This group describes the skeletons and concept checking classes of LEMON's This group contains the skeletons and concept checking classes of LEMON's graph structures and helper classes used to implement these. */ \brief Skeleton and concept checking classes for maps This group describes the skeletons and concept checking classes of maps. This group contains the skeletons and concept checking classes of maps. */
Note: See TracChangeset for help on using the changeset viewer.