lemon: comparison doc/groups.dox

equal deleted inserted replaced

-:ed61b4178786
+:ac0ff3b0658b
 class. We use the implicit minimum time map as the length map of the
 \c Dijkstra algorithm.
 */
 /**
-@defgroup matrices Matrices
-@ingroup datas
-\brief 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 contains the path structures implemented in LEMON.
 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
 any kind of path structure.
-\sa lemon::concepts::Path
+\sa \ref concepts::Path "Path concept"
+*/
+/**
+@defgroup heaps Heap Structures
+@ingroup datas
+\brief %Heap structures implemented in LEMON.
+This group contains the heap structures implemented in LEMON.
+LEMON provides several heap classes. They are efficient implementations
+of the abstract data type \e priority \e queue. They store items with
+specified values called \e priorities in such a way that finding and
+removing the item with minimum priority are efficient.
+The basic operations are adding and erasing items, changing the priority
+of an item, etc.
+Heaps are crucial in several algorithms, such as Dijkstra and Prim.
+The heap implementations have the same interface, thus any of them can be
+used easily in such algorithms.
+\sa \ref concepts::Heap "Heap concept"
+*/
+/**
+@defgroup matrices Matrices
+@ingroup datas
+\brief Two dimensional data storages implemented in LEMON.
+This group contains two dimensional data storages implemented in LEMON.
 */
 /**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas
 \brief Auxiliary data structures implemented in LEMON.
 This group contains some data structures implemented in LEMON in
 order to make it easier to implement combinatorial algorithms.
+*/
+/**
+@defgroup geomdat Geometric Data Structures
+@ingroup auxdat
+\brief Geometric data structures implemented in LEMON.
+This group contains geometric data structures implemented in LEMON.
+- \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
+vector with the usual operations.
+- \ref lemon::dim2::Box "dim2::Box" can be used to determine the
+rectangular bounding box of a set of \ref lemon::dim2::Point
+"dim2::Point"'s.
+*/
+/**
+@defgroup matrices Matrices
+@ingroup auxdat
+\brief Two dimensional data storages implemented in LEMON.
+This group contains two dimensional data storages implemented in LEMON.
 */
 /**
 @defgroup algs Algorithms
 \brief This group contains the several algorithms
 - \ref Suurballe A successive shortest path algorithm for finding
 arc-disjoint paths between two nodes having minimum total length.
 */
 /**
+@defgroup spantree Minimum Spanning Tree Algorithms
+@ingroup algs
+\brief Algorithms for finding minimum cost spanning trees and arborescences.
+This group contains the algorithms for finding minimum cost spanning
+trees and arborescences.
+*/
+/**
 @defgroup max_flow Maximum Flow Algorithms
 @ingroup algs
 \brief Algorithms for finding maximum flows.
 This group contains the algorithms for finding maximum flows and
 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
 cut is the \f$X\f$ solution of the next optimization problem:
 \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
-\sum_{uv\in A, u\in X, v\not\in X}cap(uv) \f]
+\sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]
 LEMON contains several algorithms related to minimum cut problems:
 - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
 in directed graphs.
 - \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_properties Connectivity and Other Graph Properties
-@ingroup algs
-\brief 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 contains the algorithms for planarity checking,
-embedding and drawing.
-\image html planar.png
-\image latex planar.eps "Plane graph" width=\textwidth
 */
 /**
 @defgroup matching Matching Algorithms
 @ingroup algs
 \image html bipartite_matching.png
 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
 */
 /**
-@defgroup spantree Minimum Spanning Tree Algorithms
+@defgroup graph_properties Connectivity and Other Graph Properties
 @ingroup algs
-\brief Algorithms for finding minimum cost spanning trees and arborescences.
+\brief Algorithms for discovering the graph properties
-This group contains the algorithms for finding minimum cost spanning
+This group contains the algorithms for discovering the graph properties
-trees and arborescences.
+like connectivity, bipartiteness, euler property, simplicity etc.
+\image html connected_components.png
+\image latex connected_components.eps "Connected components" width=\textwidth
+*/
+/**
+@defgroup planar Planarity Embedding and Drawing
+@ingroup algs
+\brief Algorithms for planarity checking, embedding and drawing
+This group contains the algorithms for planarity checking,
+embedding and drawing.
+\image html planar.png
+\image latex planar.eps "Plane graph" width=\textwidth
+*/
+/**
+@defgroup approx Approximation Algorithms
+@ingroup algs
+\brief Approximation algorithms.
+This group contains the approximation and heuristic algorithms
+implemented in LEMON.
 */
 /**
 @defgroup auxalg Auxiliary Algorithms
 @ingroup algs
 \brief Auxiliary 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 contains the approximation and heuristic algorithms
-implemented in LEMON.
 */
 /**
 @defgroup gen_opt_group General Optimization Tools
 \brief This group contains some general optimization frameworks
 This group contains general \c EPS drawing methods and special
 graph exporting tools.
 */
 /**
-@defgroup dimacs_group DIMACS format
+@defgroup dimacs_group DIMACS Format
 @ingroup io_group
 \brief Read and write files in DIMACS format
 Tools to read a digraph from or write it to a file in DIMACS format data.
 */
 This group contains the skeletons and concept checking classes of maps.
 */
 /**
+@defgroup tools Standalone Utility Applications
+Some utility applications are listed here.
+The standard compilation procedure (<tt>./configure;make</tt>) will compile
+them, as well.
+*/
+/**
 \anchor demoprograms
 @defgroup demos Demo Programs
 Some demo programs are listed here. Their full source codes can be found in
 In order to compile them, use the <tt>make demo</tt> or the
 <tt>make check</tt> commands.
 */
-/**
-@defgroup tools Standalone Utility Applications
-Some utility applications are listed here.
-The standard compilation procedure (<tt>./configure;make</tt>) will compile
-them, as well.
-*/
 }

changeset 793	e4554cd6b2bf
parent 782	853fcddcf282
parent 762	ece80147fb08
child 802	134852d7fb0a