doc/groups.dox
author Alpar Juttner <alpar@cs.elte.hu>
Fri, 09 Aug 2013 18:56:00 +0200
branch1.3
changeset 1280 fbdde70389da
parent 1271 fb1c7da561ce
permissions -rw-r--r--
Trim the documentation
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2013
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 namespace lemon {
    20 
    21 /**
    22 @defgroup datas Data Structures
    23 This group contains the several data structures implemented in LEMON.
    24 */
    25 
    26 /**
    27 @defgroup graphs Graph Structures
    28 @ingroup datas
    29 \brief Graph structures implemented in LEMON.
    30 
    31 The implementation of combinatorial algorithms heavily relies on
    32 efficient graph implementations. LEMON offers data structures which are
    33 planned to be easily used in an experimental phase of implementation studies,
    34 and thereafter the program code can be made efficient by small modifications.
    35 
    36 The most efficient implementation of diverse applications require the
    37 usage of different physical graph implementations. These differences
    38 appear in the size of graph we require to handle, memory or time usage
    39 limitations or in the set of operations through which the graph can be
    40 accessed.  LEMON provides several physical graph structures to meet
    41 the diverging requirements of the possible users.  In order to save on
    42 running time or on memory usage, some structures may fail to provide
    43 some graph features like arc/edge or node deletion.
    44 
    45 Alteration of standard containers need a very limited number of
    46 operations, these together satisfy the everyday requirements.
    47 In the case of graph structures, different operations are needed which do
    48 not alter the physical graph, but gives another view. If some nodes or
    49 arcs have to be hidden or the reverse oriented graph have to be used, then
    50 this is the case. It also may happen that in a flow implementation
    51 the residual graph can be accessed by another algorithm, or a node-set
    52 is to be shrunk for another algorithm.
    53 LEMON also provides a variety of graphs for these requirements called
    54 \ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only
    55 in conjunction with other graph representations.
    56 
    57 You are free to use the graph structure that fit your requirements
    58 the best, most graph algorithms and auxiliary data structures can be used
    59 with any graph structure.
    60 
    61 <b>See also:</b> \ref graph_concepts "Graph Structure Concepts".
    62 */
    63 
    64 /**
    65 @defgroup graph_adaptors Adaptor Classes for Graphs
    66 @ingroup graphs
    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 Since the adaptor classes conform to the \ref graph_concepts "graph concepts",
   116 an adaptor can even be applied to another one.
   117 The following image illustrates a situation when a \ref SubDigraph adaptor
   118 is applied on a digraph and \ref Undirector is applied on the subgraph.
   119 
   120 \image html adaptors2.png
   121 \image latex adaptors2.eps "Using graph adaptors" width=\textwidth
   122 
   123 The behavior of graph adaptors can be very different. Some of them keep
   124 capabilities of the original graph while in other cases this would be
   125 meaningless. This means that the concepts that they meet depend
   126 on the graph adaptor, and the wrapped graph.
   127 For example, if an arc of a reversed digraph is deleted, this is carried
   128 out by deleting the corresponding arc of the original digraph, thus the
   129 adaptor modifies the original digraph.
   130 However in case of a residual digraph, this operation has no sense.
   131 
   132 Let us stand one more example here to simplify your work.
   133 ReverseDigraph has constructor
   134 \code
   135 ReverseDigraph(Digraph& digraph);
   136 \endcode
   137 This means that in a situation, when a <tt>const %ListDigraph&</tt>
   138 reference to a graph is given, then it have to be instantiated with
   139 <tt>Digraph=const %ListDigraph</tt>.
   140 \code
   141 int algorithm1(const ListDigraph& g) {
   142   ReverseDigraph<const ListDigraph> rg(g);
   143   return algorithm2(rg);
   144 }
   145 \endcode
   146 */
   147 
   148 /**
   149 @defgroup maps Maps
   150 @ingroup datas
   151 \brief Map structures implemented in LEMON.
   152 
   153 This group contains the map structures implemented in LEMON.
   154 
   155 LEMON provides several special purpose maps and map adaptors that e.g. combine
   156 new maps from existing ones.
   157 
   158 <b>See also:</b> \ref map_concepts "Map Concepts".
   159 */
   160 
   161 /**
   162 @defgroup graph_maps Graph Maps
   163 @ingroup maps
   164 \brief Special graph-related maps.
   165 
   166 This group contains maps that are specifically designed to assign
   167 values to the nodes and arcs/edges of graphs.
   168 
   169 If you are looking for the standard graph maps (\c NodeMap, \c ArcMap,
   170 \c EdgeMap), see the \ref graph_concepts "Graph Structure Concepts".
   171 */
   172 
   173 /**
   174 \defgroup map_adaptors Map Adaptors
   175 \ingroup maps
   176 \brief Tools to create new maps from existing ones
   177 
   178 This group contains map adaptors that are used to create "implicit"
   179 maps from other maps.
   180 
   181 Most of them are \ref concepts::ReadMap "read-only maps".
   182 They can make arithmetic and logical operations between one or two maps
   183 (negation, shifting, addition, multiplication, logical 'and', 'or',
   184 'not' etc.) or e.g. convert a map to another one of different Value type.
   185 
   186 The typical usage of this classes is passing implicit maps to
   187 algorithms.  If a function type algorithm is called then the function
   188 type map adaptors can be used comfortable. For example let's see the
   189 usage of map adaptors with the \c graphToEps() function.
   190 \code
   191   Color nodeColor(int deg) {
   192     if (deg >= 2) {
   193       return Color(0.5, 0.0, 0.5);
   194     } else if (deg == 1) {
   195       return Color(1.0, 0.5, 1.0);
   196     } else {
   197       return Color(0.0, 0.0, 0.0);
   198     }
   199   }
   200 
   201   Digraph::NodeMap<int> degree_map(graph);
   202 
   203   graphToEps(graph, "graph.eps")
   204     .coords(coords).scaleToA4().undirected()
   205     .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
   206     .run();
   207 \endcode
   208 The \c functorToMap() function makes an \c int to \c Color map from the
   209 \c nodeColor() function. The \c composeMap() compose the \c degree_map
   210 and the previously created map. The composed map is a proper function to
   211 get the color of each node.
   212 
   213 The usage with class type algorithms is little bit harder. In this
   214 case the function type map adaptors can not be used, because the
   215 function map adaptors give back temporary objects.
   216 \code
   217   Digraph graph;
   218 
   219   typedef Digraph::ArcMap<double> DoubleArcMap;
   220   DoubleArcMap length(graph);
   221   DoubleArcMap speed(graph);
   222 
   223   typedef DivMap<DoubleArcMap, DoubleArcMap> TimeMap;
   224   TimeMap time(length, speed);
   225 
   226   Dijkstra<Digraph, TimeMap> dijkstra(graph, time);
   227   dijkstra.run(source, target);
   228 \endcode
   229 We have a length map and a maximum speed map on the arcs of a digraph.
   230 The minimum time to pass the arc can be calculated as the division of
   231 the two maps which can be done implicitly with the \c DivMap template
   232 class. We use the implicit minimum time map as the length map of the
   233 \c Dijkstra algorithm.
   234 */
   235 
   236 /**
   237 @defgroup paths Path Structures
   238 @ingroup datas
   239 \brief %Path structures implemented in LEMON.
   240 
   241 This group contains the path structures implemented in LEMON.
   242 
   243 LEMON provides flexible data structures to work with paths.
   244 All of them have similar interfaces and they can be copied easily with
   245 assignment operators and copy constructors. This makes it easy and
   246 efficient to have e.g. the Dijkstra algorithm to store its result in
   247 any kind of path structure.
   248 
   249 \sa \ref concepts::Path "Path concept"
   250 */
   251 
   252 /**
   253 @defgroup heaps Heap Structures
   254 @ingroup datas
   255 \brief %Heap structures implemented in LEMON.
   256 
   257 This group contains the heap structures implemented in LEMON.
   258 
   259 LEMON provides several heap classes. They are efficient implementations
   260 of the abstract data type \e priority \e queue. They store items with
   261 specified values called \e priorities in such a way that finding and
   262 removing the item with minimum priority are efficient.
   263 The basic operations are adding and erasing items, changing the priority
   264 of an item, etc.
   265 
   266 Heaps are crucial in several algorithms, such as Dijkstra and Prim.
   267 The heap implementations have the same interface, thus any of them can be
   268 used easily in such algorithms.
   269 
   270 \sa \ref concepts::Heap "Heap concept"
   271 */
   272 
   273 /**
   274 @defgroup auxdat Auxiliary Data Structures
   275 @ingroup datas
   276 \brief Auxiliary data structures implemented in LEMON.
   277 
   278 This group contains some data structures implemented in LEMON in
   279 order to make it easier to implement combinatorial algorithms.
   280 */
   281 
   282 /**
   283 @defgroup geomdat Geometric Data Structures
   284 @ingroup auxdat
   285 \brief Geometric data structures implemented in LEMON.
   286 
   287 This group contains geometric data structures implemented in LEMON.
   288 
   289  - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
   290    vector with the usual operations.
   291  - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
   292    rectangular bounding box of a set of \ref lemon::dim2::Point
   293    "dim2::Point"'s.
   294 */
   295 
   296 /**
   297 @defgroup algs Algorithms
   298 \brief This group contains the several algorithms
   299 implemented in LEMON.
   300 
   301 This group contains the several algorithms
   302 implemented in LEMON.
   303 */
   304 
   305 /**
   306 @defgroup search Graph Search
   307 @ingroup algs
   308 \brief Common graph search algorithms.
   309 
   310 This group contains the common graph search algorithms, namely
   311 \e breadth-first \e search (BFS) and \e depth-first \e search (DFS)
   312 \cite clrs01algorithms.
   313 */
   314 
   315 /**
   316 @defgroup shortest_path Shortest Path Algorithms
   317 @ingroup algs
   318 \brief Algorithms for finding shortest paths.
   319 
   320 This group contains the algorithms for finding shortest paths in digraphs
   321 \cite clrs01algorithms.
   322 
   323  - \ref Dijkstra algorithm for finding shortest paths from a source node
   324    when all arc lengths are non-negative.
   325  - \ref BellmanFord "Bellman-Ford" algorithm for finding shortest paths
   326    from a source node when arc lenghts can be either positive or negative,
   327    but the digraph should not contain directed cycles with negative total
   328    length.
   329  - \ref Suurballe A successive shortest path algorithm for finding
   330    arc-disjoint paths between two nodes having minimum total length.
   331 */
   332 
   333 /**
   334 @defgroup spantree Minimum Spanning Tree Algorithms
   335 @ingroup algs
   336 \brief Algorithms for finding minimum cost spanning trees and arborescences.
   337 
   338 This group contains the algorithms for finding minimum cost spanning
   339 trees and arborescences \cite clrs01algorithms.
   340 */
   341 
   342 /**
   343 @defgroup max_flow Maximum Flow Algorithms
   344 @ingroup algs
   345 \brief Algorithms for finding maximum flows.
   346 
   347 This group contains the algorithms for finding maximum flows and
   348 feasible circulations \cite clrs01algorithms, \cite amo93networkflows.
   349 
   350 The \e maximum \e flow \e problem is to find a flow of maximum value between
   351 a single source and a single target. Formally, there is a \f$G=(V,A)\f$
   352 digraph, a \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function and
   353 \f$s, t \in V\f$ source and target nodes.
   354 A maximum flow is an \f$f: A\rightarrow\mathbf{R}^+_0\f$ solution of the
   355 following optimization problem.
   356 
   357 \f[ \max\sum_{sv\in A} f(sv) - \sum_{vs\in A} f(vs) \f]
   358 \f[ \sum_{uv\in A} f(uv) = \sum_{vu\in A} f(vu)
   359     \quad \forall u\in V\setminus\{s,t\} \f]
   360 \f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f]
   361 
   362 \ref Preflow is an efficient implementation of Goldberg-Tarjan's
   363 preflow push-relabel algorithm \cite goldberg88newapproach for finding
   364 maximum flows. It also provides functions to query the minimum cut,
   365 which is the dual problem of maximum flow.
   366 
   367 \ref Circulation is a preflow push-relabel algorithm implemented directly
   368 for finding feasible circulations, which is a somewhat different problem,
   369 but it is strongly related to maximum flow.
   370 For more information, see \ref Circulation.
   371 */
   372 
   373 /**
   374 @defgroup min_cost_flow_algs Minimum Cost Flow Algorithms
   375 @ingroup algs
   376 
   377 \brief Algorithms for finding minimum cost flows and circulations.
   378 
   379 This group contains the algorithms for finding minimum cost flows and
   380 circulations \cite amo93networkflows. For more information about this
   381 problem and its dual solution, see: \ref min_cost_flow
   382 "Minimum Cost Flow Problem".
   383 
   384 LEMON contains several algorithms for this problem.
   385  - \ref NetworkSimplex Primal Network Simplex algorithm with various
   386    pivot strategies \cite dantzig63linearprog, \cite kellyoneill91netsimplex.
   387  - \ref CostScaling Cost Scaling algorithm based on push/augment and
   388    relabel operations \cite goldberg90approximation, \cite goldberg97efficient,
   389    \cite bunnagel98efficient.
   390  - \ref CapacityScaling Capacity Scaling algorithm based on the successive
   391    shortest path method \cite edmondskarp72theoretical.
   392  - \ref CycleCanceling Cycle-Canceling algorithms, two of which are
   393    strongly polynomial \cite klein67primal, \cite goldberg89cyclecanceling.
   394 
   395 In general, \ref NetworkSimplex and \ref CostScaling are the most efficient
   396 implementations.
   397 \ref NetworkSimplex is usually the fastest on relatively small graphs (up to
   398 several thousands of nodes) and on dense graphs, while \ref CostScaling is
   399 typically more efficient on large graphs (e.g. hundreds of thousands of
   400 nodes or above), especially if they are sparse.
   401 However, other algorithms could be faster in special cases.
   402 For example, if the total supply and/or capacities are rather small,
   403 \ref CapacityScaling is usually the fastest algorithm
   404 (without effective scaling).
   405 
   406 These classes are intended to be used with integer-valued input data
   407 (capacities, supply values, and costs), except for \ref CapacityScaling,
   408 which is capable of handling real-valued arc costs (other numerical
   409 data are required to be integer).
   410 
   411 For more details about these implementations and for a comprehensive
   412 experimental study, see the paper \cite KiralyKovacs12MCF.
   413 It also compares these codes to other publicly available
   414 minimum cost flow solvers.
   415 */
   416 
   417 /**
   418 @defgroup min_cut Minimum Cut Algorithms
   419 @ingroup algs
   420 
   421 \brief Algorithms for finding minimum cut in graphs.
   422 
   423 This group contains the algorithms for finding minimum cut in graphs.
   424 
   425 The \e minimum \e cut \e problem is to find a non-empty and non-complete
   426 \f$X\f$ subset of the nodes with minimum overall capacity on
   427 outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a
   428 \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
   429 cut is the \f$X\f$ solution of the next optimization problem:
   430 
   431 \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
   432     \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]
   433 
   434 LEMON contains several algorithms related to minimum cut problems:
   435 
   436 - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
   437   in directed graphs.
   438 - \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
   439   calculating minimum cut in undirected graphs.
   440 - \ref GomoryHu "Gomory-Hu tree computation" for calculating
   441   all-pairs minimum cut in undirected graphs.
   442 
   443 If you want to find minimum cut just between two distinict nodes,
   444 see the \ref max_flow "maximum flow problem".
   445 */
   446 
   447 /**
   448 @defgroup min_mean_cycle Minimum Mean Cycle Algorithms
   449 @ingroup algs
   450 \brief Algorithms for finding minimum mean cycles.
   451 
   452 This group contains the algorithms for finding minimum mean cycles
   453 \cite amo93networkflows, \cite karp78characterization.
   454 
   455 The \e minimum \e mean \e cycle \e problem is to find a directed cycle
   456 of minimum mean length (cost) in a digraph.
   457 The mean length of a cycle is the average length of its arcs, i.e. the
   458 ratio between the total length of the cycle and the number of arcs on it.
   459 
   460 This problem has an important connection to \e conservative \e length
   461 \e functions, too. A length function on the arcs of a digraph is called
   462 conservative if and only if there is no directed cycle of negative total
   463 length. For an arbitrary length function, the negative of the minimum
   464 cycle mean is the smallest \f$\epsilon\f$ value so that increasing the
   465 arc lengths uniformly by \f$\epsilon\f$ results in a conservative length
   466 function.
   467 
   468 LEMON contains three algorithms for solving the minimum mean cycle problem:
   469 - \ref KarpMmc Karp's original algorithm \cite karp78characterization.
   470 - \ref HartmannOrlinMmc Hartmann-Orlin's algorithm, which is an improved
   471   version of Karp's algorithm \cite hartmann93finding.
   472 - \ref HowardMmc Howard's policy iteration algorithm
   473   \cite dasdan98minmeancycle, \cite dasdan04experimental.
   474 
   475 In practice, the \ref HowardMmc "Howard" algorithm turned out to be by far the
   476 most efficient one, though the best known theoretical bound on its running
   477 time is exponential.
   478 Both \ref KarpMmc "Karp" and \ref HartmannOrlinMmc "Hartmann-Orlin" algorithms
   479 run in time O(nm) and use space O(n<sup>2</sup>+m).
   480 */
   481 
   482 /**
   483 @defgroup matching Matching Algorithms
   484 @ingroup algs
   485 \brief Algorithms for finding matchings in graphs and bipartite graphs.
   486 
   487 This group contains the algorithms for calculating
   488 matchings in graphs and bipartite graphs. The general matching problem is
   489 finding a subset of the edges for which each node has at most one incident
   490 edge.
   491 
   492 There are several different algorithms for calculate matchings in
   493 graphs.  The matching problems in bipartite graphs are generally
   494 easier than in general graphs. The goal of the matching optimization
   495 can be finding maximum cardinality, maximum weight or minimum cost
   496 matching. The search can be constrained to find perfect or
   497 maximum cardinality matching.
   498 
   499 The matching algorithms implemented in LEMON:
   500 - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating
   501   maximum cardinality matching in general graphs.
   502 - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating
   503   maximum weighted matching in general graphs.
   504 - \ref MaxWeightedPerfectMatching
   505   Edmond's blossom shrinking algorithm for calculating maximum weighted
   506   perfect matching in general graphs.
   507 - \ref MaxFractionalMatching Push-relabel algorithm for calculating
   508   maximum cardinality fractional matching in general graphs.
   509 - \ref MaxWeightedFractionalMatching Augmenting path algorithm for calculating
   510   maximum weighted fractional matching in general graphs.
   511 - \ref MaxWeightedPerfectFractionalMatching
   512   Augmenting path algorithm for calculating maximum weighted
   513   perfect fractional matching in general graphs.
   514 
   515 \image html matching.png
   516 \image latex matching.eps "Min Cost Perfect Matching" width=\textwidth
   517 */
   518 
   519 /**
   520 @defgroup graph_properties Connectivity and Other Graph Properties
   521 @ingroup algs
   522 \brief Algorithms for discovering the graph properties
   523 
   524 This group contains the algorithms for discovering the graph properties
   525 like connectivity, bipartiteness, euler property, simplicity etc.
   526 
   527 \image html connected_components.png
   528 \image latex connected_components.eps "Connected components" width=\textwidth
   529 */
   530 
   531 /**
   532 @defgroup planar Planar Embedding and Drawing
   533 @ingroup algs
   534 \brief Algorithms for planarity checking, embedding and drawing
   535 
   536 This group contains the algorithms for planarity checking,
   537 embedding and drawing.
   538 
   539 \image html planar.png
   540 \image latex planar.eps "Plane graph" width=\textwidth
   541 */
   542 
   543 /**
   544 @defgroup tsp Traveling Salesman Problem
   545 @ingroup algs
   546 \brief Algorithms for the symmetric traveling salesman problem
   547 
   548 This group contains basic heuristic algorithms for the the symmetric
   549 \e traveling \e salesman \e problem (TSP).
   550 Given an \ref FullGraph "undirected full graph" with a cost map on its edges,
   551 the problem is to find a shortest possible tour that visits each node exactly
   552 once (i.e. the minimum cost Hamiltonian cycle).
   553 
   554 These TSP algorithms are intended to be used with a \e metric \e cost
   555 \e function, i.e. the edge costs should satisfy the triangle inequality.
   556 Otherwise the algorithms could yield worse results.
   557 
   558 LEMON provides five well-known heuristics for solving symmetric TSP:
   559  - \ref NearestNeighborTsp Neareast neighbor algorithm
   560  - \ref GreedyTsp Greedy algorithm
   561  - \ref InsertionTsp Insertion heuristic (with four selection methods)
   562  - \ref ChristofidesTsp Christofides algorithm
   563  - \ref Opt2Tsp 2-opt algorithm
   564 
   565 \ref NearestNeighborTsp, \ref GreedyTsp, and \ref InsertionTsp are the fastest
   566 solution methods. Furthermore, \ref InsertionTsp is usually quite effective.
   567 
   568 \ref ChristofidesTsp is somewhat slower, but it has the best guaranteed
   569 approximation factor: 3/2.
   570 
   571 \ref Opt2Tsp usually provides the best results in practice, but
   572 it is the slowest method. It can also be used to improve given tours,
   573 for example, the results of other algorithms.
   574 
   575 \image html tsp.png
   576 \image latex tsp.eps "Traveling salesman problem" width=\textwidth
   577 */
   578 
   579 /**
   580 @defgroup approx_algs Approximation Algorithms
   581 @ingroup algs
   582 \brief Approximation algorithms.
   583 
   584 This group contains the approximation and heuristic algorithms
   585 implemented in LEMON.
   586 
   587 <b>Maximum Clique Problem</b>
   588   - \ref GrossoLocatelliPullanMc An efficient heuristic algorithm of
   589     Grosso, Locatelli, and Pullan.
   590 */
   591 
   592 /**
   593 @defgroup auxalg Auxiliary Algorithms
   594 @ingroup algs
   595 \brief Auxiliary algorithms implemented in LEMON.
   596 
   597 This group contains some algorithms implemented in LEMON
   598 in order to make it easier to implement complex algorithms.
   599 */
   600 
   601 /**
   602 @defgroup gen_opt_group General Optimization Tools
   603 \brief This group contains some general optimization frameworks
   604 implemented in LEMON.
   605 
   606 This group contains some general optimization frameworks
   607 implemented in LEMON.
   608 */
   609 
   610 /**
   611 @defgroup lp_group LP and MIP Solvers
   612 @ingroup gen_opt_group
   613 \brief LP and MIP solver interfaces for LEMON.
   614 
   615 This group contains LP and MIP solver interfaces for LEMON.
   616 Various LP solvers could be used in the same manner with this
   617 high-level interface.
   618 
   619 The currently supported solvers are \cite glpk, \cite clp, \cite cbc,
   620 \cite cplex, \cite soplex.
   621 */
   622 
   623 /**
   624 @defgroup utils Tools and Utilities
   625 \brief Tools and utilities for programming in LEMON
   626 
   627 Tools and utilities for programming in LEMON.
   628 */
   629 
   630 /**
   631 @defgroup gutils Basic Graph Utilities
   632 @ingroup utils
   633 \brief Simple basic graph utilities.
   634 
   635 This group contains some simple basic graph utilities.
   636 */
   637 
   638 /**
   639 @defgroup misc Miscellaneous Tools
   640 @ingroup utils
   641 \brief Tools for development, debugging and testing.
   642 
   643 This group contains several useful tools for development,
   644 debugging and testing.
   645 */
   646 
   647 /**
   648 @defgroup timecount Time Measuring and Counting
   649 @ingroup misc
   650 \brief Simple tools for measuring the performance of algorithms.
   651 
   652 This group contains simple tools for measuring the performance
   653 of algorithms.
   654 */
   655 
   656 /**
   657 @defgroup exceptions Exceptions
   658 @ingroup utils
   659 \brief Exceptions defined in LEMON.
   660 
   661 This group contains the exceptions defined in LEMON.
   662 */
   663 
   664 /**
   665 @defgroup io_group Input-Output
   666 \brief Graph Input-Output methods
   667 
   668 This group contains the tools for importing and exporting graphs
   669 and graph related data. Now it supports the \ref lgf-format
   670 "LEMON Graph Format", the \c DIMACS format and the encapsulated
   671 postscript (EPS) format.
   672 */
   673 
   674 /**
   675 @defgroup lemon_io LEMON Graph Format
   676 @ingroup io_group
   677 \brief Reading and writing LEMON Graph Format.
   678 
   679 This group contains methods for reading and writing
   680 \ref lgf-format "LEMON Graph Format".
   681 */
   682 
   683 /**
   684 @defgroup eps_io Postscript Exporting
   685 @ingroup io_group
   686 \brief General \c EPS drawer and graph exporter
   687 
   688 This group contains general \c EPS drawing methods and special
   689 graph exporting tools.
   690 
   691 \image html graph_to_eps.png
   692 */
   693 
   694 /**
   695 @defgroup dimacs_group DIMACS Format
   696 @ingroup io_group
   697 \brief Read and write files in DIMACS format
   698 
   699 Tools to read a digraph from or write it to a file in DIMACS format data.
   700 */
   701 
   702 /**
   703 @defgroup nauty_group NAUTY Format
   704 @ingroup io_group
   705 \brief Read \e Nauty format
   706 
   707 Tool to read graphs from \e Nauty format data.
   708 */
   709 
   710 /**
   711 @defgroup concept Concepts
   712 \brief Skeleton classes and concept checking classes
   713 
   714 This group contains the data/algorithm skeletons and concept checking
   715 classes implemented in LEMON.
   716 
   717 The purpose of the classes in this group is fourfold.
   718 
   719 - These classes contain the documentations of the %concepts. In order
   720   to avoid document multiplications, an implementation of a concept
   721   simply refers to the corresponding concept class.
   722 
   723 - These classes declare every functions, <tt>typedef</tt>s etc. an
   724   implementation of the %concepts should provide, however completely
   725   without implementations and real data structures behind the
   726   interface. On the other hand they should provide nothing else. All
   727   the algorithms working on a data structure meeting a certain concept
   728   should compile with these classes. (Though it will not run properly,
   729   of course.) In this way it is easily to check if an algorithm
   730   doesn't use any extra feature of a certain implementation.
   731 
   732 - The concept descriptor classes also provide a <em>checker class</em>
   733   that makes it possible to check whether a certain implementation of a
   734   concept indeed provides all the required features.
   735 
   736 - Finally, They can serve as a skeleton of a new implementation of a concept.
   737 */
   738 
   739 /**
   740 @defgroup graph_concepts Graph Structure Concepts
   741 @ingroup concept
   742 \brief Skeleton and concept checking classes for graph structures
   743 
   744 This group contains the skeletons and concept checking classes of
   745 graph structures.
   746 */
   747 
   748 /**
   749 @defgroup map_concepts Map Concepts
   750 @ingroup concept
   751 \brief Skeleton and concept checking classes for maps
   752 
   753 This group contains the skeletons and concept checking classes of maps.
   754 */
   755 
   756 /**
   757 @defgroup tools Standalone Utility Applications
   758 
   759 Some utility applications are listed here.
   760 
   761 The standard compilation procedure (<tt>./configure;make</tt>) will compile
   762 them, as well.
   763 */
   764 
   765 /**
   766 \anchor demoprograms
   767 
   768 @defgroup demos Demo Programs
   769 
   770 Some demo programs are listed here. Their full source codes can be found in
   771 the \c demo subdirectory of the source tree.
   772 
   773 In order to compile them, use the <tt>make demo</tt> or the
   774 <tt>make check</tt> commands.
   775 */
   776 
   777 }