[814] | 1 | |
---|
[678] | 2 | /** |
---|
| 3 | @defgroup datas Data Structures |
---|
[921] | 4 | This group describes the several graph structures implemented in LEMON. |
---|
[678] | 5 | */ |
---|
[430] | 6 | |
---|
[678] | 7 | /** |
---|
| 8 | @defgroup graphs Graph Structures |
---|
| 9 | @ingroup datas |
---|
[921] | 10 | \brief Graph structures implemented in LEMON. |
---|
[430] | 11 | |
---|
[1172] | 12 | The implementation of combinatorial algorithms heavily relies on |
---|
| 13 | efficient graph implementations. LEMON offers data structures which are |
---|
| 14 | planned to be easily used in an experimental phase of implementation studies, |
---|
| 15 | and thereafter the program code can be made efficient by small modifications. |
---|
[430] | 16 | |
---|
[2084] | 17 | The most efficient implementation of diverse applications require the |
---|
| 18 | usage of different physical graph implementations. These differences |
---|
| 19 | appear in the size of graph we require to handle, memory or time usage |
---|
| 20 | limitations or in the set of operations through which the graph can be |
---|
| 21 | accessed. LEMON provides several physical graph structures to meet |
---|
| 22 | the diverging requirements of the possible users. In order to save on |
---|
| 23 | running time or on memory usage, some structures may fail to provide |
---|
| 24 | some graph features like edge or node deletion. |
---|
[1172] | 25 | |
---|
| 26 | Alteration of standard containers need a very limited number of |
---|
| 27 | operations, these together satisfy the everyday requirements. |
---|
[2117] | 28 | In the case of graph structures, different operations are needed which do |
---|
[2006] | 29 | not alter the physical graph, but gives another view. If some nodes or |
---|
[1172] | 30 | edges have to be hidden or the reverse oriented graph have to be used, then |
---|
[2117] | 31 | this is the case. It also may happen that in a flow implementation |
---|
[2006] | 32 | the residual graph can be accessed by another algorithm, or a node-set |
---|
| 33 | is to be shrunk for another algorithm. |
---|
[1172] | 34 | LEMON also provides a variety of graphs for these requirements called |
---|
[1401] | 35 | \ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only |
---|
[1172] | 36 | in conjunction with other graph representation. |
---|
[430] | 37 | |
---|
[678] | 38 | You are free to use the graph structure that fit your requirements |
---|
| 39 | the best, most graph algorithms and auxiliary data structures can be used |
---|
[1172] | 40 | with any graph structures. |
---|
[678] | 41 | */ |
---|
[430] | 42 | |
---|
[678] | 43 | /** |
---|
[1866] | 44 | @defgroup semi_adaptors Semi-Adaptors Classes for Graphs |
---|
| 45 | @ingroup graphs |
---|
| 46 | \brief Graph types between real graphs and graph adaptors. |
---|
| 47 | |
---|
[2117] | 48 | Graph types between real graphs and graph adaptors. These classes wrap |
---|
| 49 | graphs to give new functionality as the adaptors do it. On the other |
---|
| 50 | hand they are not light-weight structures as the adaptors. |
---|
[1866] | 51 | */ |
---|
| 52 | |
---|
| 53 | /** |
---|
[1043] | 54 | @defgroup maps Maps |
---|
| 55 | @ingroup datas |
---|
| 56 | \brief Some special purpose map to make life easier. |
---|
| 57 | |
---|
| 58 | LEMON provides several special maps that e.g. combine |
---|
| 59 | new maps from existing ones. |
---|
| 60 | */ |
---|
| 61 | |
---|
[1402] | 62 | /** |
---|
| 63 | @defgroup graph_maps Graph Maps |
---|
| 64 | @ingroup maps |
---|
| 65 | \brief Special Graph-Related Maps. |
---|
| 66 | |
---|
| 67 | These maps are specifically designed to assign values to the nodes and edges of |
---|
| 68 | graphs. |
---|
| 69 | */ |
---|
| 70 | |
---|
| 71 | |
---|
| 72 | /** |
---|
| 73 | \defgroup map_adaptors Map Adaptors |
---|
| 74 | \ingroup maps |
---|
| 75 | \brief Tools to create new maps from existing ones |
---|
| 76 | |
---|
| 77 | Map adaptors are used to create "implicit" maps from other maps. |
---|
| 78 | |
---|
[2260] | 79 | Most of them are \ref lemon::concepts::ReadMap "ReadMap"s. They can |
---|
[2117] | 80 | make arithmetic operations between one or two maps (negation, scaling, |
---|
[1402] | 81 | addition, multiplication etc.) or e.g. convert a map to another one |
---|
| 82 | of different Value type. |
---|
| 83 | */ |
---|
| 84 | |
---|
[1043] | 85 | /** |
---|
[2072] | 86 | @defgroup matrices Matrices |
---|
| 87 | @ingroup datas |
---|
| 88 | \brief Two dimensional data storages. |
---|
| 89 | |
---|
[2084] | 90 | Two dimensional data storages. |
---|
[2072] | 91 | */ |
---|
| 92 | |
---|
[2084] | 93 | /** |
---|
| 94 | @defgroup paths Path Structures |
---|
| 95 | @ingroup datas |
---|
| 96 | \brief Path structures implemented in LEMON. |
---|
| 97 | |
---|
| 98 | LEMON provides flexible data structures |
---|
| 99 | to work with paths. |
---|
| 100 | |
---|
| 101 | All of them have the same interface, especially they can be built or extended |
---|
| 102 | using a standard Builder subclass. This make is easy to have e.g. the Dijkstra |
---|
| 103 | algorithm to store its result in any kind of path structure. |
---|
| 104 | |
---|
[2260] | 105 | \sa lemon::concepts::Path |
---|
[2084] | 106 | |
---|
| 107 | */ |
---|
[2072] | 108 | |
---|
| 109 | /** |
---|
[678] | 110 | @defgroup auxdat Auxiliary Data Structures |
---|
| 111 | @ingroup datas |
---|
[921] | 112 | \brief Some data structures implemented in LEMON. |
---|
[406] | 113 | |
---|
[921] | 114 | This group describes the data structures implemented in LEMON in |
---|
[678] | 115 | order to make it easier to implement combinatorial algorithms. |
---|
| 116 | */ |
---|
[406] | 117 | |
---|
[785] | 118 | |
---|
| 119 | /** |
---|
[2084] | 120 | @defgroup algs Algorithms |
---|
| 121 | \brief This group describes the several algorithms |
---|
[921] | 122 | implemented in LEMON. |
---|
[947] | 123 | |
---|
[2084] | 124 | This group describes the several algorithms |
---|
[947] | 125 | implemented in LEMON. |
---|
| 126 | */ |
---|
| 127 | |
---|
| 128 | /** |
---|
[2376] | 129 | @defgroup search Graph Search |
---|
[2084] | 130 | @ingroup algs |
---|
[2376] | 131 | \brief This group contains the common graph |
---|
| 132 | search algorithms. |
---|
[947] | 133 | |
---|
[2376] | 134 | This group contains the common graph |
---|
| 135 | search algorithms like Bfs and Dfs. |
---|
[678] | 136 | */ |
---|
| 137 | |
---|
| 138 | /** |
---|
[2376] | 139 | @defgroup shortest_path Shortest Path algorithms |
---|
[2084] | 140 | @ingroup algs |
---|
[758] | 141 | \brief This group describes the algorithms |
---|
[2376] | 142 | for finding shortest paths. |
---|
[2060] | 143 | |
---|
[2376] | 144 | This group describes the algorithms for finding shortest paths in |
---|
| 145 | graphs. |
---|
| 146 | |
---|
| 147 | */ |
---|
| 148 | |
---|
| 149 | /** |
---|
| 150 | @defgroup max_flow Maximum Flow algorithms |
---|
| 151 | @ingroup algs |
---|
| 152 | \brief This group describes the algorithms for finding maximum flows. |
---|
| 153 | |
---|
| 154 | This group describes the algorithms for finding maximum flows. |
---|
[2060] | 155 | |
---|
| 156 | \image html flow.png |
---|
| 157 | \image latex flow.eps "Graph flow" width=\textwidth |
---|
[678] | 158 | */ |
---|
| 159 | |
---|
| 160 | /** |
---|
[2376] | 161 | @defgroup min_cost_flow Minimum Cost Flow algorithms |
---|
| 162 | @ingroup algs |
---|
| 163 | |
---|
| 164 | \brief This group describes the algorithms |
---|
| 165 | for finding minimum cost flows and circulations. |
---|
| 166 | |
---|
| 167 | This group describes the algorithms for finding minimum cost flows and |
---|
| 168 | circulations. |
---|
| 169 | */ |
---|
| 170 | |
---|
| 171 | /** |
---|
| 172 | @defgroup min_cut Minimum Cut algorithms |
---|
| 173 | @ingroup algs |
---|
| 174 | \brief This group describes the algorithms |
---|
| 175 | for finding minimum cut in graphs. |
---|
| 176 | |
---|
| 177 | This group describes the algorithms |
---|
| 178 | for finding minimum cut in graphs. |
---|
| 179 | */ |
---|
| 180 | |
---|
| 181 | /** |
---|
[1750] | 182 | @defgroup topology Topology related algorithms |
---|
[2084] | 183 | @ingroup algs |
---|
[1750] | 184 | \brief This group describes the algorithms |
---|
| 185 | for discover the topology of the graphs. |
---|
[2060] | 186 | |
---|
| 187 | This group describes the algorithms |
---|
| 188 | for discover the topology of the graphs. |
---|
| 189 | |
---|
| 190 | \image html edge_biconnected_components.png |
---|
| 191 | \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth |
---|
[1750] | 192 | */ |
---|
| 193 | |
---|
| 194 | /** |
---|
[2376] | 195 | @defgroup matching Matching algorithms |
---|
[2084] | 196 | @ingroup algs |
---|
[2042] | 197 | \brief This group describes the algorithms |
---|
| 198 | for find matchings in graphs and bipartite graphs. |
---|
[2060] | 199 | |
---|
| 200 | This group provides some algorithm objects and function |
---|
| 201 | to calculate matchings in graphs and bipartite graphs. |
---|
| 202 | |
---|
| 203 | \image html bipartite_matching.png |
---|
| 204 | \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth |
---|
| 205 | |
---|
[2042] | 206 | */ |
---|
| 207 | |
---|
| 208 | /** |
---|
[2376] | 209 | @defgroup spantree Minimum Spanning Tree algorithms |
---|
[2084] | 210 | @ingroup algs |
---|
[2117] | 211 | \brief This group contains the algorithms for finding a minimum cost spanning |
---|
[2084] | 212 | tree in a graph |
---|
| 213 | |
---|
[2117] | 214 | This group contains the algorithms for finding a minimum cost spanning |
---|
[2084] | 215 | tree in a graph |
---|
| 216 | */ |
---|
| 217 | |
---|
| 218 | |
---|
| 219 | /** |
---|
[2376] | 220 | @defgroup auxalg Auxiliary algorithms |
---|
[2084] | 221 | @ingroup algs |
---|
| 222 | \brief Some algorithms implemented in LEMON. |
---|
| 223 | |
---|
| 224 | This group describes the algorithms in LEMON in order to make |
---|
| 225 | it easier to implement complex algorithms. |
---|
[2376] | 226 | */ |
---|
[2084] | 227 | |
---|
[2376] | 228 | /** |
---|
| 229 | @defgroup approx Approximation algorithms |
---|
| 230 | \brief Approximation algorithms |
---|
| 231 | |
---|
| 232 | Approximation and heuristic algorithms |
---|
[2084] | 233 | */ |
---|
| 234 | |
---|
| 235 | /** |
---|
| 236 | @defgroup gen_opt_group General Optimization Tools |
---|
| 237 | \brief This group describes some general optimization frameworks |
---|
| 238 | implemented in LEMON. |
---|
| 239 | |
---|
| 240 | This group describes some general optimization frameworks |
---|
| 241 | implemented in LEMON. |
---|
| 242 | |
---|
[1151] | 243 | */ |
---|
| 244 | |
---|
[2370] | 245 | /** |
---|
[2371] | 246 | @defgroup lp_group Lp and Mip solvers |
---|
[2370] | 247 | @ingroup gen_opt_group |
---|
| 248 | \brief Lp and Mip solver interfaces for LEMON. |
---|
| 249 | |
---|
| 250 | This group describes Lp and Mip solver interfaces for LEMON. The |
---|
| 251 | various LP solvers could be used in the same manner with this |
---|
| 252 | interface. |
---|
| 253 | |
---|
| 254 | */ |
---|
| 255 | |
---|
[2368] | 256 | /** |
---|
[2370] | 257 | @defgroup lp_utils Tools for Lp and Mip solvers |
---|
| 258 | @ingroup lp_group |
---|
| 259 | \brief This group adds some helper tools to the Lp and Mip solvers |
---|
| 260 | implemented in LEMON. |
---|
[2368] | 261 | |
---|
| 262 | This group adds some helper tools to general optimization framework |
---|
| 263 | implemented in LEMON. |
---|
| 264 | */ |
---|
| 265 | |
---|
[1151] | 266 | /** |
---|
[2370] | 267 | @defgroup metah Metaheuristics |
---|
| 268 | @ingroup gen_opt_group |
---|
| 269 | \brief Metaheuristics for LEMON library. |
---|
| 270 | |
---|
| 271 | This group contains some metaheuristic optimization tools. |
---|
| 272 | */ |
---|
| 273 | |
---|
| 274 | /** |
---|
[2376] | 275 | @defgroup utils Tools and Utilities |
---|
| 276 | \brief Tools and Utilities for Programming in LEMON |
---|
| 277 | |
---|
| 278 | Tools and Utilities for Programming in LEMON |
---|
| 279 | */ |
---|
| 280 | |
---|
| 281 | /** |
---|
| 282 | @defgroup gutils Basic Graph Utilities |
---|
| 283 | @ingroup utils |
---|
| 284 | \brief This group describes some simple basic graph utilities. |
---|
| 285 | |
---|
| 286 | This group describes some simple basic graph utilities. |
---|
| 287 | */ |
---|
| 288 | |
---|
| 289 | /** |
---|
[678] | 290 | @defgroup misc Miscellaneous Tools |
---|
[2376] | 291 | @ingroup utils |
---|
[678] | 292 | Here you can find several useful tools for development, |
---|
| 293 | debugging and testing. |
---|
| 294 | */ |
---|
| 295 | |
---|
[2376] | 296 | |
---|
[678] | 297 | /** |
---|
[1847] | 298 | @defgroup timecount Time measuring and Counting |
---|
| 299 | @ingroup misc |
---|
| 300 | Here you can find simple tools for measuring the performance |
---|
| 301 | of algorithms. |
---|
| 302 | */ |
---|
| 303 | |
---|
| 304 | /** |
---|
[2376] | 305 | @defgroup graphbits Tools for Graph Implementation |
---|
| 306 | @ingroup utils |
---|
| 307 | \brief Tools to Make It Easier to Make Graphs. |
---|
| 308 | |
---|
| 309 | This group describes the tools that makes it easier to make graphs and |
---|
| 310 | the maps that dynamically update with the graph changes. |
---|
| 311 | */ |
---|
| 312 | |
---|
| 313 | /** |
---|
| 314 | @defgroup exceptions Exceptions |
---|
| 315 | @ingroup utils |
---|
| 316 | This group contains the exceptions thrown by LEMON library |
---|
| 317 | */ |
---|
| 318 | |
---|
| 319 | /** |
---|
[2016] | 320 | @defgroup io_group Input-Output |
---|
[2084] | 321 | \brief Several Graph Input-Output methods |
---|
| 322 | |
---|
| 323 | Here you can find tools for importing and exporting graphs |
---|
| 324 | and graph related data. Now it supports the LEMON format, the |
---|
[2117] | 325 | \c DIMACS format and the encapsulated postscript format. |
---|
[2084] | 326 | */ |
---|
| 327 | |
---|
| 328 | /** |
---|
| 329 | @defgroup lemon_io Lemon Input-Output |
---|
| 330 | @ingroup io_group |
---|
| 331 | \brief Reading and writing LEMON format |
---|
| 332 | |
---|
| 333 | Methods for reading and writing LEMON format. More about this |
---|
| 334 | format you can find on the \ref graph-io-page "Graph Input-Output" |
---|
| 335 | tutorial pages. |
---|
[1287] | 336 | */ |
---|
| 337 | |
---|
| 338 | /** |
---|
[2016] | 339 | @defgroup section_io Section readers and writers |
---|
[2084] | 340 | @ingroup lemon_io |
---|
[2016] | 341 | \brief Section readers and writers for lemon Input-Output. |
---|
| 342 | |
---|
| 343 | Here you can find which section readers and writers can attach to |
---|
| 344 | the LemonReader and LemonWriter. |
---|
| 345 | */ |
---|
| 346 | |
---|
| 347 | /** |
---|
| 348 | @defgroup item_io Item Readers and Writers |
---|
[2084] | 349 | @ingroup lemon_io |
---|
[2016] | 350 | \brief Item readers and writers for lemon Input-Output. |
---|
| 351 | |
---|
| 352 | The Input-Output classes can handle more data type by example |
---|
| 353 | as map or attribute value. Each of these should be written and |
---|
| 354 | read some way. The module make possible to do this. |
---|
| 355 | */ |
---|
| 356 | |
---|
| 357 | /** |
---|
[2084] | 358 | @defgroup eps_io Postscript exporting |
---|
| 359 | @ingroup io_group |
---|
[2117] | 360 | \brief General \c EPS drawer and graph exporter |
---|
[2084] | 361 | |
---|
[2117] | 362 | This group contains general \c EPS drawing methods and special |
---|
[2084] | 363 | graph exporting tools. |
---|
| 364 | */ |
---|
| 365 | |
---|
| 366 | |
---|
| 367 | /** |
---|
[1030] | 368 | @defgroup concept Concepts |
---|
[959] | 369 | \brief Skeleton classes and concept checking classes |
---|
[794] | 370 | |
---|
[959] | 371 | This group describes the data/algorithm skeletons and concept checking |
---|
[1030] | 372 | classes implemented in LEMON. |
---|
| 373 | |
---|
[2117] | 374 | The purpose of the classes in this group is fourfold. |
---|
| 375 | |
---|
| 376 | - These classes contain the documentations of the concepts. In order |
---|
| 377 | to avoid document multiplications, an implementation of a concept |
---|
| 378 | simply refers to the corresponding concept class. |
---|
[1030] | 379 | |
---|
[2233] | 380 | - These classes declare every functions, <tt>typedef</tt>s etc. an |
---|
[2117] | 381 | implementation of the concepts should provide, however completely |
---|
| 382 | without implementations and real data structures behind the |
---|
| 383 | interface. On the other hand they should provide nothing else. All |
---|
| 384 | the algorithms working on a data structure meeting a certain concept |
---|
| 385 | should compile with these classes. (Though it will not run properly, |
---|
| 386 | of course.) In this way it is easily to check if an algorithm |
---|
| 387 | doesn't use any extra feature of a certain implementation. |
---|
| 388 | |
---|
[2233] | 389 | - The concept descriptor classes also provide a <em>checker class</em> |
---|
[2117] | 390 | that makes it possible check whether a certain implementation of a |
---|
| 391 | concept indeed provides all the required features. |
---|
| 392 | |
---|
| 393 | - Finally, They can serve as a skeleton of a new implementation of a concept. |
---|
[1030] | 394 | |
---|
[794] | 395 | */ |
---|
| 396 | |
---|
[2084] | 397 | |
---|
[1030] | 398 | /** |
---|
| 399 | @defgroup graph_concepts Graph Structure Concepts |
---|
| 400 | @ingroup concept |
---|
| 401 | \brief Skeleton and concept checking classes for graph structures |
---|
| 402 | |
---|
| 403 | This group contains the skeletons and concept checking classes of LEMON's |
---|
| 404 | graph structures and helper classes used to implement these. |
---|
| 405 | */ |
---|
[794] | 406 | |
---|
[1587] | 407 | /* --- Unused group |
---|
[678] | 408 | @defgroup experimental Experimental Structures and Algorithms |
---|
| 409 | This group contains some Experimental structures and algorithms. |
---|
| 410 | The stuff here is subject to change. |
---|
| 411 | */ |
---|
[1151] | 412 | |
---|
[1558] | 413 | /** |
---|
[1582] | 414 | \anchor demoprograms |
---|
| 415 | |
---|
[1558] | 416 | @defgroup demos Demo programs |
---|
| 417 | |
---|
[1559] | 418 | Some demo programs are listed here. Their full source codes can be found in |
---|
[1558] | 419 | the \c demo subdirectory of the source tree. |
---|
| 420 | |
---|
[1639] | 421 | The standard compilation procedure (<tt>./configure;make</tt>) will compile |
---|
| 422 | them, as well. |
---|
[1558] | 423 | |
---|
| 424 | */ |
---|
| 425 | |
---|