gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Improved groups.dox. Added missing brief descriptions. Changed descriptions to be unifom. Some minor fixes.
0 1 0
default
1 file changed with 88 insertions and 91 deletions:
↑ Collapse diff ↑
Ignore white space 4 line context
... ...
@@ -19,5 +19,5 @@
19 19
/**
20 20
@defgroup datas Data Structures
21
This group describes the several graph structures implemented in LEMON.
21
This group describes the several data structures implemented in LEMON.
22 22
*/
23 23

	
... ...
@@ -51,5 +51,5 @@
51 51
LEMON also provides a variety of graphs for these requirements called 
52 52
\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only 
53
in conjunction with other graph representation. 
53
in conjunction with other graph representations. 
54 54

	
55 55
You are free to use the graph structure that fit your requirements
... ...
@@ -59,11 +59,11 @@
59 59

	
60 60
/**
61
@defgroup semi_adaptors Semi-Adaptors Classes for Graphs
61
@defgroup semi_adaptors Semi-Adaptor Classes for Graphs
62 62
@ingroup graphs
63 63
\brief Graph types between real graphs and graph adaptors.
64 64

	
65
Graph types between real graphs and graph adaptors. These classes wrap
66
graphs to give new functionality as the adaptors do it. On the other
67
hand they are not light-weight structures as the adaptors.
65
This group describes some graph types between real graphs and graph adaptors.
66
These classes wrap graphs to give new functionality as the adaptors do it. 
67
On the other hand they are not light-weight structures as the adaptors.
68 68
*/
69 69

	
... ...
@@ -71,7 +71,9 @@
71 71
@defgroup maps Maps 
72 72
@ingroup datas
73
\brief Some special purpose map to make life easier.
73
\brief Map structures implemented in LEMON.
74 74

	
75
LEMON provides several special maps that e.g. combine
75
This group describes the map structures implemented in LEMON.
76

	
77
LEMON provides several special purpose maps that e.g. combine
76 78
new maps from existing ones.
77 79
*/
... ...
@@ -82,6 +84,6 @@
82 84
\brief Special Graph-Related Maps.
83 85

	
84
These maps are specifically designed to assign values to the nodes and edges of
85
graphs.
86
This group describes maps that are specifically designed to assign
87
values to the nodes and edges of graphs.
86 88
*/
87 89

	
... ...
@@ -92,5 +94,6 @@
92 94
\brief Tools to create new maps from existing ones
93 95

	
94
Map adaptors are used to create "implicit" maps from other maps.
96
This group describes map adaptors that are used to create "implicit"
97
maps from other maps.
95 98

	
96 99
Most of them are \ref lemon::concepts::ReadMap "ReadMap"s. They can
... ...
@@ -99,5 +102,5 @@
99 102
of different Value type.
100 103

	
101
The typical usage of this classes is the passing implicit maps to
104
The typical usage of this classes is passing implicit maps to
102 105
algorithms.  If a function type algorithm is called then the function
103 106
type map adaptors can be used comfortable. For example let's see the
... ...
@@ -128,5 +131,5 @@
128 131
The usage with class type algorithms is little bit harder. In this
129 132
case the function type map adaptors can not be used, because the
130
function map adaptors give back temporarly objects.
133
function map adaptors give back temporary objects.
131 134
\code
132 135
  Graph graph;
... ...
@@ -154,7 +157,7 @@
154 157
@defgroup matrices Matrices 
155 158
@ingroup datas
156
\brief Two dimensional data storages.
159
\brief Two dimensional data storages implemented in LEMON.
157 160

	
158
Two dimensional data storages.
161
This group describes two dimensional data storages implemented in LEMON.
159 162
*/
160 163

	
... ...
@@ -164,9 +167,9 @@
164 167
\brief Path structures implemented in LEMON.
165 168

	
166
LEMON provides flexible data structures
167
to work with paths.
169
This group describes the path structures implemented in LEMON.
168 170

	
169
All of them have similar interfaces, and it can be copied easily with
170
assignment operator and copy constructor. This make it easy and
171
LEMON provides flexible data structures to work with paths.
172
All of them have similar interfaces and they can be copied easily with
173
assignment operators and copy constructors. This makes it easy and
171 174
efficient to have e.g. the Dijkstra algorithm to store its result in
172 175
any kind of path structure.
... ...
@@ -179,7 +182,7 @@
179 182
@defgroup auxdat Auxiliary Data Structures
180 183
@ingroup datas
181
\brief Some data structures implemented in LEMON.
184
\brief Auxiliary data structures implemented in LEMON.
182 185

	
183
This group describes the data structures implemented in LEMON in
186
This group describes some data structures implemented in LEMON in
184 187
order to make it easier to implement combinatorial algorithms.
185 188
*/
... ...
@@ -198,9 +201,8 @@
198 201
@defgroup search Graph Search
199 202
@ingroup algs
200
\brief This group contains the common graph
201
search algorithms.
203
\brief Common graph search algorithms.
202 204

	
203
This group contains the common graph
204
search algorithms like Bfs and Dfs.
205
This group describes the common graph search algorithms like 
206
Breadth-first search (Bfs) and Depth-first search (Dfs).
205 207
*/
206 208

	
... ...
@@ -208,10 +210,7 @@
208 210
@defgroup shortest_path Shortest Path algorithms
209 211
@ingroup algs
210
\brief This group describes the algorithms
211
for finding shortest paths.
212
\brief Algorithms for finding shortest paths.
212 213

	
213
This group describes the algorithms for finding shortest paths in
214
graphs.
215

	
214
This group describes the algorithms for finding shortest paths in graphs.
216 215
*/
217 216

	
... ...
@@ -219,29 +218,29 @@
219 218
@defgroup max_flow Maximum Flow algorithms 
220 219
@ingroup algs 
221
\brief This group describes the algorithms for finding maximum flows.
220
\brief Algorithms for finding maximum flows.
222 221

	
223 222
This group describes the algorithms for finding maximum flows and
224 223
feasible circulations.
225 224

	
226
The maximum flow problem is to find a flow between a single-source and
227
single-target that is maximum. Formally, there is \f$G=(V,A)\f$
225
The maximum flow problem is to find a flow between a single source and
226
a single target that is maximum. Formally, there is a \f$G=(V,A)\f$
228 227
directed graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity
229 228
function and given \f$s, t \in V\f$ source and target node. The
230
maximum flow is the solution of the next optimization problem:
229
maximum flow is the \f$f_a\f$ solution of the next optimization problem:
231 230

	
232 231
\f[ 0 \le f_a \le c_a \f]
233
\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \quad u \in V \setminus \{s,t\}\f]
232
\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \qquad \forall u \in V \setminus \{s,t\}\f]
234 233
\f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]
235 234

	
236
The lemon contains several algorithms for solve maximum flow problems:
235
LEMON contains several algorithms for solving maximum flow problems:
237 236
- \ref lemon::EdmondsKarp "Edmonds-Karp" 
238 237
- \ref lemon::Preflow "Goldberg's Preflow algorithm"
239
- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic tree"
238
- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"
240 239
- \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees"
241 240

	
242
In most cases the \ref lemon::Preflow "preflow" algorithm provides the
241
In most cases the \ref lemon::Preflow "Preflow" algorithm provides the
243 242
fastest method to compute the maximum flow. All impelementations
244
provides functions for query the minimum cut, which is the dual linear
245
programming probelm of the maximum flow.
243
provides functions to query the minimum cut, which is the dual linear
244
programming problem of the maximum flow.
246 245

	
247 246
*/
... ...
@@ -251,6 +250,5 @@
251 250
@ingroup algs
252 251

	
253
\brief This group describes the algorithms
254
for finding minimum cost flows and circulations.
252
\brief Algorithms for finding minimum cost flows and circulations.
255 253

	
256 254
This group describes the algorithms for finding minimum cost flows and
... ...
@@ -262,6 +260,5 @@
262 260
@ingroup algs 
263 261

	
264
\brief This group describes the algorithms for finding minimum cut in
265
graphs.
262
\brief Algorithms for finding minimum cut in graphs.
266 263

	
267 264
This group describes the algorithms for finding minimum cut in graphs.
... ...
@@ -271,15 +268,15 @@
271 268
outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an
272 269
\f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
273
cut is the solution of the next optimization problem:
270
cut is the \f$X\f$ solution of the next optimization problem:
274 271

	
275 272
\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}\sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]
276 273

	
277
The lemon contains several algorithms related to minimum cut problems:
274
LEMON contains several algorithms related to minimum cut problems:
278 275

	
279
- \ref lemon::HaoOrlin "Hao-Orlin algorithm" for calculate minimum cut
276
- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut
280 277
  in directed graphs  
281
- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
278
- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to
282 279
  calculate minimum cut in undirected graphs
283
- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" for calculate all
280
- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all
284 281
  pairs minimum cut in undirected graphs
285 282

	
... ...
@@ -292,9 +289,8 @@
292 289
@defgroup graph_prop Connectivity and other graph properties
293 290
@ingroup algs
294
\brief This group describes the algorithms
295
for discover the graph properties
291
\brief Algorithms for discovering the graph properties
296 292

	
297
This group describes the algorithms for discover the graph properties
298
like connectivity, bipartiteness, euler property, simplicity, etc...
293
This group describes the algorithms for discovering the graph properties
294
like connectivity, bipartiteness, euler property, simplicity etc.
299 295

	
300 296
\image html edge_biconnected_components.png
... ...
@@ -305,7 +301,7 @@
305 301
@defgroup planar Planarity embedding and drawing
306 302
@ingroup algs
307
\brief This group contains algorithms for planarity embedding and drawing
303
\brief Algorithms for planarity checking, embedding and drawing
308 304

	
309
This group contains algorithms for planarity checking, embedding and drawing.
305
This group describes the algorithms for planarity checking, embedding and drawing.
310 306

	
311 307
\image html planar.png
... ...
@@ -316,8 +312,7 @@
316 312
@defgroup matching Matching algorithms 
317 313
@ingroup algs
318
\brief This group describes the algorithms
319
for find matchings in graphs and bipartite graphs.
314
\brief Algorithms for finding matchings in graphs and bipartite graphs.
320 315

	
321
This group provides some algorithm objects and function to calculate
316
This group contains algorithm objects and functions to calculate
322 317
matchings in graphs and bipartite graphs. The general matching problem is
323 318
finding a subset of the edges which does not shares common endpoints.
... ...
@@ -359,8 +354,7 @@
359 354
@defgroup spantree Minimum Spanning Tree algorithms
360 355
@ingroup algs
361
\brief This group contains the algorithms for finding a minimum cost spanning
362
tree in a graph
356
\brief Algorithms for finding a minimum cost spanning tree in a graph.
363 357

	
364
This group contains the algorithms for finding a minimum cost spanning
358
This group describes the algorithms for finding a minimum cost spanning
365 359
tree in a graph
366 360
*/
... ...
@@ -370,15 +364,16 @@
370 364
@defgroup auxalg Auxiliary algorithms
371 365
@ingroup algs
372
\brief Some algorithms implemented in LEMON.
366
\brief Auxiliary algorithms implemented in LEMON.
373 367

	
374
This group describes the algorithms in LEMON in order to make 
375
it easier to implement complex algorithms.
368
This group describes some algorithms implemented in LEMON
369
in order to make it easier to implement complex algorithms.
376 370
*/
377 371

	
378 372
/**
379 373
@defgroup approx Approximation algorithms
380
\brief Approximation algorithms
374
\brief Approximation algorithms.
381 375

	
382
Approximation and heuristic algorithms
376
This group describes the approximation and heuristic algorithms
377
implemented in LEMON.
383 378
*/
384 379

	
... ...
@@ -407,6 +402,5 @@
407 402
@defgroup lp_utils Tools for Lp and Mip solvers 
408 403
@ingroup lp_group
409
\brief This group adds some helper tools to the Lp and Mip solvers
410
implemented in LEMON.
404
\brief Helper tools to the Lp and Mip solvers.
411 405

	
412 406
This group adds some helper tools to general optimization framework
... ...
@@ -419,12 +413,12 @@
419 413
\brief Metaheuristics for LEMON library.
420 414

	
421
This group contains some metaheuristic optimization tools.
415
This group describes some metaheuristic optimization tools.
422 416
*/
423 417

	
424 418
/**
425 419
@defgroup utils Tools and Utilities 
426
\brief Tools and Utilities for Programming in LEMON
420
\brief Tools and utilities for programming in LEMON
427 421

	
428
Tools and Utilities for Programming in LEMON
422
Tools and utilities for programming in LEMON.
429 423
*/
430 424

	
... ...
@@ -432,5 +426,5 @@
432 426
@defgroup gutils Basic Graph Utilities
433 427
@ingroup utils
434
\brief This group describes some simple basic graph utilities.
428
\brief Simple basic graph utilities.
435 429

	
436 430
This group describes some simple basic graph utilities.
... ...
@@ -440,13 +434,16 @@
440 434
@defgroup misc Miscellaneous Tools
441 435
@ingroup utils
442
Here you can find several useful tools for development,
436
\brief Tools for development, debugging and testing.
437

	
438
This group describes several useful tools for development,
443 439
debugging and testing.
444 440
*/
445 441

	
446

	
447 442
/**
448 443
@defgroup timecount Time measuring and Counting
449 444
@ingroup misc
450
Here you can find simple tools for measuring the performance
445
\brief Simple tools for measuring the performance of algorithms.
446

	
447
This group describes simple tools for measuring the performance
451 448
of algorithms.
452 449
*/
... ...
@@ -455,7 +452,7 @@
455 452
@defgroup graphbits Tools for Graph Implementation
456 453
@ingroup utils
457
\brief Tools to Make It Easier to Make Graphs.
454
\brief Tools to make it easier to create graphs.
458 455

	
459
This group describes the tools that makes it easier to make graphs and
456
This group describes the tools that makes it easier to create graphs and
460 457
the maps that dynamically update with the graph changes.
461 458
*/
... ...
@@ -464,14 +461,16 @@
464 461
@defgroup exceptions Exceptions
465 462
@ingroup utils
466
This group contains the exceptions thrown by LEMON library
463
\brief Exceptions defined in LEMON.
464

	
465
This group describes the exceptions defined in LEMON.
467 466
*/
468 467

	
469 468
/**
470 469
@defgroup io_group Input-Output
471
\brief Several Graph Input-Output methods
470
\brief Graph Input-Output methods
472 471

	
473
Here you can find tools for importing and exporting graphs 
472
This group describes the tools for importing and exporting graphs 
474 473
and graph related data. Now it supports the LEMON format, the
475
\c DIMACS format and the encapsulated postscript format.
474
\c DIMACS format and the encapsulated postscript (EPS) format.
476 475
*/
477 476

	
... ...
@@ -481,6 +480,6 @@
481 480
\brief Reading and writing LEMON format
482 481

	
483
Methods for reading and writing LEMON format. More about this
484
format you can find on the \ref graph-io-page "Graph Input-Output"
482
This group describes methods for reading and writing LEMON format. 
483
You can find more about this format on the \ref graph-io-page "Graph Input-Output"
485 484
tutorial pages.
486 485
*/
... ...
@@ -491,6 +490,6 @@
491 490
\brief Section readers and writers for lemon Input-Output.
492 491

	
493
Here you can find which section readers and writers can attach to
494
the LemonReader and LemonWriter.
492
This group describes section readers and writers that can be attached to
493
\ref LemonReader and \ref LemonWriter.
495 494
*/
496 495

	
... ...
@@ -510,5 +509,5 @@
510 509
\brief General \c EPS drawer and graph exporter
511 510

	
512
This group contains general \c EPS drawing methods and special
511
This group describes general \c EPS drawing methods and special
513 512
graph exporting tools. 
514 513
*/
... ...
@@ -538,5 +537,5 @@
538 537

	
539 538
- The concept descriptor classes also provide a <em>checker class</em>
540
  that makes it possible check whether a certain implementation of a
539
  that makes it possible to check whether a certain implementation of a
541 540
  concept indeed provides all the required features.
542 541

	
... ...
@@ -551,5 +550,5 @@
551 550
\brief Skeleton and concept checking classes for graph structures
552 551

	
553
This group contains the skeletons and concept checking classes of LEMON's
552
This group describes the skeletons and concept checking classes of LEMON's
554 553
graph structures and helper classes used to implement these.
555 554
*/
... ...
@@ -557,5 +556,5 @@
557 556
/* --- Unused group
558 557
@defgroup experimental Experimental Structures and Algorithms
559
This group contains some Experimental structures and algorithms.
558
This group describes some Experimental structures and algorithms.
560 559
The stuff here is subject to change.
561 560
*/
... ...
@@ -571,5 +570,4 @@
571 570
It order to compile them, use <tt>--enable-demo</tt> configure option when
572 571
build the library.
573

	
574 572
*/
575 573

	
... ...
@@ -581,5 +579,4 @@
581 579
The standard compilation procedure (<tt>./configure;make</tt>) will compile
582 580
them, as well. 
583

	
584 581
*/
585 582

	
0 comments (0 inline)