lemon: comparison doc/groups.dox

equal deleted inserted replaced

-:f9bac1a9f9c1
+:ab29b083a60e
 namespace lemon {
 /**
 @defgroup datas Data Structures
-This group describes the several data structures implemented in LEMON.
+This group contains the several data structures implemented in LEMON.
 */
 /**
 @defgroup graphs Graph Structures
 @ingroup datas
 /**
 @defgroup semi_adaptors Semi-Adaptor Classes for Graphs
 @ingroup graphs
 \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.
 */
 /**
 @defgroup maps Maps
 @ingroup datas
 \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
 new maps from existing ones.
 <b>See also:</b> \ref map_concepts "Map Concepts".
 /**
 @defgroup graph_maps Graph Maps
 @ingroup maps
 \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.
 If you are looking for the standard graph maps (\c NodeMap, \c ArcMap,
 \c EdgeMap), see the \ref graph_concepts "Graph Structure Concepts".
 */
 /**
 \defgroup map_adaptors Map Adaptors
 \ingroup maps
 \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.
 Most of them are \ref concepts::ReadMap "read-only maps".
 They can make arithmetic and logical operations between one or two maps
 (negation, shifting, addition, multiplication, logical 'and', 'or',
 /**
 @defgroup matrices Matrices
 @ingroup datas
 \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.
 */
 /**
 @defgroup paths Path Structures
 @ingroup datas
 \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.
 All of them have similar interfaces and they can be copied easily with
 assignment operators and copy constructors. This makes it easy and
 efficient to have e.g. the Dijkstra algorithm to store its result in
 /**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas
 \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.
 */
 /**
 @defgroup search Graph Search
 @ingroup algs
 \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).
 */
 /**
 @defgroup shortest_path Shortest Path Algorithms
 @ingroup algs
 \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
 when all arc lengths are non-negative.
 - \ref BellmanFord "Bellman-Ford" algorithm for finding shortest paths
 from a source node when arc lenghts can be either positive or negative,
 /**
 @defgroup max_flow Maximum Flow Algorithms
 @ingroup algs
 \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.
 The \e maximum \e flow \e problem is to find a flow of maximum value between
 a single source and a single target. Formally, there is a \f$G=(V,A)\f$
 digraph, a \f$cap:A\rightarrow\mathbf{R}^+_0\f$ capacity function and
 @defgroup min_cost_flow Minimum Cost Flow Algorithms
 @ingroup algs
 \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.
 The \e minimum \e cost \e flow \e problem is to find a feasible flow of
 minimum total cost from a set of supply nodes to a set of demand nodes
 in a network with capacity constraints and arc costs.
 @defgroup min_cut Minimum Cut Algorithms
 @ingroup algs
 \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
 \f$X\f$ subset of the nodes with minimum overall capacity on
 outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a
 \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
 - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
 in directed graphs.
 - \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.
 If you want to find minimum cut just between two distinict nodes,
 see the \ref max_flow "maximum flow problem".
 */
 /**
 @defgroup graph_prop Connectivity and Other Graph Properties
 @ingroup algs
 \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.
 \image html edge_biconnected_components.png
 \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
 */
 /**
 @defgroup planar Planarity Embedding and Drawing
 @ingroup algs
 \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.
 \image html planar.png
 \image latex planar.eps "Plane graph" width=\textwidth
 */
 /**
 @defgroup spantree Minimum Spanning Tree Algorithms
 @ingroup algs
 \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.
 */
 /**
 @defgroup auxalg Auxiliary Algorithms
 @ingroup algs
 \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.
 */
 /**
 @defgroup approx Approximation Algorithms
 @ingroup algs
 \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.
 */
 /**
 @defgroup lp_group Lp and Mip Solvers
 @ingroup gen_opt_group
 \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.
 */
 /**
 /**
 @defgroup metah Metaheuristics
 @ingroup gen_opt_group
 \brief Metaheuristics for LEMON library.
-This group describes some metaheuristic optimization tools.
+This group contains some metaheuristic optimization tools.
 */
 /**
 @defgroup utils Tools and Utilities
 \brief Tools and utilities for programming in LEMON
 /**
 @defgroup gutils Basic Graph Utilities
 @ingroup utils
 \brief Simple basic graph utilities.
-This group describes some simple basic graph utilities.
+This group contains some simple basic graph utilities.
 */
 /**
 @defgroup misc Miscellaneous Tools
 @ingroup utils
 \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.
 */
 /**
 @defgroup timecount Time Measuring and Counting
 @ingroup misc
 \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.
 */
 /**
 @defgroup exceptions Exceptions
 @ingroup utils
 \brief Exceptions defined in LEMON.
-This group describes the exceptions defined in LEMON.
+This group contains the exceptions defined in LEMON.
 */
 /**
 @defgroup io_group Input-Output
 \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
 postscript (EPS) format.
 */
 /**
 @defgroup lemon_io LEMON Graph Format
 @ingroup io_group
 \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".
 */
 /**
 @defgroup eps_io Postscript Exporting
 @ingroup io_group
 \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.
 */
 /**
 @defgroup dimacs_group DIMACS format
 /**
 @defgroup concept Concepts
 \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.
 The purpose of the classes in this group is fourfold.
 - These classes contain the documentations of the %concepts. In order
 /**
 @defgroup graph_concepts Graph Structure Concepts
 @ingroup concept
 \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.
 */
 /**
 @defgroup map_concepts Map Concepts
 @ingroup concept
 \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.
 */
 /**
 \anchor demoprograms

changeset 608	6e0525ec5355
parent 478	5a1e9fdcfd3a
child 611	eda12d8ac953