1.1 --- a/doc/groups.dox Sat Sep 26 07:16:22 2009 +0200
1.2 +++ b/doc/groups.dox Sat Sep 26 07:21:54 2009 +0200
1.3 @@ -280,6 +280,28 @@
1.4 */
1.5
1.6 /**
1.7 +@defgroup geomdat Geometric Data Structures
1.8 +@ingroup auxdat
1.9 +\brief Geometric data structures implemented in LEMON.
1.10 +
1.11 +This group contains geometric data structures implemented in LEMON.
1.12 +
1.13 + - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
1.14 + vector with the usual operations.
1.15 + - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
1.16 + rectangular bounding box of a set of \ref lemon::dim2::Point
1.17 + "dim2::Point"'s.
1.18 +*/
1.19 +
1.20 +/**
1.21 +@defgroup matrices Matrices
1.22 +@ingroup auxdat
1.23 +\brief Two dimensional data storages implemented in LEMON.
1.24 +
1.25 +This group contains two dimensional data storages implemented in LEMON.
1.26 +*/
1.27 +
1.28 +/**
1.29 @defgroup algs Algorithms
1.30 \brief This group contains the several algorithms
1.31 implemented in LEMON.
1.32 @@ -319,6 +341,15 @@
1.33 */
1.34
1.35 /**
1.36 +@defgroup spantree Minimum Spanning Tree Algorithms
1.37 +@ingroup algs
1.38 +\brief Algorithms for finding minimum cost spanning trees and arborescences.
1.39 +
1.40 +This group contains the algorithms for finding minimum cost spanning
1.41 +trees and arborescences.
1.42 +*/
1.43 +
1.44 +/**
1.45 @defgroup max_flow Maximum Flow Algorithms
1.46 @ingroup algs
1.47 \brief Algorithms for finding maximum flows.
1.48 @@ -396,7 +427,7 @@
1.49 cut is the \f$X\f$ solution of the next optimization problem:
1.50
1.51 \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
1.52 - \sum_{uv\in A, u\in X, v\not\in X}cap(uv) \f]
1.53 + \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]
1.54
1.55 LEMON contains several algorithms related to minimum cut problems:
1.56
1.57 @@ -412,30 +443,6 @@
1.58 */
1.59
1.60 /**
1.61 -@defgroup graph_properties Connectivity and Other Graph Properties
1.62 -@ingroup algs
1.63 -\brief Algorithms for discovering the graph properties
1.64 -
1.65 -This group contains the algorithms for discovering the graph properties
1.66 -like connectivity, bipartiteness, euler property, simplicity etc.
1.67 -
1.68 -\image html edge_biconnected_components.png
1.69 -\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
1.70 -*/
1.71 -
1.72 -/**
1.73 -@defgroup planar Planarity Embedding and Drawing
1.74 -@ingroup algs
1.75 -\brief Algorithms for planarity checking, embedding and drawing
1.76 -
1.77 -This group contains the algorithms for planarity checking,
1.78 -embedding and drawing.
1.79 -
1.80 -\image html planar.png
1.81 -\image latex planar.eps "Plane graph" width=\textwidth
1.82 -*/
1.83 -
1.84 -/**
1.85 @defgroup matching Matching Algorithms
1.86 @ingroup algs
1.87 \brief Algorithms for finding matchings in graphs and bipartite graphs.
1.88 @@ -476,12 +483,36 @@
1.89 */
1.90
1.91 /**
1.92 -@defgroup spantree Minimum Spanning Tree Algorithms
1.93 +@defgroup graph_properties Connectivity and Other Graph Properties
1.94 @ingroup algs
1.95 -\brief Algorithms for finding minimum cost spanning trees and arborescences.
1.96 +\brief Algorithms for discovering the graph properties
1.97
1.98 -This group contains the algorithms for finding minimum cost spanning
1.99 -trees and arborescences.
1.100 +This group contains the algorithms for discovering the graph properties
1.101 +like connectivity, bipartiteness, euler property, simplicity etc.
1.102 +
1.103 +\image html connected_components.png
1.104 +\image latex connected_components.eps "Connected components" width=\textwidth
1.105 +*/
1.106 +
1.107 +/**
1.108 +@defgroup planar Planarity Embedding and Drawing
1.109 +@ingroup algs
1.110 +\brief Algorithms for planarity checking, embedding and drawing
1.111 +
1.112 +This group contains the algorithms for planarity checking,
1.113 +embedding and drawing.
1.114 +
1.115 +\image html planar.png
1.116 +\image latex planar.eps "Plane graph" width=\textwidth
1.117 +*/
1.118 +
1.119 +/**
1.120 +@defgroup approx Approximation Algorithms
1.121 +@ingroup algs
1.122 +\brief Approximation algorithms.
1.123 +
1.124 +This group contains the approximation and heuristic algorithms
1.125 +implemented in LEMON.
1.126 */
1.127
1.128 /**
1.129 @@ -494,15 +525,6 @@
1.130 */
1.131
1.132 /**
1.133 -@defgroup approx Approximation Algorithms
1.134 -@ingroup algs
1.135 -\brief Approximation algorithms.
1.136 -
1.137 -This group contains the approximation and heuristic algorithms
1.138 -implemented in LEMON.
1.139 -*/
1.140 -
1.141 -/**
1.142 @defgroup gen_opt_group General Optimization Tools
1.143 \brief This group contains some general optimization frameworks
1.144 implemented in LEMON.
1.145 @@ -608,7 +630,7 @@
1.146 */
1.147
1.148 /**
1.149 -@defgroup dimacs_group DIMACS format
1.150 +@defgroup dimacs_group DIMACS Format
1.151 @ingroup io_group
1.152 \brief Read and write files in DIMACS format
1.153
1.154 @@ -670,6 +692,15 @@
1.155 */
1.156
1.157 /**
1.158 +@defgroup tools Standalone Utility Applications
1.159 +
1.160 +Some utility applications are listed here.
1.161 +
1.162 +The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.163 +them, as well.
1.164 +*/
1.165 +
1.166 +/**
1.167 \anchor demoprograms
1.168
1.169 @defgroup demos Demo Programs
1.170 @@ -681,13 +712,4 @@
1.171 <tt>make check</tt> commands.
1.172 */
1.173
1.174 -/**
1.175 -@defgroup tools Standalone Utility Applications
1.176 -
1.177 -Some utility applications are listed here.
1.178 -
1.179 -The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.180 -them, as well.
1.181 -*/
1.182 -
1.183 }