summary |
shortlog |
changelog |
graph |
tags |
bookmarks |
branches |
files |
changeset |
file |
latest |
revisions |
annotate |
diff |
comparison |
raw |
help

doc/groups.dox

changeset 606 | c5fd2d996909 |

parent 478 | 5a1e9fdcfd3a |

child 611 | eda12d8ac953 |

1.1 --- a/doc/groups.dox Thu Mar 05 10:13:20 2009 +0000 1.2 +++ b/doc/groups.dox Sun Mar 29 23:08:20 2009 +0200 1.3 @@ -20,7 +20,7 @@ 1.4 1.5 /** 1.6 @defgroup datas Data Structures 1.7 -This group describes the several data structures implemented in LEMON. 1.8 +This group contains the several data structures implemented in LEMON. 1.9 */ 1.10 1.11 /** 1.12 @@ -142,7 +142,7 @@ 1.13 @ingroup graphs 1.14 \brief Graph types between real graphs and graph adaptors. 1.15 1.16 -This group describes some graph types between real graphs and graph adaptors. 1.17 +This group contains some graph types between real graphs and graph adaptors. 1.18 These classes wrap graphs to give new functionality as the adaptors do it. 1.19 On the other hand they are not light-weight structures as the adaptors. 1.20 */ 1.21 @@ -152,7 +152,7 @@ 1.22 @ingroup datas 1.23 \brief Map structures implemented in LEMON. 1.24 1.25 -This group describes the map structures implemented in LEMON. 1.26 +This group contains the map structures implemented in LEMON. 1.27 1.28 LEMON provides several special purpose maps and map adaptors that e.g. combine 1.29 new maps from existing ones. 1.30 @@ -165,7 +165,7 @@ 1.31 @ingroup maps 1.32 \brief Special graph-related maps. 1.33 1.34 -This group describes maps that are specifically designed to assign 1.35 +This group contains maps that are specifically designed to assign 1.36 values to the nodes and arcs/edges of graphs. 1.37 1.38 If you are looking for the standard graph maps (\c NodeMap, \c ArcMap, 1.39 @@ -177,7 +177,7 @@ 1.40 \ingroup maps 1.41 \brief Tools to create new maps from existing ones 1.42 1.43 -This group describes map adaptors that are used to create "implicit" 1.44 +This group contains map adaptors that are used to create "implicit" 1.45 maps from other maps. 1.46 1.47 Most of them are \ref concepts::ReadMap "read-only maps". 1.48 @@ -240,7 +240,7 @@ 1.49 @ingroup datas 1.50 \brief Two dimensional data storages implemented in LEMON. 1.51 1.52 -This group describes two dimensional data storages implemented in LEMON. 1.53 +This group contains two dimensional data storages implemented in LEMON. 1.54 */ 1.55 1.56 /** 1.57 @@ -248,7 +248,7 @@ 1.58 @ingroup datas 1.59 \brief %Path structures implemented in LEMON. 1.60 1.61 -This group describes the path structures implemented in LEMON. 1.62 +This group contains the path structures implemented in LEMON. 1.63 1.64 LEMON provides flexible data structures to work with paths. 1.65 All of them have similar interfaces and they can be copied easily with 1.66 @@ -264,16 +264,16 @@ 1.67 @ingroup datas 1.68 \brief Auxiliary data structures implemented in LEMON. 1.69 1.70 -This group describes some data structures implemented in LEMON in 1.71 +This group contains some data structures implemented in LEMON in 1.72 order to make it easier to implement combinatorial algorithms. 1.73 */ 1.74 1.75 /** 1.76 @defgroup algs Algorithms 1.77 -\brief This group describes the several algorithms 1.78 +\brief This group contains the several algorithms 1.79 implemented in LEMON. 1.80 1.81 -This group describes the several algorithms 1.82 +This group contains the several algorithms 1.83 implemented in LEMON. 1.84 */ 1.85 1.86 @@ -282,7 +282,7 @@ 1.87 @ingroup algs 1.88 \brief Common graph search algorithms. 1.89 1.90 -This group describes the common graph search algorithms, namely 1.91 +This group contains the common graph search algorithms, namely 1.92 \e breadth-first \e search (BFS) and \e depth-first \e search (DFS). 1.93 */ 1.94 1.95 @@ -291,7 +291,7 @@ 1.96 @ingroup algs 1.97 \brief Algorithms for finding shortest paths. 1.98 1.99 -This group describes the algorithms for finding shortest paths in digraphs. 1.100 +This group contains the algorithms for finding shortest paths in digraphs. 1.101 1.102 - \ref Dijkstra algorithm for finding shortest paths from a source node 1.103 when all arc lengths are non-negative. 1.104 @@ -312,7 +312,7 @@ 1.105 @ingroup algs 1.106 \brief Algorithms for finding maximum flows. 1.107 1.108 -This group describes the algorithms for finding maximum flows and 1.109 +This group contains the algorithms for finding maximum flows and 1.110 feasible circulations. 1.111 1.112 The \e maximum \e flow \e problem is to find a flow of maximum value between 1.113 @@ -345,7 +345,7 @@ 1.114 1.115 \brief Algorithms for finding minimum cost flows and circulations. 1.116 1.117 -This group describes the algorithms for finding minimum cost flows and 1.118 +This group contains the algorithms for finding minimum cost flows and 1.119 circulations. 1.120 1.121 The \e minimum \e cost \e flow \e problem is to find a feasible flow of 1.122 @@ -382,7 +382,7 @@ 1.123 1.124 \brief Algorithms for finding minimum cut in graphs. 1.125 1.126 -This group describes the algorithms for finding minimum cut in graphs. 1.127 +This group contains the algorithms for finding minimum cut in graphs. 1.128 1.129 The \e minimum \e cut \e problem is to find a non-empty and non-complete 1.130 \f$X\f$ subset of the nodes with minimum overall capacity on 1.131 @@ -399,7 +399,7 @@ 1.132 in directed graphs. 1.133 - \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for 1.134 calculating minimum cut in undirected graphs. 1.135 -- \ref GomoryHuTree "Gomory-Hu tree computation" for calculating 1.136 +- \ref GomoryHu "Gomory-Hu tree computation" for calculating 1.137 all-pairs minimum cut in undirected graphs. 1.138 1.139 If you want to find minimum cut just between two distinict nodes, 1.140 @@ -411,7 +411,7 @@ 1.141 @ingroup algs 1.142 \brief Algorithms for discovering the graph properties 1.143 1.144 -This group describes the algorithms for discovering the graph properties 1.145 +This group contains the algorithms for discovering the graph properties 1.146 like connectivity, bipartiteness, euler property, simplicity etc. 1.147 1.148 \image html edge_biconnected_components.png 1.149 @@ -423,7 +423,7 @@ 1.150 @ingroup algs 1.151 \brief Algorithms for planarity checking, embedding and drawing 1.152 1.153 -This group describes the algorithms for planarity checking, 1.154 +This group contains the algorithms for planarity checking, 1.155 embedding and drawing. 1.156 1.157 \image html planar.png 1.158 @@ -474,7 +474,7 @@ 1.159 @ingroup algs 1.160 \brief Algorithms for finding a minimum cost spanning tree in a graph. 1.161 1.162 -This group describes the algorithms for finding a minimum cost spanning 1.163 +This group contains the algorithms for finding a minimum cost spanning 1.164 tree in a graph. 1.165 */ 1.166 1.167 @@ -483,7 +483,7 @@ 1.168 @ingroup algs 1.169 \brief Auxiliary algorithms implemented in LEMON. 1.170 1.171 -This group describes some algorithms implemented in LEMON 1.172 +This group contains some algorithms implemented in LEMON 1.173 in order to make it easier to implement complex algorithms. 1.174 */ 1.175 1.176 @@ -492,16 +492,16 @@ 1.177 @ingroup algs 1.178 \brief Approximation algorithms. 1.179 1.180 -This group describes the approximation and heuristic algorithms 1.181 +This group contains the approximation and heuristic algorithms 1.182 implemented in LEMON. 1.183 */ 1.184 1.185 /** 1.186 @defgroup gen_opt_group General Optimization Tools 1.187 -\brief This group describes some general optimization frameworks 1.188 +\brief This group contains some general optimization frameworks 1.189 implemented in LEMON. 1.190 1.191 -This group describes some general optimization frameworks 1.192 +This group contains some general optimization frameworks 1.193 implemented in LEMON. 1.194 */ 1.195 1.196 @@ -510,7 +510,7 @@ 1.197 @ingroup gen_opt_group 1.198 \brief Lp and Mip solver interfaces for LEMON. 1.199 1.200 -This group describes Lp and Mip solver interfaces for LEMON. The 1.201 +This group contains Lp and Mip solver interfaces for LEMON. The 1.202 various LP solvers could be used in the same manner with this 1.203 interface. 1.204 */ 1.205 @@ -529,7 +529,7 @@ 1.206 @ingroup gen_opt_group 1.207 \brief Metaheuristics for LEMON library. 1.208 1.209 -This group describes some metaheuristic optimization tools. 1.210 +This group contains some metaheuristic optimization tools. 1.211 */ 1.212 1.213 /** 1.214 @@ -544,7 +544,7 @@ 1.215 @ingroup utils 1.216 \brief Simple basic graph utilities. 1.217 1.218 -This group describes some simple basic graph utilities. 1.219 +This group contains some simple basic graph utilities. 1.220 */ 1.221 1.222 /** 1.223 @@ -552,7 +552,7 @@ 1.224 @ingroup utils 1.225 \brief Tools for development, debugging and testing. 1.226 1.227 -This group describes several useful tools for development, 1.228 +This group contains several useful tools for development, 1.229 debugging and testing. 1.230 */ 1.231 1.232 @@ -561,7 +561,7 @@ 1.233 @ingroup misc 1.234 \brief Simple tools for measuring the performance of algorithms. 1.235 1.236 -This group describes simple tools for measuring the performance 1.237 +This group contains simple tools for measuring the performance 1.238 of algorithms. 1.239 */ 1.240 1.241 @@ -570,14 +570,14 @@ 1.242 @ingroup utils 1.243 \brief Exceptions defined in LEMON. 1.244 1.245 -This group describes the exceptions defined in LEMON. 1.246 +This group contains the exceptions defined in LEMON. 1.247 */ 1.248 1.249 /** 1.250 @defgroup io_group Input-Output 1.251 \brief Graph Input-Output methods 1.252 1.253 -This group describes the tools for importing and exporting graphs 1.254 +This group contains the tools for importing and exporting graphs 1.255 and graph related data. Now it supports the \ref lgf-format 1.256 "LEMON Graph Format", the \c DIMACS format and the encapsulated 1.257 postscript (EPS) format. 1.258 @@ -588,7 +588,7 @@ 1.259 @ingroup io_group 1.260 \brief Reading and writing LEMON Graph Format. 1.261 1.262 -This group describes methods for reading and writing 1.263 +This group contains methods for reading and writing 1.264 \ref lgf-format "LEMON Graph Format". 1.265 */ 1.266 1.267 @@ -597,7 +597,7 @@ 1.268 @ingroup io_group 1.269 \brief General \c EPS drawer and graph exporter 1.270 1.271 -This group describes general \c EPS drawing methods and special 1.272 +This group contains general \c EPS drawing methods and special 1.273 graph exporting tools. 1.274 */ 1.275 1.276 @@ -621,7 +621,7 @@ 1.277 @defgroup concept Concepts 1.278 \brief Skeleton classes and concept checking classes 1.279 1.280 -This group describes the data/algorithm skeletons and concept checking 1.281 +This group contains the data/algorithm skeletons and concept checking 1.282 classes implemented in LEMON. 1.283 1.284 The purpose of the classes in this group is fourfold. 1.285 @@ -651,7 +651,7 @@ 1.286 @ingroup concept 1.287 \brief Skeleton and concept checking classes for graph structures 1.288 1.289 -This group describes the skeletons and concept checking classes of LEMON's 1.290 +This group contains the skeletons and concept checking classes of LEMON's 1.291 graph structures and helper classes used to implement these. 1.292 */ 1.293 1.294 @@ -660,7 +660,7 @@ 1.295 @ingroup concept 1.296 \brief Skeleton and concept checking classes for maps 1.297 1.298 -This group describes the skeletons and concept checking classes of maps. 1.299 +This group contains the skeletons and concept checking classes of maps. 1.300 */ 1.301 1.302 /**