doc/groups.dox
 changeset 314 2cc60866a0c9 parent 236 da953e387d31 child 318 1e2d6ca80793 child 327 12626fc94ccf
     1.1 --- a/doc/groups.dox	Thu Oct 09 10:09:44 2008 +0200
1.2 +++ b/doc/groups.dox	Thu Oct 09 13:27:35 2008 +0200
1.3 @@ -54,7 +54,9 @@
1.4
1.5  You are free to use the graph structure that fit your requirements
1.6  the best, most graph algorithms and auxiliary data structures can be used
1.7 -with any graph structures.
1.8 +with any graph structure.
1.9 +
1.11  */
1.12
1.13  /**
1.14 @@ -74,8 +76,10 @@
1.15
1.16  This group describes the map structures implemented in LEMON.
1.17
1.18 -LEMON provides several special purpose maps that e.g. combine
1.19 +LEMON provides several special purpose maps and map adaptors that e.g. combine
1.20  new maps from existing ones.
1.21 +
1.23  */
1.24
1.25  /**
1.26 @@ -87,7 +91,6 @@
1.27  values to the nodes and arcs of graphs.
1.28  */
1.29
1.30 -
1.31  /**
1.33  \ingroup maps
1.34 @@ -104,7 +107,7 @@
1.35  The typical usage of this classes is passing implicit maps to
1.36  algorithms.  If a function type algorithm is called then the function
1.37  type map adaptors can be used comfortable. For example let's see the
1.38 -usage of map adaptors with the \c digraphToEps() function.
1.39 +usage of map adaptors with the \c graphToEps() function.
1.40  \code
1.41    Color nodeColor(int deg) {
1.42      if (deg >= 2) {
1.43 @@ -118,13 +121,13 @@
1.44
1.45    Digraph::NodeMap<int> degree_map(graph);
1.46
1.47 -  digraphToEps(graph, "graph.eps")
1.48 +  graphToEps(graph, "graph.eps")
1.49      .coords(coords).scaleToA4().undirected()
1.50      .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
1.51      .run();
1.52  \endcode
1.53  The \c functorToMap() function makes an \c int to \c Color map from the
1.54 -\e nodeColor() function. The \c composeMap() compose the \e degree_map
1.55 +\c nodeColor() function. The \c composeMap() compose the \c degree_map
1.56  and the previously created map. The composed map is a proper function to
1.57  get the color of each node.
1.58
1.59 @@ -173,7 +176,6 @@
1.60  any kind of path structure.
1.61
1.62  \sa lemon::concepts::Path
1.63 -
1.64  */
1.65
1.66  /**
1.67 @@ -185,7 +187,6 @@
1.68  order to make it easier to implement combinatorial algorithms.
1.69  */
1.70
1.71 -
1.72  /**
1.73  @defgroup algs Algorithms
1.74  \brief This group describes the several algorithms
1.75 @@ -201,11 +202,11 @@
1.76  \brief Common graph search algorithms.
1.77
1.78  This group describes the common graph search algorithms like
1.79 -Breadth-first search (Bfs) and Depth-first search (Dfs).
1.80 +Breadth-First Search (BFS) and Depth-First Search (DFS).
1.81  */
1.82
1.83  /**
1.84 -@defgroup shortest_path Shortest Path algorithms
1.85 +@defgroup shortest_path Shortest Path Algorithms
1.86  @ingroup algs
1.87  \brief Algorithms for finding shortest paths.
1.88
1.89 @@ -213,7 +214,7 @@
1.90  */
1.91
1.92  /**
1.93 -@defgroup max_flow Maximum Flow algorithms
1.94 +@defgroup max_flow Maximum Flow Algorithms
1.95  @ingroup algs
1.96  \brief Algorithms for finding maximum flows.
1.97
1.98 @@ -241,11 +242,10 @@
1.99  fastest method to compute the maximum flow. All impelementations
1.100  provides functions to query the minimum cut, which is the dual linear
1.101  programming problem of the maximum flow.
1.102 -
1.103  */
1.104
1.105  /**
1.106 -@defgroup min_cost_flow Minimum Cost Flow algorithms
1.107 +@defgroup min_cost_flow Minimum Cost Flow Algorithms
1.108  @ingroup algs
1.109
1.110  \brief Algorithms for finding minimum cost flows and circulations.
1.111 @@ -255,7 +255,7 @@
1.112  */
1.113
1.114  /**
1.115 -@defgroup min_cut Minimum Cut algorithms
1.116 +@defgroup min_cut Minimum Cut Algorithms
1.117  @ingroup algs
1.118
1.119  \brief Algorithms for finding minimum cut in graphs.
1.120 @@ -282,11 +282,10 @@
1.121
1.122  If you want to find minimum cut just between two distinict nodes,
1.123  please see the \ref max_flow "Maximum Flow page".
1.124 -
1.125  */
1.126
1.127  /**
1.128 -@defgroup graph_prop Connectivity and other graph properties
1.129 +@defgroup graph_prop Connectivity and Other Graph Properties
1.130  @ingroup algs
1.131  \brief Algorithms for discovering the graph properties
1.132
1.133 @@ -298,7 +297,7 @@
1.134  */
1.135
1.136  /**
1.137 -@defgroup planar Planarity embedding and drawing
1.138 +@defgroup planar Planarity Embedding and Drawing
1.139  @ingroup algs
1.140  \brief Algorithms for planarity checking, embedding and drawing
1.141
1.142 @@ -310,7 +309,7 @@
1.143  */
1.144
1.145  /**
1.146 -@defgroup matching Matching algorithms
1.147 +@defgroup matching Matching Algorithms
1.148  @ingroup algs
1.149  \brief Algorithms for finding matchings in graphs and bipartite graphs.
1.150
1.151 @@ -348,11 +347,10 @@
1.152
1.153  \image html bipartite_matching.png
1.154  \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
1.155 -
1.156  */
1.157
1.158  /**
1.159 -@defgroup spantree Minimum Spanning Tree algorithms
1.160 +@defgroup spantree Minimum Spanning Tree Algorithms
1.161  @ingroup algs
1.162  \brief Algorithms for finding a minimum cost spanning tree in a graph.
1.163
1.164 @@ -360,9 +358,8 @@
1.165  tree in a graph
1.166  */
1.167
1.168 -
1.169  /**
1.170 -@defgroup auxalg Auxiliary algorithms
1.171 +@defgroup auxalg Auxiliary Algorithms
1.172  @ingroup algs
1.173  \brief Auxiliary algorithms implemented in LEMON.
1.174
1.175 @@ -371,7 +368,8 @@
1.176  */
1.177
1.178  /**
1.179 -@defgroup approx Approximation algorithms
1.180 +@defgroup approx Approximation Algorithms
1.181 +@ingroup algs
1.182  \brief Approximation algorithms.
1.183
1.184  This group describes the approximation and heuristic algorithms
1.185 @@ -385,22 +383,20 @@
1.186
1.187  This group describes some general optimization frameworks
1.188  implemented in LEMON.
1.189 -
1.190  */
1.191
1.192  /**
1.193 -@defgroup lp_group Lp and Mip solvers
1.194 +@defgroup lp_group Lp and Mip Solvers
1.195  @ingroup gen_opt_group
1.196  \brief Lp and Mip solver interfaces for LEMON.
1.197
1.198  This group describes Lp and Mip solver interfaces for LEMON. The
1.199  various LP solvers could be used in the same manner with this
1.200  interface.
1.201 -
1.202  */
1.203
1.204  /**
1.205 -@defgroup lp_utils Tools for Lp and Mip solvers
1.206 +@defgroup lp_utils Tools for Lp and Mip Solvers
1.207  @ingroup lp_group
1.208  \brief Helper tools to the Lp and Mip solvers.
1.209
1.210 @@ -441,7 +437,7 @@
1.211  */
1.212
1.213  /**
1.214 -@defgroup timecount Time measuring and Counting
1.215 +@defgroup timecount Time Measuring and Counting
1.216  @ingroup misc
1.217  \brief Simple tools for measuring the performance of algorithms.
1.218
1.219 @@ -450,15 +446,6 @@
1.220  */
1.221
1.222  /**
1.223 -@defgroup graphbits Tools for Graph Implementation
1.224 -@ingroup utils
1.225 -\brief Tools to make it easier to create graphs.
1.226 -
1.227 -This group describes the tools that makes it easier to create graphs and
1.228 -the maps that dynamically update with the graph changes.
1.229 -*/
1.230 -
1.231 -/**
1.232  @defgroup exceptions Exceptions
1.233  @ingroup utils
1.234  \brief Exceptions defined in LEMON.
1.235 @@ -471,21 +458,22 @@
1.236  \brief Graph Input-Output methods
1.237
1.238  This group describes the tools for importing and exporting graphs
1.239 -and graph related data. Now it supports the LEMON format, the
1.240 -\c DIMACS format and the encapsulated postscript (EPS) format.
1.241 +and graph related data. Now it supports the \ref lgf-format
1.242 +"LEMON Graph Format", the \c DIMACS format and the encapsulated
1.243 +postscript (EPS) format.
1.244  */
1.245
1.246  /**
1.247  @defgroup lemon_io LEMON Input-Output
1.248  @ingroup io_group
1.249 -\brief Reading and writing \ref lgf-format "LEMON Graph Format".
1.250 +\brief Reading and writing LEMON Graph Format.
1.251
1.252  This group describes methods for reading and writing
1.253  \ref lgf-format "LEMON Graph Format".
1.254  */
1.255
1.256  /**
1.257 -@defgroup eps_io Postscript exporting
1.258 +@defgroup eps_io Postscript Exporting
1.259  @ingroup io_group
1.260  \brief General \c EPS drawer and graph exporter
1.261
1.262 @@ -493,7 +481,6 @@
1.263  graph exporting tools.
1.264  */
1.265
1.266 -
1.267  /**
1.268  @defgroup concept Concepts
1.269  \brief Skeleton classes and concept checking classes
1.270 @@ -521,10 +508,8 @@
1.271    concept indeed provides all the required features.
1.272
1.273  - Finally, They can serve as a skeleton of a new implementation of a concept.
1.274 -
1.275  */
1.276
1.277 -
1.278  /**
1.279  @defgroup graph_concepts Graph Structure Concepts
1.280  @ingroup concept
1.281 @@ -534,10 +519,12 @@
1.282  graph structures and helper classes used to implement these.
1.283  */
1.284
1.285 -/* --- Unused group
1.286 -@defgroup experimental Experimental Structures and Algorithms
1.287 -This group describes some Experimental structures and algorithms.
1.288 -The stuff here is subject to change.
1.289 +/**
1.290 +@defgroup map_concepts Map Concepts
1.291 +@ingroup concept
1.292 +\brief Skeleton and concept checking classes for maps
1.293 +
1.294 +This group describes the skeletons and concept checking classes of maps.
1.295  */
1.296
1.297  /**