Changes in doc/groups.dox [318:1e2d6ca80793:963:3ed8f7c8bed8] in lemon
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/groups.dox
r318 r963 3 3 * This file is a part of LEMON, a generic C++ optimization library. 4 4 * 5 * Copyright (C) 2003-20 085 * Copyright (C) 2003-2010 6 6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport 7 7 * (Egervary Research Group on Combinatorial Optimization, EGRES). … … 17 17 */ 18 18 19 namespace lemon { 20 19 21 /** 20 22 @defgroup datas Data Structures 21 This group describes the several data structures implemented in LEMON.23 This group contains the several data structures implemented in LEMON. 22 24 */ 23 25 … … 61 63 62 64 /** 63 @defgroup semi_adaptors Semi-Adaptor Classes for Graphs65 @defgroup graph_adaptors Adaptor Classes for Graphs 64 66 @ingroup graphs 65 \brief Graph types between real graphs and graph adaptors. 66 67 This group describes some graph types between real graphs and graph adaptors. 68 These classes wrap graphs to give new functionality as the adaptors do it. 69 On the other hand they are not light-weight structures as the adaptors. 67 \brief Adaptor classes for digraphs and graphs 68 69 This group contains several useful adaptor classes for digraphs and graphs. 70 71 The main parts of LEMON are the different graph structures, generic 72 graph algorithms, graph concepts, which couple them, and graph 73 adaptors. While the previous notions are more or less clear, the 74 latter one needs further explanation. Graph adaptors are graph classes 75 which serve for considering graph structures in different ways. 76 77 A short example makes this much clearer. Suppose that we have an 78 instance \c g of a directed graph type, say ListDigraph and an algorithm 79 \code 80 template <typename Digraph> 81 int algorithm(const Digraph&); 82 \endcode 83 is needed to run on the reverse oriented graph. It may be expensive 84 (in time or in memory usage) to copy \c g with the reversed 85 arcs. In this case, an adaptor class is used, which (according 86 to LEMON \ref concepts::Digraph "digraph concepts") works as a digraph. 87 The adaptor uses the original digraph structure and digraph operations when 88 methods of the reversed oriented graph are called. This means that the adaptor 89 have minor memory usage, and do not perform sophisticated algorithmic 90 actions. The purpose of it is to give a tool for the cases when a 91 graph have to be used in a specific alteration. If this alteration is 92 obtained by a usual construction like filtering the node or the arc set or 93 considering a new orientation, then an adaptor is worthwhile to use. 94 To come back to the reverse oriented graph, in this situation 95 \code 96 template<typename Digraph> class ReverseDigraph; 97 \endcode 98 template class can be used. The code looks as follows 99 \code 100 ListDigraph g; 101 ReverseDigraph<ListDigraph> rg(g); 102 int result = algorithm(rg); 103 \endcode 104 During running the algorithm, the original digraph \c g is untouched. 105 This techniques give rise to an elegant code, and based on stable 106 graph adaptors, complex algorithms can be implemented easily. 107 108 In flow, circulation and matching problems, the residual 109 graph is of particular importance. Combining an adaptor implementing 110 this with shortest path algorithms or minimum mean cycle algorithms, 111 a range of weighted and cardinality optimization algorithms can be 112 obtained. For other examples, the interested user is referred to the 113 detailed documentation of particular adaptors. 114 115 The behavior of graph adaptors can be very different. Some of them keep 116 capabilities of the original graph while in other cases this would be 117 meaningless. This means that the concepts that they meet depend 118 on the graph adaptor, and the wrapped graph. 119 For example, if an arc of a reversed digraph is deleted, this is carried 120 out by deleting the corresponding arc of the original digraph, thus the 121 adaptor modifies the original digraph. 122 However in case of a residual digraph, this operation has no sense. 123 124 Let us stand one more example here to simplify your work. 125 ReverseDigraph has constructor 126 \code 127 ReverseDigraph(Digraph& digraph); 128 \endcode 129 This means that in a situation, when a <tt>const %ListDigraph&</tt> 130 reference to a graph is given, then it have to be instantiated with 131 <tt>Digraph=const %ListDigraph</tt>. 132 \code 133 int algorithm1(const ListDigraph& g) { 134 ReverseDigraph<const ListDigraph> rg(g); 135 return algorithm2(rg); 136 } 137 \endcode 70 138 */ 71 139 … … 75 143 \brief Map structures implemented in LEMON. 76 144 77 This group describes the map structures implemented in LEMON.145 This group contains the map structures implemented in LEMON. 78 146 79 147 LEMON provides several special purpose maps and map adaptors that e.g. combine … … 88 156 \brief Special graph-related maps. 89 157 90 This group describes maps that are specifically designed to assign 91 values to the nodes and arcs of graphs. 158 This group contains maps that are specifically designed to assign 159 values to the nodes and arcs/edges of graphs. 160 161 If you are looking for the standard graph maps (\c NodeMap, \c ArcMap, 162 \c EdgeMap), see the \ref graph_concepts "Graph Structure Concepts". 92 163 */ 93 164 … … 97 168 \brief Tools to create new maps from existing ones 98 169 99 This group describes map adaptors that are used to create "implicit"170 This group contains map adaptors that are used to create "implicit" 100 171 maps from other maps. 101 172 102 Most of them are \ref lemon::concepts::ReadMap "read-only maps".173 Most of them are \ref concepts::ReadMap "read-only maps". 103 174 They can make arithmetic and logical operations between one or two maps 104 175 (negation, shifting, addition, multiplication, logical 'and', 'or', … … 156 227 157 228 /** 158 @defgroup matrices Matrices159 @ingroup datas160 \brief Two dimensional data storages implemented in LEMON.161 162 This group describes two dimensional data storages implemented in LEMON.163 */164 165 /**166 229 @defgroup paths Path Structures 167 230 @ingroup datas 168 231 \brief %Path structures implemented in LEMON. 169 232 170 This group describes the path structures implemented in LEMON.233 This group contains the path structures implemented in LEMON. 171 234 172 235 LEMON provides flexible data structures to work with paths. … … 176 239 any kind of path structure. 177 240 178 \sa lemon::concepts::Path 241 \sa \ref concepts::Path "Path concept" 242 */ 243 244 /** 245 @defgroup heaps Heap Structures 246 @ingroup datas 247 \brief %Heap structures implemented in LEMON. 248 249 This group contains the heap structures implemented in LEMON. 250 251 LEMON provides several heap classes. They are efficient implementations 252 of the abstract data type \e priority \e queue. They store items with 253 specified values called \e priorities in such a way that finding and 254 removing the item with minimum priority are efficient. 255 The basic operations are adding and erasing items, changing the priority 256 of an item, etc. 257 258 Heaps are crucial in several algorithms, such as Dijkstra and Prim. 259 The heap implementations have the same interface, thus any of them can be 260 used easily in such algorithms. 261 262 \sa \ref concepts::Heap "Heap concept" 179 263 */ 180 264 … … 184 268 \brief Auxiliary data structures implemented in LEMON. 185 269 186 This group describes some data structures implemented in LEMON in270 This group contains some data structures implemented in LEMON in 187 271 order to make it easier to implement combinatorial algorithms. 188 272 */ 189 273 190 274 /** 275 @defgroup geomdat Geometric Data Structures 276 @ingroup auxdat 277 \brief Geometric data structures implemented in LEMON. 278 279 This group contains geometric data structures implemented in LEMON. 280 281 - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional 282 vector with the usual operations. 283 - \ref lemon::dim2::Box "dim2::Box" can be used to determine the 284 rectangular bounding box of a set of \ref lemon::dim2::Point 285 "dim2::Point"'s. 286 */ 287 288 /** 191 289 @defgroup algs Algorithms 192 \brief This group describes the several algorithms290 \brief This group contains the several algorithms 193 291 implemented in LEMON. 194 292 195 This group describes the several algorithms293 This group contains the several algorithms 196 294 implemented in LEMON. 197 295 */ … … 202 300 \brief Common graph search algorithms. 203 301 204 This group describes the common graph search algorithms like 205 Breadth-First Search (BFS) and Depth-First Search (DFS). 302 This group contains the common graph search algorithms, namely 303 \e breadth-first \e search (BFS) and \e depth-first \e search (DFS) 304 \ref clrs01algorithms. 206 305 */ 207 306 … … 211 310 \brief Algorithms for finding shortest paths. 212 311 213 This group describes the algorithms for finding shortest paths in graphs. 312 This group contains the algorithms for finding shortest paths in digraphs 313 \ref clrs01algorithms. 314 315 - \ref Dijkstra algorithm for finding shortest paths from a source node 316 when all arc lengths are non-negative. 317 - \ref BellmanFord "Bellman-Ford" algorithm for finding shortest paths 318 from a source node when arc lenghts can be either positive or negative, 319 but the digraph should not contain directed cycles with negative total 320 length. 321 - \ref Suurballe A successive shortest path algorithm for finding 322 arc-disjoint paths between two nodes having minimum total length. 323 */ 324 325 /** 326 @defgroup spantree Minimum Spanning Tree Algorithms 327 @ingroup algs 328 \brief Algorithms for finding minimum cost spanning trees and arborescences. 329 330 This group contains the algorithms for finding minimum cost spanning 331 trees and arborescences \ref clrs01algorithms. 214 332 */ 215 333 … … 219 337 \brief Algorithms for finding maximum flows. 220 338 221 This group describes the algorithms for finding maximum flows and222 feasible circulations .223 224 The maximum flow problem is to find a flow between a single source and225 a single target that is maximum. Formally, there is a \f$G=(V,A)\f$226 di rected graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity227 function and given \f$s, t \in V\f$ source and target node. The 228 maximum flow is the \f$f_a\f$ solution of the next optimization problem: 229 230 \f[ 0 \le f_a \le c_a \f] 231 \f[ \ sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv}232 \ qquad \forall u \in V \setminus \{s,t\}\f]233 \f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]234 235 LEMON contains several algorithms for solving maximum flow problems: 236 - \ref lemon::EdmondsKarp "Edmonds-Karp" 237 - \ref lemon::Preflow "Goldberg's Preflow algorithm" 238 - \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees" 239 - \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees" 240 241 In most cases the \ref lemon::Preflow "Preflow" algorithm provides the 242 f astest method to compute the maximum flow. All impelementations243 provides functions to query the minimum cut, which is the dual linear 244 programming problem of the maximum flow.245 */ 246 247 /** 248 @defgroup min_cost_flow Minimum Cost Flow Algorithms339 This group contains the algorithms for finding maximum flows and 340 feasible circulations \ref clrs01algorithms, \ref amo93networkflows. 341 342 The \e maximum \e flow \e problem is to find a flow of maximum value between 343 a single source and a single target. Formally, there is a \f$G=(V,A)\f$ 344 digraph, a \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function and 345 \f$s, t \in V\f$ source and target nodes. 346 A maximum flow is an \f$f: A\rightarrow\mathbf{R}^+_0\f$ solution of the 347 following optimization problem. 348 349 \f[ \max\sum_{sv\in A} f(sv) - \sum_{vs\in A} f(vs) \f] 350 \f[ \sum_{uv\in A} f(uv) = \sum_{vu\in A} f(vu) 351 \quad \forall u\in V\setminus\{s,t\} \f] 352 \f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f] 353 354 \ref Preflow is an efficient implementation of Goldberg-Tarjan's 355 preflow push-relabel algorithm \ref goldberg88newapproach for finding 356 maximum flows. It also provides functions to query the minimum cut, 357 which is the dual problem of maximum flow. 358 359 \ref Circulation is a preflow push-relabel algorithm implemented directly 360 for finding feasible circulations, which is a somewhat different problem, 361 but it is strongly related to maximum flow. 362 For more information, see \ref Circulation. 363 */ 364 365 /** 366 @defgroup min_cost_flow_algs Minimum Cost Flow Algorithms 249 367 @ingroup algs 250 368 251 369 \brief Algorithms for finding minimum cost flows and circulations. 252 370 253 This group describes the algorithms for finding minimum cost flows and 254 circulations. 371 This group contains the algorithms for finding minimum cost flows and 372 circulations \ref amo93networkflows. For more information about this 373 problem and its dual solution, see \ref min_cost_flow 374 "Minimum Cost Flow Problem". 375 376 LEMON contains several algorithms for this problem. 377 - \ref NetworkSimplex Primal Network Simplex algorithm with various 378 pivot strategies \ref dantzig63linearprog, \ref kellyoneill91netsimplex. 379 - \ref CostScaling Cost Scaling algorithm based on push/augment and 380 relabel operations \ref goldberg90approximation, \ref goldberg97efficient, 381 \ref bunnagel98efficient. 382 - \ref CapacityScaling Capacity Scaling algorithm based on the successive 383 shortest path method \ref edmondskarp72theoretical. 384 - \ref CycleCanceling Cycle-Canceling algorithms, two of which are 385 strongly polynomial \ref klein67primal, \ref goldberg89cyclecanceling. 386 387 In general NetworkSimplex is the most efficient implementation, 388 but in special cases other algorithms could be faster. 389 For example, if the total supply and/or capacities are rather small, 390 CapacityScaling is usually the fastest algorithm (without effective scaling). 255 391 */ 256 392 … … 261 397 \brief Algorithms for finding minimum cut in graphs. 262 398 263 This group describes the algorithms for finding minimum cut in graphs.264 265 The minimum cutproblem is to find a non-empty and non-complete266 \f$X\f$ subset of the vertices with minimum overall capacity on267 outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an268 \f$c _a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum399 This group contains the algorithms for finding minimum cut in graphs. 400 401 The \e minimum \e cut \e problem is to find a non-empty and non-complete 402 \f$X\f$ subset of the nodes with minimum overall capacity on 403 outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a 404 \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum 269 405 cut is the \f$X\f$ solution of the next optimization problem: 270 406 271 407 \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}} 272 \sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]408 \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f] 273 409 274 410 LEMON contains several algorithms related to minimum cut problems: 275 411 276 - \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut 277 in directed graphs 278 - \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to 279 calculate minimum cut in undirected graphs 280 - \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all 281 pairs minimum cut in undirected graphs 412 - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut 413 in directed graphs. 414 - \ref GomoryHu "Gomory-Hu tree computation" for calculating 415 all-pairs minimum cut in undirected graphs. 282 416 283 417 If you want to find minimum cut just between two distinict nodes, 284 please see the \ref max_flow "Maximum Flow page". 285 */ 286 287 /** 288 @defgroup graph_prop Connectivity and Other Graph Properties 289 @ingroup algs 290 \brief Algorithms for discovering the graph properties 291 292 This group describes the algorithms for discovering the graph properties 293 like connectivity, bipartiteness, euler property, simplicity etc. 294 295 \image html edge_biconnected_components.png 296 \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth 297 */ 298 299 /** 300 @defgroup planar Planarity Embedding and Drawing 301 @ingroup algs 302 \brief Algorithms for planarity checking, embedding and drawing 303 304 This group describes the algorithms for planarity checking, 305 embedding and drawing. 306 307 \image html planar.png 308 \image latex planar.eps "Plane graph" width=\textwidth 418 see the \ref max_flow "maximum flow problem". 419 */ 420 421 /** 422 @defgroup min_mean_cycle Minimum Mean Cycle Algorithms 423 @ingroup algs 424 \brief Algorithms for finding minimum mean cycles. 425 426 This group contains the algorithms for finding minimum mean cycles 427 \ref clrs01algorithms, \ref amo93networkflows. 428 429 The \e minimum \e mean \e cycle \e problem is to find a directed cycle 430 of minimum mean length (cost) in a digraph. 431 The mean length of a cycle is the average length of its arcs, i.e. the 432 ratio between the total length of the cycle and the number of arcs on it. 433 434 This problem has an important connection to \e conservative \e length 435 \e functions, too. A length function on the arcs of a digraph is called 436 conservative if and only if there is no directed cycle of negative total 437 length. For an arbitrary length function, the negative of the minimum 438 cycle mean is the smallest \f$\epsilon\f$ value so that increasing the 439 arc lengths uniformly by \f$\epsilon\f$ results in a conservative length 440 function. 441 442 LEMON contains three algorithms for solving the minimum mean cycle problem: 443 - \ref KarpMmc Karp's original algorithm \ref amo93networkflows, 444 \ref dasdan98minmeancycle. 445 - \ref HartmannOrlinMmc Hartmann-Orlin's algorithm, which is an improved 446 version of Karp's algorithm \ref dasdan98minmeancycle. 447 - \ref HowardMmc Howard's policy iteration algorithm 448 \ref dasdan98minmeancycle. 449 450 In practice, the \ref HowardMmc "Howard" algorithm proved to be by far the 451 most efficient one, though the best known theoretical bound on its running 452 time is exponential. 453 Both \ref KarpMmc "Karp" and \ref HartmannOrlinMmc "Hartmann-Orlin" algorithms 454 run in time O(ne) and use space O(n<sup>2</sup>+e), but the latter one is 455 typically faster due to the applied early termination scheme. 309 456 */ 310 457 … … 314 461 \brief Algorithms for finding matchings in graphs and bipartite graphs. 315 462 316 This group contains algorithm objects and functions to calculate463 This group contains the algorithms for calculating 317 464 matchings in graphs and bipartite graphs. The general matching problem is 318 finding a subset of the arcs which does not shares common endpoints. 465 finding a subset of the edges for which each node has at most one incident 466 edge. 319 467 320 468 There are several different algorithms for calculate matchings in 321 469 graphs. The matching problems in bipartite graphs are generally 322 470 easier than in general graphs. The goal of the matching optimization 323 can be thefinding maximum cardinality, maximum weight or minimum cost471 can be finding maximum cardinality, maximum weight or minimum cost 324 472 matching. The search can be constrained to find perfect or 325 473 maximum cardinality matching. 326 474 327 LEMON contains the next algorithms: 328 - \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp 329 augmenting path algorithm for calculate maximum cardinality matching in 330 bipartite graphs 331 - \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel 332 algorithm for calculate maximum cardinality matching in bipartite graphs 333 - \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching" 334 Successive shortest path algorithm for calculate maximum weighted matching 335 and maximum weighted bipartite matching in bipartite graph 336 - \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching" 337 Successive shortest path algorithm for calculate minimum cost maximum 338 matching in bipartite graph 339 - \ref lemon::MaxMatching "MaxMatching" Edmond's blossom shrinking algorithm 340 for calculate maximum cardinality matching in general graph 341 - \ref lemon::MaxWeightedMatching "MaxWeightedMatching" Edmond's blossom 342 shrinking algorithm for calculate maximum weighted matching in general 343 graph 344 - \ref lemon::MaxWeightedPerfectMatching "MaxWeightedPerfectMatching" 345 Edmond's blossom shrinking algorithm for calculate maximum weighted 346 perfect matching in general graph 347 348 \image html bipartite_matching.png 349 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth 350 */ 351 352 /** 353 @defgroup spantree Minimum Spanning Tree Algorithms 354 @ingroup algs 355 \brief Algorithms for finding a minimum cost spanning tree in a graph. 356 357 This group describes the algorithms for finding a minimum cost spanning 358 tree in a graph 475 The matching algorithms implemented in LEMON: 476 - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating 477 maximum cardinality matching in general graphs. 478 - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating 479 maximum weighted matching in general graphs. 480 - \ref MaxWeightedPerfectMatching 481 Edmond's blossom shrinking algorithm for calculating maximum weighted 482 perfect matching in general graphs. 483 - \ref MaxFractionalMatching Push-relabel algorithm for calculating 484 maximum cardinality fractional matching in general graphs. 485 - \ref MaxWeightedFractionalMatching Augmenting path algorithm for calculating 486 maximum weighted fractional matching in general graphs. 487 - \ref MaxWeightedPerfectFractionalMatching 488 Augmenting path algorithm for calculating maximum weighted 489 perfect fractional matching in general graphs. 490 491 \image html matching.png 492 \image latex matching.eps "Min Cost Perfect Matching" width=\textwidth 493 */ 494 495 /** 496 @defgroup graph_properties Connectivity and Other Graph Properties 497 @ingroup algs 498 \brief Algorithms for discovering the graph properties 499 500 This group contains the algorithms for discovering the graph properties 501 like connectivity, bipartiteness, euler property, simplicity etc. 502 503 \image html connected_components.png 504 \image latex connected_components.eps "Connected components" width=\textwidth 505 */ 506 507 /** 508 @defgroup planar Planarity Embedding and Drawing 509 @ingroup algs 510 \brief Algorithms for planarity checking, embedding and drawing 511 512 This group contains the algorithms for planarity checking, 513 embedding and drawing. 514 515 \image html planar.png 516 \image latex planar.eps "Plane graph" width=\textwidth 359 517 */ 360 518 … … 364 522 \brief Auxiliary algorithms implemented in LEMON. 365 523 366 This group describes some algorithms implemented in LEMON524 This group contains some algorithms implemented in LEMON 367 525 in order to make it easier to implement complex algorithms. 368 526 */ 369 527 370 528 /** 371 @defgroup approx Approximation Algorithms 372 @ingroup algs 373 \brief Approximation algorithms. 374 375 This group describes the approximation and heuristic algorithms 529 @defgroup gen_opt_group General Optimization Tools 530 \brief This group contains some general optimization frameworks 376 531 implemented in LEMON. 377 */ 378 379 /** 380 @defgroup gen_opt_group General Optimization Tools 381 \brief This group describes some general optimization frameworks 532 533 This group contains some general optimization frameworks 382 534 implemented in LEMON. 383 384 This group describes some general optimization frameworks 385 implemented in LEMON. 386 */ 387 388 /** 389 @defgroup lp_group Lp and Mip Solvers 535 */ 536 537 /** 538 @defgroup lp_group LP and MIP Solvers 390 539 @ingroup gen_opt_group 391 \brief Lp and Mip solver interfaces for LEMON. 392 393 This group describes Lp and Mip solver interfaces for LEMON. The 394 various LP solvers could be used in the same manner with this 395 interface. 396 */ 397 398 /** 399 @defgroup lp_utils Tools for Lp and Mip Solvers 400 @ingroup lp_group 401 \brief Helper tools to the Lp and Mip solvers. 402 403 This group adds some helper tools to general optimization framework 404 implemented in LEMON. 405 */ 406 407 /** 408 @defgroup metah Metaheuristics 409 @ingroup gen_opt_group 410 \brief Metaheuristics for LEMON library. 411 412 This group describes some metaheuristic optimization tools. 540 \brief LP and MIP solver interfaces for LEMON. 541 542 This group contains LP and MIP solver interfaces for LEMON. 543 Various LP solvers could be used in the same manner with this 544 high-level interface. 545 546 The currently supported solvers are \ref glpk, \ref clp, \ref cbc, 547 \ref cplex, \ref soplex. 413 548 */ 414 549 … … 425 560 \brief Simple basic graph utilities. 426 561 427 This group describes some simple basic graph utilities.562 This group contains some simple basic graph utilities. 428 563 */ 429 564 … … 433 568 \brief Tools for development, debugging and testing. 434 569 435 This group describes several useful tools for development,570 This group contains several useful tools for development, 436 571 debugging and testing. 437 572 */ … … 442 577 \brief Simple tools for measuring the performance of algorithms. 443 578 444 This group describes simple tools for measuring the performance579 This group contains simple tools for measuring the performance 445 580 of algorithms. 446 581 */ … … 451 586 \brief Exceptions defined in LEMON. 452 587 453 This group describes the exceptions defined in LEMON.588 This group contains the exceptions defined in LEMON. 454 589 */ 455 590 … … 458 593 \brief Graph Input-Output methods 459 594 460 This group describes the tools for importing and exporting graphs595 This group contains the tools for importing and exporting graphs 461 596 and graph related data. Now it supports the \ref lgf-format 462 597 "LEMON Graph Format", the \c DIMACS format and the encapsulated … … 465 600 466 601 /** 467 @defgroup lemon_io LEMON Input-Output602 @defgroup lemon_io LEMON Graph Format 468 603 @ingroup io_group 469 604 \brief Reading and writing LEMON Graph Format. 470 605 471 This group describes methods for reading and writing606 This group contains methods for reading and writing 472 607 \ref lgf-format "LEMON Graph Format". 473 608 */ … … 478 613 \brief General \c EPS drawer and graph exporter 479 614 480 This group describes general \c EPS drawing methods and special615 This group contains general \c EPS drawing methods and special 481 616 graph exporting tools. 617 */ 618 619 /** 620 @defgroup dimacs_group DIMACS Format 621 @ingroup io_group 622 \brief Read and write files in DIMACS format 623 624 Tools to read a digraph from or write it to a file in DIMACS format data. 625 */ 626 627 /** 628 @defgroup nauty_group NAUTY Format 629 @ingroup io_group 630 \brief Read \e Nauty format 631 632 Tool to read graphs from \e Nauty format data. 482 633 */ 483 634 … … 486 637 \brief Skeleton classes and concept checking classes 487 638 488 This group describes the data/algorithm skeletons and concept checking639 This group contains the data/algorithm skeletons and concept checking 489 640 classes implemented in LEMON. 490 641 … … 516 667 \brief Skeleton and concept checking classes for graph structures 517 668 518 This group describes the skeletons and concept checking classes of LEMON's519 graph structures and helper classes used to implement these.669 This group contains the skeletons and concept checking classes of 670 graph structures. 520 671 */ 521 672 … … 525 676 \brief Skeleton and concept checking classes for maps 526 677 527 This group describes the skeletons and concept checking classes of maps. 678 This group contains the skeletons and concept checking classes of maps. 679 */ 680 681 /** 682 @defgroup tools Standalone Utility Applications 683 684 Some utility applications are listed here. 685 686 The standard compilation procedure (<tt>./configure;make</tt>) will compile 687 them, as well. 528 688 */ 529 689 … … 531 691 \anchor demoprograms 532 692 533 @defgroup demos Demo programs693 @defgroup demos Demo Programs 534 694 535 695 Some demo programs are listed here. Their full source codes can be found in 536 696 the \c demo subdirectory of the source tree. 537 697 538 It order to compile them, use <tt>--enable-demo</tt> configure option when 539 build the library. 540 */ 541 542 /** 543 @defgroup tools Standalone utility applications 544 545 Some utility applications are listed here. 546 547 The standard compilation procedure (<tt>./configure;make</tt>) will compile 548 them, as well. 549 */ 550 698 In order to compile them, use the <tt>make demo</tt> or the 699 <tt>make check</tt> commands. 700 */ 701 702 }
Note: See TracChangeset
for help on using the changeset viewer.