doc/groups.dox
author Alpar Juttner <alpar@cs.elte.hu>
Fri, 21 Mar 2008 22:25:40 +0000
changeset 107 31a2e6d28f61
parent 71 9df0fe5e5109
child 156 e561aa7675de
permissions -rw-r--r--
Happy New Year! (Update Copyright dates)
alpar@40
     1
/* -*- C++ -*-
alpar@40
     2
 *
alpar@40
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@40
     4
 *
alpar@40
     5
 * Copyright (C) 2003-2008
alpar@40
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@40
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@40
     8
 *
alpar@40
     9
 * Permission to use, modify and distribute this software is granted
alpar@40
    10
 * provided that this copyright notice appears in all copies. For
alpar@40
    11
 * precise terms see the accompanying LICENSE file.
alpar@40
    12
 *
alpar@40
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@40
    14
 * express or implied, and with no claim as to its suitability for any
alpar@40
    15
 * purpose.
alpar@40
    16
 *
alpar@40
    17
 */
alpar@40
    18
alpar@40
    19
/**
alpar@40
    20
@defgroup datas Data Structures
kpeter@50
    21
This group describes the several data structures implemented in LEMON.
alpar@40
    22
*/
alpar@40
    23
alpar@40
    24
/**
alpar@40
    25
@defgroup graphs Graph Structures
alpar@40
    26
@ingroup datas
alpar@40
    27
\brief Graph structures implemented in LEMON.
alpar@40
    28
alpar@40
    29
The implementation of combinatorial algorithms heavily relies on 
alpar@40
    30
efficient graph implementations. LEMON offers data structures which are 
alpar@40
    31
planned to be easily used in an experimental phase of implementation studies, 
alpar@40
    32
and thereafter the program code can be made efficient by small modifications. 
alpar@40
    33
alpar@40
    34
The most efficient implementation of diverse applications require the
alpar@40
    35
usage of different physical graph implementations. These differences
alpar@40
    36
appear in the size of graph we require to handle, memory or time usage
alpar@40
    37
limitations or in the set of operations through which the graph can be
alpar@40
    38
accessed.  LEMON provides several physical graph structures to meet
alpar@40
    39
the diverging requirements of the possible users.  In order to save on
alpar@40
    40
running time or on memory usage, some structures may fail to provide
kpeter@83
    41
some graph features like arc/edge or node deletion.
alpar@40
    42
alpar@40
    43
Alteration of standard containers need a very limited number of 
alpar@40
    44
operations, these together satisfy the everyday requirements. 
alpar@40
    45
In the case of graph structures, different operations are needed which do 
alpar@40
    46
not alter the physical graph, but gives another view. If some nodes or 
kpeter@83
    47
arcs have to be hidden or the reverse oriented graph have to be used, then
alpar@40
    48
this is the case. It also may happen that in a flow implementation 
alpar@40
    49
the residual graph can be accessed by another algorithm, or a node-set 
alpar@40
    50
is to be shrunk for another algorithm. 
alpar@40
    51
LEMON also provides a variety of graphs for these requirements called 
alpar@40
    52
\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only 
kpeter@50
    53
in conjunction with other graph representations. 
alpar@40
    54
alpar@40
    55
You are free to use the graph structure that fit your requirements
alpar@40
    56
the best, most graph algorithms and auxiliary data structures can be used
alpar@40
    57
with any graph structures. 
alpar@40
    58
*/
alpar@40
    59
alpar@40
    60
/**
kpeter@50
    61
@defgroup semi_adaptors Semi-Adaptor Classes for Graphs
alpar@40
    62
@ingroup graphs
alpar@40
    63
\brief Graph types between real graphs and graph adaptors.
alpar@40
    64
kpeter@50
    65
This group describes some graph types between real graphs and graph adaptors.
kpeter@50
    66
These classes wrap graphs to give new functionality as the adaptors do it. 
kpeter@50
    67
On the other hand they are not light-weight structures as the adaptors.
alpar@40
    68
*/
alpar@40
    69
alpar@40
    70
/**
alpar@40
    71
@defgroup maps Maps 
alpar@40
    72
@ingroup datas
kpeter@50
    73
\brief Map structures implemented in LEMON.
alpar@40
    74
kpeter@50
    75
This group describes the map structures implemented in LEMON.
kpeter@50
    76
kpeter@50
    77
LEMON provides several special purpose maps that e.g. combine
alpar@40
    78
new maps from existing ones.
alpar@40
    79
*/
alpar@40
    80
alpar@40
    81
/**
alpar@40
    82
@defgroup graph_maps Graph Maps 
alpar@40
    83
@ingroup maps
kpeter@83
    84
\brief Special graph-related maps.
alpar@40
    85
kpeter@50
    86
This group describes maps that are specifically designed to assign
kpeter@83
    87
values to the nodes and arcs of graphs.
alpar@40
    88
*/
alpar@40
    89
alpar@40
    90
alpar@40
    91
/**
alpar@40
    92
\defgroup map_adaptors Map Adaptors
alpar@40
    93
\ingroup maps
alpar@40
    94
\brief Tools to create new maps from existing ones
alpar@40
    95
kpeter@50
    96
This group describes map adaptors that are used to create "implicit"
kpeter@50
    97
maps from other maps.
alpar@40
    98
kpeter@83
    99
Most of them are \ref lemon::concepts::ReadMap "read-only maps".
kpeter@83
   100
They can make arithmetic and logical operations between one or two maps
kpeter@83
   101
(negation, shifting, addition, multiplication, logical 'and', 'or',
kpeter@83
   102
'not' etc.) or e.g. convert a map to another one of different Value type.
alpar@40
   103
kpeter@50
   104
The typical usage of this classes is passing implicit maps to
alpar@40
   105
algorithms.  If a function type algorithm is called then the function
alpar@40
   106
type map adaptors can be used comfortable. For example let's see the
kpeter@83
   107
usage of map adaptors with the \c digraphToEps() function.
alpar@40
   108
\code
alpar@40
   109
  Color nodeColor(int deg) {
alpar@40
   110
    if (deg >= 2) {
alpar@40
   111
      return Color(0.5, 0.0, 0.5);
alpar@40
   112
    } else if (deg == 1) {
alpar@40
   113
      return Color(1.0, 0.5, 1.0);
alpar@40
   114
    } else {
alpar@40
   115
      return Color(0.0, 0.0, 0.0);
alpar@40
   116
    }
alpar@40
   117
  }
alpar@40
   118
  
kpeter@83
   119
  Digraph::NodeMap<int> degree_map(graph);
alpar@40
   120
  
kpeter@83
   121
  digraphToEps(graph, "graph.eps")
alpar@40
   122
    .coords(coords).scaleToA4().undirected()
kpeter@83
   123
    .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
alpar@40
   124
    .run();
alpar@40
   125
\endcode 
kpeter@83
   126
The \c functorToMap() function makes an \c int to \c Color map from the
alpar@40
   127
\e nodeColor() function. The \c composeMap() compose the \e degree_map
kpeter@83
   128
and the previously created map. The composed map is a proper function to
kpeter@83
   129
get the color of each node.
alpar@40
   130
alpar@40
   131
The usage with class type algorithms is little bit harder. In this
alpar@40
   132
case the function type map adaptors can not be used, because the
kpeter@50
   133
function map adaptors give back temporary objects.
alpar@40
   134
\code
kpeter@83
   135
  Digraph graph;
kpeter@83
   136
kpeter@83
   137
  typedef Digraph::ArcMap<double> DoubleArcMap;
kpeter@83
   138
  DoubleArcMap length(graph);
kpeter@83
   139
  DoubleArcMap speed(graph);
kpeter@83
   140
kpeter@83
   141
  typedef DivMap<DoubleArcMap, DoubleArcMap> TimeMap;
alpar@40
   142
  TimeMap time(length, speed);
alpar@40
   143
  
kpeter@83
   144
  Dijkstra<Digraph, TimeMap> dijkstra(graph, time);
alpar@40
   145
  dijkstra.run(source, target);
alpar@40
   146
\endcode
kpeter@83
   147
We have a length map and a maximum speed map on the arcs of a digraph.
kpeter@83
   148
The minimum time to pass the arc can be calculated as the division of
kpeter@83
   149
the two maps which can be done implicitly with the \c DivMap template
alpar@40
   150
class. We use the implicit minimum time map as the length map of the
alpar@40
   151
\c Dijkstra algorithm.
alpar@40
   152
*/
alpar@40
   153
alpar@40
   154
/**
alpar@40
   155
@defgroup matrices Matrices 
alpar@40
   156
@ingroup datas
kpeter@50
   157
\brief Two dimensional data storages implemented in LEMON.
alpar@40
   158
kpeter@50
   159
This group describes two dimensional data storages implemented in LEMON.
alpar@40
   160
*/
alpar@40
   161
alpar@40
   162
/**
alpar@40
   163
@defgroup paths Path Structures
alpar@40
   164
@ingroup datas
alpar@40
   165
\brief Path structures implemented in LEMON.
alpar@40
   166
kpeter@50
   167
This group describes the path structures implemented in LEMON.
alpar@40
   168
kpeter@50
   169
LEMON provides flexible data structures to work with paths.
kpeter@50
   170
All of them have similar interfaces and they can be copied easily with
kpeter@50
   171
assignment operators and copy constructors. This makes it easy and
alpar@40
   172
efficient to have e.g. the Dijkstra algorithm to store its result in
alpar@40
   173
any kind of path structure.
alpar@40
   174
alpar@40
   175
\sa lemon::concepts::Path
alpar@40
   176
alpar@40
   177
*/
alpar@40
   178
alpar@40
   179
/**
alpar@40
   180
@defgroup auxdat Auxiliary Data Structures
alpar@40
   181
@ingroup datas
kpeter@50
   182
\brief Auxiliary data structures implemented in LEMON.
alpar@40
   183
kpeter@50
   184
This group describes some data structures implemented in LEMON in
alpar@40
   185
order to make it easier to implement combinatorial algorithms.
alpar@40
   186
*/
alpar@40
   187
alpar@40
   188
alpar@40
   189
/**
alpar@40
   190
@defgroup algs Algorithms
alpar@40
   191
\brief This group describes the several algorithms
alpar@40
   192
implemented in LEMON.
alpar@40
   193
alpar@40
   194
This group describes the several algorithms
alpar@40
   195
implemented in LEMON.
alpar@40
   196
*/
alpar@40
   197
alpar@40
   198
/**
alpar@40
   199
@defgroup search Graph Search
alpar@40
   200
@ingroup algs
kpeter@50
   201
\brief Common graph search algorithms.
alpar@40
   202
kpeter@50
   203
This group describes the common graph search algorithms like 
kpeter@50
   204
Breadth-first search (Bfs) and Depth-first search (Dfs).
alpar@40
   205
*/
alpar@40
   206
alpar@40
   207
/**
alpar@40
   208
@defgroup shortest_path Shortest Path algorithms
alpar@40
   209
@ingroup algs
kpeter@50
   210
\brief Algorithms for finding shortest paths.
alpar@40
   211
kpeter@50
   212
This group describes the algorithms for finding shortest paths in graphs.
alpar@40
   213
*/
alpar@40
   214
alpar@40
   215
/** 
alpar@40
   216
@defgroup max_flow Maximum Flow algorithms 
alpar@40
   217
@ingroup algs 
kpeter@50
   218
\brief Algorithms for finding maximum flows.
alpar@40
   219
alpar@40
   220
This group describes the algorithms for finding maximum flows and
alpar@40
   221
feasible circulations.
alpar@40
   222
kpeter@50
   223
The maximum flow problem is to find a flow between a single source and
kpeter@50
   224
a single target that is maximum. Formally, there is a \f$G=(V,A)\f$
alpar@40
   225
directed graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity
alpar@40
   226
function and given \f$s, t \in V\f$ source and target node. The
kpeter@50
   227
maximum flow is the \f$f_a\f$ solution of the next optimization problem:
alpar@40
   228
alpar@40
   229
\f[ 0 \le f_a \le c_a \f]
kpeter@50
   230
\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \qquad \forall u \in V \setminus \{s,t\}\f]
alpar@40
   231
\f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]
alpar@40
   232
kpeter@50
   233
LEMON contains several algorithms for solving maximum flow problems:
alpar@40
   234
- \ref lemon::EdmondsKarp "Edmonds-Karp" 
alpar@40
   235
- \ref lemon::Preflow "Goldberg's Preflow algorithm"
kpeter@50
   236
- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"
alpar@40
   237
- \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees"
alpar@40
   238
kpeter@50
   239
In most cases the \ref lemon::Preflow "Preflow" algorithm provides the
alpar@40
   240
fastest method to compute the maximum flow. All impelementations
kpeter@50
   241
provides functions to query the minimum cut, which is the dual linear
kpeter@50
   242
programming problem of the maximum flow.
alpar@40
   243
alpar@40
   244
*/
alpar@40
   245
alpar@40
   246
/**
alpar@40
   247
@defgroup min_cost_flow Minimum Cost Flow algorithms
alpar@40
   248
@ingroup algs
alpar@40
   249
kpeter@50
   250
\brief Algorithms for finding minimum cost flows and circulations.
alpar@40
   251
alpar@40
   252
This group describes the algorithms for finding minimum cost flows and
alpar@40
   253
circulations.  
alpar@40
   254
*/
alpar@40
   255
alpar@40
   256
/**
alpar@40
   257
@defgroup min_cut Minimum Cut algorithms 
alpar@40
   258
@ingroup algs 
alpar@40
   259
kpeter@50
   260
\brief Algorithms for finding minimum cut in graphs.
alpar@40
   261
alpar@40
   262
This group describes the algorithms for finding minimum cut in graphs.
alpar@40
   263
alpar@40
   264
The minimum cut problem is to find a non-empty and non-complete
alpar@40
   265
\f$X\f$ subset of the vertices with minimum overall capacity on
alpar@40
   266
outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an
alpar@40
   267
\f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
kpeter@50
   268
cut is the \f$X\f$ solution of the next optimization problem:
alpar@40
   269
alpar@40
   270
\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}\sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]
alpar@40
   271
kpeter@50
   272
LEMON contains several algorithms related to minimum cut problems:
alpar@40
   273
kpeter@50
   274
- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut
alpar@40
   275
  in directed graphs  
kpeter@50
   276
- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to
alpar@40
   277
  calculate minimum cut in undirected graphs
kpeter@50
   278
- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all
alpar@40
   279
  pairs minimum cut in undirected graphs
alpar@40
   280
alpar@40
   281
If you want to find minimum cut just between two distinict nodes,
alpar@40
   282
please see the \ref max_flow "Maximum Flow page".
alpar@40
   283
alpar@40
   284
*/
alpar@40
   285
alpar@40
   286
/**
alpar@40
   287
@defgroup graph_prop Connectivity and other graph properties
alpar@40
   288
@ingroup algs
kpeter@50
   289
\brief Algorithms for discovering the graph properties
alpar@40
   290
kpeter@50
   291
This group describes the algorithms for discovering the graph properties
kpeter@50
   292
like connectivity, bipartiteness, euler property, simplicity etc.
alpar@40
   293
alpar@40
   294
\image html edge_biconnected_components.png
alpar@40
   295
\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
alpar@40
   296
*/
alpar@40
   297
alpar@40
   298
/**
alpar@40
   299
@defgroup planar Planarity embedding and drawing
alpar@40
   300
@ingroup algs
kpeter@50
   301
\brief Algorithms for planarity checking, embedding and drawing
alpar@40
   302
kpeter@50
   303
This group describes the algorithms for planarity checking, embedding and drawing.
alpar@40
   304
alpar@40
   305
\image html planar.png
alpar@40
   306
\image latex planar.eps "Plane graph" width=\textwidth
alpar@40
   307
*/
alpar@40
   308
alpar@40
   309
/**
alpar@40
   310
@defgroup matching Matching algorithms 
alpar@40
   311
@ingroup algs
kpeter@50
   312
\brief Algorithms for finding matchings in graphs and bipartite graphs.
alpar@40
   313
kpeter@50
   314
This group contains algorithm objects and functions to calculate
alpar@40
   315
matchings in graphs and bipartite graphs. The general matching problem is
kpeter@83
   316
finding a subset of the arcs which does not shares common endpoints.
alpar@40
   317
 
alpar@40
   318
There are several different algorithms for calculate matchings in
alpar@40
   319
graphs.  The matching problems in bipartite graphs are generally
alpar@40
   320
easier than in general graphs. The goal of the matching optimization
alpar@40
   321
can be the finding maximum cardinality, maximum weight or minimum cost
alpar@40
   322
matching. The search can be constrained to find perfect or
alpar@40
   323
maximum cardinality matching.
alpar@40
   324
alpar@40
   325
Lemon contains the next algorithms:
alpar@40
   326
- \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp 
alpar@40
   327
  augmenting path algorithm for calculate maximum cardinality matching in 
alpar@40
   328
  bipartite graphs
alpar@40
   329
- \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel 
alpar@40
   330
  algorithm for calculate maximum cardinality matching in bipartite graphs 
alpar@40
   331
- \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching" 
alpar@40
   332
  Successive shortest path algorithm for calculate maximum weighted matching 
alpar@40
   333
  and maximum weighted bipartite matching in bipartite graph
alpar@40
   334
- \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching" 
alpar@40
   335
  Successive shortest path algorithm for calculate minimum cost maximum 
alpar@40
   336
  matching in bipartite graph
alpar@40
   337
- \ref lemon::MaxMatching "MaxMatching" Edmond's blossom shrinking algorithm
alpar@40
   338
  for calculate maximum cardinality matching in general graph
alpar@40
   339
- \ref lemon::MaxWeightedMatching "MaxWeightedMatching" Edmond's blossom
alpar@40
   340
  shrinking algorithm for calculate maximum weighted matching in general
alpar@40
   341
  graph
alpar@40
   342
- \ref lemon::MaxWeightedPerfectMatching "MaxWeightedPerfectMatching"
alpar@40
   343
  Edmond's blossom shrinking algorithm for calculate maximum weighted
alpar@40
   344
  perfect matching in general graph
alpar@40
   345
alpar@40
   346
\image html bipartite_matching.png
alpar@40
   347
\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
alpar@40
   348
alpar@40
   349
*/
alpar@40
   350
alpar@40
   351
/**
alpar@40
   352
@defgroup spantree Minimum Spanning Tree algorithms
alpar@40
   353
@ingroup algs
kpeter@50
   354
\brief Algorithms for finding a minimum cost spanning tree in a graph.
alpar@40
   355
kpeter@50
   356
This group describes the algorithms for finding a minimum cost spanning
alpar@40
   357
tree in a graph
alpar@40
   358
*/
alpar@40
   359
alpar@40
   360
alpar@40
   361
/**
alpar@40
   362
@defgroup auxalg Auxiliary algorithms
alpar@40
   363
@ingroup algs
kpeter@50
   364
\brief Auxiliary algorithms implemented in LEMON.
alpar@40
   365
kpeter@50
   366
This group describes some algorithms implemented in LEMON
kpeter@50
   367
in order to make it easier to implement complex algorithms.
alpar@40
   368
*/
alpar@40
   369
alpar@40
   370
/**
alpar@40
   371
@defgroup approx Approximation algorithms
kpeter@50
   372
\brief Approximation algorithms.
alpar@40
   373
kpeter@50
   374
This group describes the approximation and heuristic algorithms
kpeter@50
   375
implemented in LEMON.
alpar@40
   376
*/
alpar@40
   377
alpar@40
   378
/**
alpar@40
   379
@defgroup gen_opt_group General Optimization Tools
alpar@40
   380
\brief This group describes some general optimization frameworks
alpar@40
   381
implemented in LEMON.
alpar@40
   382
alpar@40
   383
This group describes some general optimization frameworks
alpar@40
   384
implemented in LEMON.
alpar@40
   385
alpar@40
   386
*/
alpar@40
   387
alpar@40
   388
/**
alpar@40
   389
@defgroup lp_group Lp and Mip solvers
alpar@40
   390
@ingroup gen_opt_group
alpar@40
   391
\brief Lp and Mip solver interfaces for LEMON.
alpar@40
   392
alpar@40
   393
This group describes Lp and Mip solver interfaces for LEMON. The
alpar@40
   394
various LP solvers could be used in the same manner with this
alpar@40
   395
interface.
alpar@40
   396
alpar@40
   397
*/
alpar@40
   398
alpar@40
   399
/** 
alpar@40
   400
@defgroup lp_utils Tools for Lp and Mip solvers 
alpar@40
   401
@ingroup lp_group
kpeter@50
   402
\brief Helper tools to the Lp and Mip solvers.
alpar@40
   403
alpar@40
   404
This group adds some helper tools to general optimization framework
alpar@40
   405
implemented in LEMON.
alpar@40
   406
*/
alpar@40
   407
alpar@40
   408
/**
alpar@40
   409
@defgroup metah Metaheuristics
alpar@40
   410
@ingroup gen_opt_group
alpar@40
   411
\brief Metaheuristics for LEMON library.
alpar@40
   412
kpeter@50
   413
This group describes some metaheuristic optimization tools.
alpar@40
   414
*/
alpar@40
   415
alpar@40
   416
/**
alpar@40
   417
@defgroup utils Tools and Utilities 
kpeter@50
   418
\brief Tools and utilities for programming in LEMON
alpar@40
   419
kpeter@50
   420
Tools and utilities for programming in LEMON.
alpar@40
   421
*/
alpar@40
   422
alpar@40
   423
/**
alpar@40
   424
@defgroup gutils Basic Graph Utilities
alpar@40
   425
@ingroup utils
kpeter@50
   426
\brief Simple basic graph utilities.
alpar@40
   427
alpar@40
   428
This group describes some simple basic graph utilities.
alpar@40
   429
*/
alpar@40
   430
alpar@40
   431
/**
alpar@40
   432
@defgroup misc Miscellaneous Tools
alpar@40
   433
@ingroup utils
kpeter@50
   434
\brief Tools for development, debugging and testing.
kpeter@50
   435
kpeter@50
   436
This group describes several useful tools for development,
alpar@40
   437
debugging and testing.
alpar@40
   438
*/
alpar@40
   439
alpar@40
   440
/**
alpar@40
   441
@defgroup timecount Time measuring and Counting
alpar@40
   442
@ingroup misc
kpeter@50
   443
\brief Simple tools for measuring the performance of algorithms.
kpeter@50
   444
kpeter@50
   445
This group describes simple tools for measuring the performance
alpar@40
   446
of algorithms.
alpar@40
   447
*/
alpar@40
   448
alpar@40
   449
/**
alpar@40
   450
@defgroup graphbits Tools for Graph Implementation
alpar@40
   451
@ingroup utils
kpeter@50
   452
\brief Tools to make it easier to create graphs.
alpar@40
   453
kpeter@50
   454
This group describes the tools that makes it easier to create graphs and
alpar@40
   455
the maps that dynamically update with the graph changes.
alpar@40
   456
*/
alpar@40
   457
alpar@40
   458
/**
alpar@40
   459
@defgroup exceptions Exceptions
alpar@40
   460
@ingroup utils
kpeter@50
   461
\brief Exceptions defined in LEMON.
kpeter@50
   462
kpeter@50
   463
This group describes the exceptions defined in LEMON.
alpar@40
   464
*/
alpar@40
   465
alpar@40
   466
/**
alpar@40
   467
@defgroup io_group Input-Output
kpeter@50
   468
\brief Graph Input-Output methods
alpar@40
   469
kpeter@50
   470
This group describes the tools for importing and exporting graphs 
alpar@40
   471
and graph related data. Now it supports the LEMON format, the
kpeter@50
   472
\c DIMACS format and the encapsulated postscript (EPS) format.
alpar@40
   473
*/
alpar@40
   474
alpar@40
   475
/**
alpar@40
   476
@defgroup lemon_io Lemon Input-Output
alpar@40
   477
@ingroup io_group
alpar@40
   478
\brief Reading and writing LEMON format
alpar@40
   479
kpeter@50
   480
This group describes methods for reading and writing LEMON format. 
kpeter@50
   481
You can find more about this format on the \ref graph-io-page "Graph Input-Output"
alpar@40
   482
tutorial pages.
alpar@40
   483
*/
alpar@40
   484
alpar@40
   485
/**
alpar@40
   486
@defgroup section_io Section readers and writers
alpar@40
   487
@ingroup lemon_io
kpeter@71
   488
\brief Section readers and writers for LEMON Input-Output.
alpar@40
   489
kpeter@71
   490
This group describes section reader and writer classes that can be 
kpeter@71
   491
attached to \ref LemonReader and \ref LemonWriter.
alpar@40
   492
*/
alpar@40
   493
alpar@40
   494
/**
kpeter@71
   495
@defgroup item_io Item readers and writers
alpar@40
   496
@ingroup lemon_io
kpeter@71
   497
\brief Item readers and writers for LEMON Input-Output.
alpar@40
   498
kpeter@71
   499
This group describes reader and writer classes for various data types
kpeter@71
   500
(e.g. map or attribute values). These classes can be attached to
kpeter@71
   501
\ref LemonReader and \ref LemonWriter.
alpar@40
   502
*/
alpar@40
   503
alpar@40
   504
/**
alpar@40
   505
@defgroup eps_io Postscript exporting
alpar@40
   506
@ingroup io_group
alpar@40
   507
\brief General \c EPS drawer and graph exporter
alpar@40
   508
kpeter@50
   509
This group describes general \c EPS drawing methods and special
alpar@40
   510
graph exporting tools. 
alpar@40
   511
*/
alpar@40
   512
alpar@40
   513
alpar@40
   514
/**
alpar@40
   515
@defgroup concept Concepts
alpar@40
   516
\brief Skeleton classes and concept checking classes
alpar@40
   517
alpar@40
   518
This group describes the data/algorithm skeletons and concept checking
alpar@40
   519
classes implemented in LEMON.
alpar@40
   520
alpar@40
   521
The purpose of the classes in this group is fourfold.
alpar@40
   522
 
alpar@40
   523
- These classes contain the documentations of the concepts. In order
alpar@40
   524
  to avoid document multiplications, an implementation of a concept
alpar@40
   525
  simply refers to the corresponding concept class.
alpar@40
   526
alpar@40
   527
- These classes declare every functions, <tt>typedef</tt>s etc. an
alpar@40
   528
  implementation of the concepts should provide, however completely
alpar@40
   529
  without implementations and real data structures behind the
alpar@40
   530
  interface. On the other hand they should provide nothing else. All
alpar@40
   531
  the algorithms working on a data structure meeting a certain concept
alpar@40
   532
  should compile with these classes. (Though it will not run properly,
alpar@40
   533
  of course.) In this way it is easily to check if an algorithm
alpar@40
   534
  doesn't use any extra feature of a certain implementation.
alpar@40
   535
alpar@40
   536
- The concept descriptor classes also provide a <em>checker class</em>
kpeter@50
   537
  that makes it possible to check whether a certain implementation of a
alpar@40
   538
  concept indeed provides all the required features.
alpar@40
   539
alpar@40
   540
- Finally, They can serve as a skeleton of a new implementation of a concept.
alpar@40
   541
alpar@40
   542
*/
alpar@40
   543
alpar@40
   544
alpar@40
   545
/**
alpar@40
   546
@defgroup graph_concepts Graph Structure Concepts
alpar@40
   547
@ingroup concept
alpar@40
   548
\brief Skeleton and concept checking classes for graph structures
alpar@40
   549
kpeter@50
   550
This group describes the skeletons and concept checking classes of LEMON's
alpar@40
   551
graph structures and helper classes used to implement these.
alpar@40
   552
*/
alpar@40
   553
alpar@40
   554
/* --- Unused group
alpar@40
   555
@defgroup experimental Experimental Structures and Algorithms
kpeter@50
   556
This group describes some Experimental structures and algorithms.
alpar@40
   557
The stuff here is subject to change.
alpar@40
   558
*/
alpar@40
   559
alpar@40
   560
/**
alpar@40
   561
\anchor demoprograms
alpar@40
   562
alpar@40
   563
@defgroup demos Demo programs
alpar@40
   564
alpar@40
   565
Some demo programs are listed here. Their full source codes can be found in
alpar@40
   566
the \c demo subdirectory of the source tree.
alpar@40
   567
alpar@41
   568
It order to compile them, use <tt>--enable-demo</tt> configure option when
alpar@41
   569
build the library.
alpar@40
   570
*/
alpar@40
   571
alpar@40
   572
/**
alpar@40
   573
@defgroup tools Standalone utility applications
alpar@40
   574
alpar@40
   575
Some utility applications are listed here. 
alpar@40
   576
alpar@40
   577
The standard compilation procedure (<tt>./configure;make</tt>) will compile
alpar@40
   578
them, as well. 
alpar@40
   579
*/
alpar@40
   580