doc/groups.dox
 changeset 50 a34c58ff6e40 parent 41 b11737922197 child 71 9df0fe5e5109
     1.1 --- a/doc/groups.dox	Tue Jan 08 02:53:42 2008 +0100
1.2 +++ b/doc/groups.dox	Tue Jan 08 04:26:27 2008 +0100
1.3 @@ -18,7 +18,7 @@
1.4
1.5  /**
1.6  @defgroup datas Data Structures
1.7 -This group describes the several graph structures implemented in LEMON.
1.8 +This group describes the several data structures implemented in LEMON.
1.9  */
1.10
1.11  /**
1.12 @@ -50,7 +50,7 @@
1.13  is to be shrunk for another algorithm.
1.14  LEMON also provides a variety of graphs for these requirements called
1.16 -in conjunction with other graph representation.
1.17 +in conjunction with other graph representations.
1.18
1.19  You are free to use the graph structure that fit your requirements
1.20  the best, most graph algorithms and auxiliary data structures can be used
1.21 @@ -58,21 +58,23 @@
1.22  */
1.23
1.24  /**
1.27  @ingroup graphs
1.28  \brief Graph types between real graphs and graph adaptors.
1.29
1.30 -Graph types between real graphs and graph adaptors. These classes wrap
1.31 -graphs to give new functionality as the adaptors do it. On the other
1.32 -hand they are not light-weight structures as the adaptors.
1.33 +This group describes some graph types between real graphs and graph adaptors.
1.34 +These classes wrap graphs to give new functionality as the adaptors do it.
1.35 +On the other hand they are not light-weight structures as the adaptors.
1.36  */
1.37
1.38  /**
1.39  @defgroup maps Maps
1.40  @ingroup datas
1.41 -\brief Some special purpose map to make life easier.
1.42 +\brief Map structures implemented in LEMON.
1.43
1.44 -LEMON provides several special maps that e.g. combine
1.45 +This group describes the map structures implemented in LEMON.
1.46 +
1.47 +LEMON provides several special purpose maps that e.g. combine
1.48  new maps from existing ones.
1.49  */
1.50
1.51 @@ -81,8 +83,8 @@
1.52  @ingroup maps
1.53  \brief Special Graph-Related Maps.
1.54
1.55 -These maps are specifically designed to assign values to the nodes and edges of
1.56 -graphs.
1.57 +This group describes maps that are specifically designed to assign
1.58 +values to the nodes and edges of graphs.
1.59  */
1.60
1.61
1.62 @@ -91,14 +93,15 @@
1.63  \ingroup maps
1.64  \brief Tools to create new maps from existing ones
1.65
1.66 -Map adaptors are used to create "implicit" maps from other maps.
1.67 +This group describes map adaptors that are used to create "implicit"
1.68 +maps from other maps.
1.69
1.71  make arithmetic operations between one or two maps (negation, scaling,
1.72  addition, multiplication etc.) or e.g. convert a map to another one
1.73  of different Value type.
1.74
1.75 -The typical usage of this classes is the passing implicit maps to
1.76 +The typical usage of this classes is passing implicit maps to
1.77  algorithms.  If a function type algorithm is called then the function
1.78  type map adaptors can be used comfortable. For example let's see the
1.79  usage of map adaptors with the \c graphToEps() function:
1.80 @@ -127,7 +130,7 @@
1.81
1.82  The usage with class type algorithms is little bit harder. In this
1.83  case the function type map adaptors can not be used, because the
1.84 -function map adaptors give back temporarly objects.
1.85 +function map adaptors give back temporary objects.
1.86  \code
1.87    Graph graph;
1.88
1.89 @@ -153,9 +156,9 @@
1.90  /**
1.91  @defgroup matrices Matrices
1.92  @ingroup datas
1.93 -\brief Two dimensional data storages.
1.94 +\brief Two dimensional data storages implemented in LEMON.
1.95
1.96 -Two dimensional data storages.
1.97 +This group describes two dimensional data storages implemented in LEMON.
1.98  */
1.99
1.100  /**
1.101 @@ -163,11 +166,11 @@
1.102  @ingroup datas
1.103  \brief Path structures implemented in LEMON.
1.104
1.105 -LEMON provides flexible data structures
1.106 -to work with paths.
1.107 +This group describes the path structures implemented in LEMON.
1.108
1.109 -All of them have similar interfaces, and it can be copied easily with
1.110 -assignment operator and copy constructor. This make it easy and
1.111 +LEMON provides flexible data structures to work with paths.
1.112 +All of them have similar interfaces and they can be copied easily with
1.113 +assignment operators and copy constructors. This makes it easy and
1.114  efficient to have e.g. the Dijkstra algorithm to store its result in
1.115  any kind of path structure.
1.116
1.117 @@ -178,9 +181,9 @@
1.118  /**
1.119  @defgroup auxdat Auxiliary Data Structures
1.120  @ingroup datas
1.121 -\brief Some data structures implemented in LEMON.
1.122 +\brief Auxiliary data structures implemented in LEMON.
1.123
1.124 -This group describes the data structures implemented in LEMON in
1.125 +This group describes some data structures implemented in LEMON in
1.126  order to make it easier to implement combinatorial algorithms.
1.127  */
1.128
1.129 @@ -197,52 +200,48 @@
1.130  /**
1.131  @defgroup search Graph Search
1.132  @ingroup algs
1.133 -\brief This group contains the common graph
1.134 -search algorithms.
1.135 +\brief Common graph search algorithms.
1.136
1.137 -This group contains the common graph
1.138 -search algorithms like Bfs and Dfs.
1.139 +This group describes the common graph search algorithms like
1.140 +Breadth-first search (Bfs) and Depth-first search (Dfs).
1.141  */
1.142
1.143  /**
1.144  @defgroup shortest_path Shortest Path algorithms
1.145  @ingroup algs
1.146 -\brief This group describes the algorithms
1.147 -for finding shortest paths.
1.148 +\brief Algorithms for finding shortest paths.
1.149
1.150 -This group describes the algorithms for finding shortest paths in
1.151 -graphs.
1.152 -
1.153 +This group describes the algorithms for finding shortest paths in graphs.
1.154  */
1.155
1.156  /**
1.157  @defgroup max_flow Maximum Flow algorithms
1.158  @ingroup algs
1.159 -\brief This group describes the algorithms for finding maximum flows.
1.160 +\brief Algorithms for finding maximum flows.
1.161
1.162  This group describes the algorithms for finding maximum flows and
1.163  feasible circulations.
1.164
1.165 -The maximum flow problem is to find a flow between a single-source and
1.166 -single-target that is maximum. Formally, there is \f$G=(V,A)\f$
1.167 +The maximum flow problem is to find a flow between a single source and
1.168 +a single target that is maximum. Formally, there is a \f$G=(V,A)\f$
1.169  directed graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity
1.170  function and given \f$s, t \in V\f$ source and target node. The
1.171 -maximum flow is the solution of the next optimization problem:
1.172 +maximum flow is the \f$f_a\f$ solution of the next optimization problem:
1.173
1.174  \f[ 0 \le f_a \le c_a \f]
1.175 -\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \quad u \in V \setminus \{s,t\}\f]
1.176 +\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \qquad \forall u \in V \setminus \{s,t\}\f]
1.177  \f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]
1.178
1.179 -The lemon contains several algorithms for solve maximum flow problems:
1.180 +LEMON contains several algorithms for solving maximum flow problems:
1.181  - \ref lemon::EdmondsKarp "Edmonds-Karp"
1.182  - \ref lemon::Preflow "Goldberg's Preflow algorithm"
1.183 -- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic tree"
1.184 +- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"
1.185  - \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees"
1.186
1.187 -In most cases the \ref lemon::Preflow "preflow" algorithm provides the
1.188 +In most cases the \ref lemon::Preflow "Preflow" algorithm provides the
1.189  fastest method to compute the maximum flow. All impelementations
1.190 -provides functions for query the minimum cut, which is the dual linear
1.191 -programming probelm of the maximum flow.
1.192 +provides functions to query the minimum cut, which is the dual linear
1.193 +programming problem of the maximum flow.
1.194
1.195  */
1.196
1.197 @@ -250,8 +249,7 @@
1.198  @defgroup min_cost_flow Minimum Cost Flow algorithms
1.199  @ingroup algs
1.200
1.201 -\brief This group describes the algorithms
1.202 -for finding minimum cost flows and circulations.
1.203 +\brief Algorithms for finding minimum cost flows and circulations.
1.204
1.205  This group describes the algorithms for finding minimum cost flows and
1.206  circulations.
1.207 @@ -261,8 +259,7 @@
1.208  @defgroup min_cut Minimum Cut algorithms
1.209  @ingroup algs
1.210
1.211 -\brief This group describes the algorithms for finding minimum cut in
1.212 -graphs.
1.213 +\brief Algorithms for finding minimum cut in graphs.
1.214
1.215  This group describes the algorithms for finding minimum cut in graphs.
1.216
1.217 @@ -270,17 +267,17 @@
1.218  \f$X\f$ subset of the vertices with minimum overall capacity on
1.219  outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an
1.220  \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
1.221 -cut is the solution of the next optimization problem:
1.222 +cut is the \f$X\f$ solution of the next optimization problem:
1.223
1.224  \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}\sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]
1.225
1.226 -The lemon contains several algorithms related to minimum cut problems:
1.227 +LEMON contains several algorithms related to minimum cut problems:
1.228
1.229 -- \ref lemon::HaoOrlin "Hao-Orlin algorithm" for calculate minimum cut
1.230 +- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut
1.231    in directed graphs
1.232 -- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
1.233 +- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to
1.234    calculate minimum cut in undirected graphs
1.235 -- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" for calculate all
1.236 +- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all
1.237    pairs minimum cut in undirected graphs
1.238
1.239  If you want to find minimum cut just between two distinict nodes,
1.240 @@ -291,11 +288,10 @@
1.241  /**
1.242  @defgroup graph_prop Connectivity and other graph properties
1.243  @ingroup algs
1.244 -\brief This group describes the algorithms
1.245 -for discover the graph properties
1.246 +\brief Algorithms for discovering the graph properties
1.247
1.248 -This group describes the algorithms for discover the graph properties
1.249 -like connectivity, bipartiteness, euler property, simplicity, etc...
1.250 +This group describes the algorithms for discovering the graph properties
1.251 +like connectivity, bipartiteness, euler property, simplicity etc.
1.252
1.253  \image html edge_biconnected_components.png
1.254  \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
1.255 @@ -304,9 +300,9 @@
1.256  /**
1.257  @defgroup planar Planarity embedding and drawing
1.258  @ingroup algs
1.259 -\brief This group contains algorithms for planarity embedding and drawing
1.260 +\brief Algorithms for planarity checking, embedding and drawing
1.261
1.262 -This group contains algorithms for planarity checking, embedding and drawing.
1.263 +This group describes the algorithms for planarity checking, embedding and drawing.
1.264
1.265  \image html planar.png
1.266  \image latex planar.eps "Plane graph" width=\textwidth
1.267 @@ -315,10 +311,9 @@
1.268  /**
1.269  @defgroup matching Matching algorithms
1.270  @ingroup algs
1.271 -\brief This group describes the algorithms
1.272 -for find matchings in graphs and bipartite graphs.
1.273 +\brief Algorithms for finding matchings in graphs and bipartite graphs.
1.274
1.275 -This group provides some algorithm objects and function to calculate
1.276 +This group contains algorithm objects and functions to calculate
1.277  matchings in graphs and bipartite graphs. The general matching problem is
1.278  finding a subset of the edges which does not shares common endpoints.
1.279
1.280 @@ -358,10 +353,9 @@
1.281  /**
1.282  @defgroup spantree Minimum Spanning Tree algorithms
1.283  @ingroup algs
1.284 -\brief This group contains the algorithms for finding a minimum cost spanning
1.285 -tree in a graph
1.286 +\brief Algorithms for finding a minimum cost spanning tree in a graph.
1.287
1.288 -This group contains the algorithms for finding a minimum cost spanning
1.289 +This group describes the algorithms for finding a minimum cost spanning
1.290  tree in a graph
1.291  */
1.292
1.293 @@ -369,17 +363,18 @@
1.294  /**
1.295  @defgroup auxalg Auxiliary algorithms
1.296  @ingroup algs
1.297 -\brief Some algorithms implemented in LEMON.
1.298 +\brief Auxiliary algorithms implemented in LEMON.
1.299
1.300 -This group describes the algorithms in LEMON in order to make
1.301 -it easier to implement complex algorithms.
1.302 +This group describes some algorithms implemented in LEMON
1.303 +in order to make it easier to implement complex algorithms.
1.304  */
1.305
1.306  /**
1.307  @defgroup approx Approximation algorithms
1.308 -\brief Approximation algorithms
1.309 +\brief Approximation algorithms.
1.310
1.311 -Approximation and heuristic algorithms
1.312 +This group describes the approximation and heuristic algorithms
1.313 +implemented in LEMON.
1.314  */
1.315
1.316  /**
1.317 @@ -406,8 +401,7 @@
1.318  /**
1.319  @defgroup lp_utils Tools for Lp and Mip solvers
1.320  @ingroup lp_group
1.321 -\brief This group adds some helper tools to the Lp and Mip solvers
1.322 -implemented in LEMON.
1.323 +\brief Helper tools to the Lp and Mip solvers.
1.324
1.325  This group adds some helper tools to general optimization framework
1.326  implemented in LEMON.
1.327 @@ -418,20 +412,20 @@
1.328  @ingroup gen_opt_group
1.329  \brief Metaheuristics for LEMON library.
1.330
1.331 -This group contains some metaheuristic optimization tools.
1.332 +This group describes some metaheuristic optimization tools.
1.333  */
1.334
1.335  /**
1.336  @defgroup utils Tools and Utilities
1.337 -\brief Tools and Utilities for Programming in LEMON
1.338 +\brief Tools and utilities for programming in LEMON
1.339
1.340 -Tools and Utilities for Programming in LEMON
1.341 +Tools and utilities for programming in LEMON.
1.342  */
1.343
1.344  /**
1.345  @defgroup gutils Basic Graph Utilities
1.346  @ingroup utils
1.347 -\brief This group describes some simple basic graph utilities.
1.348 +\brief Simple basic graph utilities.
1.349
1.350  This group describes some simple basic graph utilities.
1.351  */
1.352 @@ -439,40 +433,45 @@
1.353  /**
1.354  @defgroup misc Miscellaneous Tools
1.355  @ingroup utils
1.356 -Here you can find several useful tools for development,
1.357 +\brief Tools for development, debugging and testing.
1.358 +
1.359 +This group describes several useful tools for development,
1.360  debugging and testing.
1.361  */
1.362
1.363 -
1.364  /**
1.365  @defgroup timecount Time measuring and Counting
1.366  @ingroup misc
1.367 -Here you can find simple tools for measuring the performance
1.368 +\brief Simple tools for measuring the performance of algorithms.
1.369 +
1.370 +This group describes simple tools for measuring the performance
1.371  of algorithms.
1.372  */
1.373
1.374  /**
1.375  @defgroup graphbits Tools for Graph Implementation
1.376  @ingroup utils
1.377 -\brief Tools to Make It Easier to Make Graphs.
1.378 +\brief Tools to make it easier to create graphs.
1.379
1.380 -This group describes the tools that makes it easier to make graphs and
1.381 +This group describes the tools that makes it easier to create graphs and
1.382  the maps that dynamically update with the graph changes.
1.383  */
1.384
1.385  /**
1.386  @defgroup exceptions Exceptions
1.387  @ingroup utils
1.388 -This group contains the exceptions thrown by LEMON library
1.389 +\brief Exceptions defined in LEMON.
1.390 +
1.391 +This group describes the exceptions defined in LEMON.
1.392  */
1.393
1.394  /**
1.395  @defgroup io_group Input-Output
1.396 -\brief Several Graph Input-Output methods
1.397 +\brief Graph Input-Output methods
1.398
1.399 -Here you can find tools for importing and exporting graphs
1.400 +This group describes the tools for importing and exporting graphs
1.401  and graph related data. Now it supports the LEMON format, the
1.402 -\c DIMACS format and the encapsulated postscript format.
1.403 +\c DIMACS format and the encapsulated postscript (EPS) format.
1.404  */
1.405
1.406  /**
1.407 @@ -480,8 +479,8 @@
1.408  @ingroup io_group
1.409  \brief Reading and writing LEMON format
1.410
1.412 -format you can find on the \ref graph-io-page "Graph Input-Output"
1.413 +This group describes methods for reading and writing LEMON format.
1.415  tutorial pages.
1.416  */
1.417
1.418 @@ -490,8 +489,8 @@
1.419  @ingroup lemon_io
1.420  \brief Section readers and writers for lemon Input-Output.
1.421
1.422 -Here you can find which section readers and writers can attach to
1.424 +This group describes section readers and writers that can be attached to
1.425 +\ref LemonReader and \ref LemonWriter.
1.426  */
1.427
1.428  /**
1.429 @@ -509,7 +508,7 @@
1.430  @ingroup io_group
1.431  \brief General \c EPS drawer and graph exporter
1.432
1.433 -This group contains general \c EPS drawing methods and special
1.434 +This group describes general \c EPS drawing methods and special
1.435  graph exporting tools.
1.436  */
1.437
1.438 @@ -537,7 +536,7 @@
1.439    doesn't use any extra feature of a certain implementation.
1.440
1.441  - The concept descriptor classes also provide a <em>checker class</em>
1.442 -  that makes it possible check whether a certain implementation of a
1.443 +  that makes it possible to check whether a certain implementation of a
1.444    concept indeed provides all the required features.
1.445
1.446  - Finally, They can serve as a skeleton of a new implementation of a concept.
1.447 @@ -550,13 +549,13 @@
1.448  @ingroup concept
1.449  \brief Skeleton and concept checking classes for graph structures
1.450
1.451 -This group contains the skeletons and concept checking classes of LEMON's
1.452 +This group describes the skeletons and concept checking classes of LEMON's
1.453  graph structures and helper classes used to implement these.
1.454  */
1.455
1.456  /* --- Unused group
1.457  @defgroup experimental Experimental Structures and Algorithms
1.458 -This group contains some Experimental structures and algorithms.
1.459 +This group describes some Experimental structures and algorithms.
1.460  The stuff here is subject to change.
1.461  */
1.462
1.463 @@ -570,7 +569,6 @@
1.464
1.465  It order to compile them, use <tt>--enable-demo</tt> configure option when
1.466  build the library.
1.467 -
1.468  */
1.469
1.470  /**
1.471 @@ -580,6 +578,5 @@
1.472
1.473  The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.474  them, as well.
1.475 -
1.476  */
1.477