gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Trim the documentation (#359)
0 1 0
1.2
1 file changed with 4 insertions and 64 deletions:
↑ Collapse diff ↑
Ignore white space 24 line context
... ...
@@ -285,32 +285,24 @@
285 285
\brief Geometric data structures implemented in LEMON.
286 286

	
287 287
This group contains geometric data structures implemented in LEMON.
288 288

	
289 289
 - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
290 290
   vector with the usual operations.
291 291
 - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
292 292
   rectangular bounding box of a set of \ref lemon::dim2::Point
293 293
   "dim2::Point"'s.
294 294
*/
295 295

	
296 296
/**
297
@defgroup matrices Matrices
298
@ingroup auxdat
299
\brief Two dimensional data storages implemented in LEMON.
300

	
301
This group contains two dimensional data storages implemented in LEMON.
302
*/
303

	
304
/**
305 297
@defgroup algs Algorithms
306 298
\brief This group contains the several algorithms
307 299
implemented in LEMON.
308 300

	
309 301
This group contains the several algorithms
310 302
implemented in LEMON.
311 303
*/
312 304

	
313 305
/**
314 306
@defgroup search Graph Search
315 307
@ingroup algs
316 308
\brief Common graph search algorithms.
... ...
@@ -325,28 +317,24 @@
325 317
@ingroup algs
326 318
\brief Algorithms for finding shortest paths.
327 319

	
328 320
This group contains the algorithms for finding shortest paths in digraphs
329 321
\ref clrs01algorithms.
330 322

	
331 323
 - \ref Dijkstra algorithm for finding shortest paths from a source node
332 324
   when all arc lengths are non-negative.
333 325
 - \ref BellmanFord "Bellman-Ford" algorithm for finding shortest paths
334 326
   from a source node when arc lenghts can be either positive or negative,
335 327
   but the digraph should not contain directed cycles with negative total
336 328
   length.
337
 - \ref FloydWarshall "Floyd-Warshall" and \ref Johnson "Johnson" algorithms
338
   for solving the \e all-pairs \e shortest \e paths \e problem when arc
339
   lenghts can be either positive or negative, but the digraph should
340
   not contain directed cycles with negative total length.
341 329
 - \ref Suurballe A successive shortest path algorithm for finding
342 330
   arc-disjoint paths between two nodes having minimum total length.
343 331
*/
344 332

	
345 333
/**
346 334
@defgroup spantree Minimum Spanning Tree Algorithms
347 335
@ingroup algs
348 336
\brief Algorithms for finding minimum cost spanning trees and arborescences.
349 337

	
350 338
This group contains the algorithms for finding minimum cost spanning
351 339
trees and arborescences \ref clrs01algorithms.
352 340
*/
... ...
@@ -362,38 +350,28 @@
362 350
The \e maximum \e flow \e problem is to find a flow of maximum value between
363 351
a single source and a single target. Formally, there is a \f$G=(V,A)\f$
364 352
digraph, a \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function and
365 353
\f$s, t \in V\f$ source and target nodes.
366 354
A maximum flow is an \f$f: A\rightarrow\mathbf{R}^+_0\f$ solution of the
367 355
following optimization problem.
368 356

	
369 357
\f[ \max\sum_{sv\in A} f(sv) - \sum_{vs\in A} f(vs) \f]
370 358
\f[ \sum_{uv\in A} f(uv) = \sum_{vu\in A} f(vu)
371 359
    \quad \forall u\in V\setminus\{s,t\} \f]
372 360
\f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f]
373 361

	
374
LEMON contains several algorithms for solving maximum flow problems:
375
- \ref EdmondsKarp Edmonds-Karp algorithm
376
  \ref edmondskarp72theoretical.
377
- \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm
378
  \ref goldberg88newapproach.
379
- \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees
380
  \ref dinic70algorithm, \ref sleator83dynamic.
381
- \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees
382
  \ref goldberg88newapproach, \ref sleator83dynamic.
383

	
384
In most cases the \ref Preflow algorithm provides the
385
fastest method for computing a maximum flow. All implementations
386
also provide functions to query the minimum cut, which is the dual
387
problem of maximum flow.
362
\ref Preflow is an efficient implementation of Goldberg-Tarjan's
363
preflow push-relabel algorithm \ref goldberg88newapproach for finding
364
maximum flows. It also provides functions to query the minimum cut,
365
which is the dual problem of maximum flow.
388 366

	
389 367
\ref Circulation is a preflow push-relabel algorithm implemented directly
390 368
for finding feasible circulations, which is a somewhat different problem,
391 369
but it is strongly related to maximum flow.
392 370
For more information, see \ref Circulation.
393 371
*/
394 372

	
395 373
/**
396 374
@defgroup min_cost_flow_algs Minimum Cost Flow Algorithms
397 375
@ingroup algs
398 376

	
399 377
\brief Algorithms for finding minimum cost flows and circulations.
... ...
@@ -432,26 +410,24 @@
432 410
\f$X\f$ subset of the nodes with minimum overall capacity on
433 411
outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a
434 412
\f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
435 413
cut is the \f$X\f$ solution of the next optimization problem:
436 414

	
437 415
\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
438 416
    \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]
439 417

	
440 418
LEMON contains several algorithms related to minimum cut problems:
441 419

	
442 420
- \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut
443 421
  in directed graphs.
444
- \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for
445
  calculating minimum cut in undirected graphs.
446 422
- \ref GomoryHu "Gomory-Hu tree computation" for calculating
447 423
  all-pairs minimum cut in undirected graphs.
448 424

	
449 425
If you want to find minimum cut just between two distinict nodes,
450 426
see the \ref max_flow "maximum flow problem".
451 427
*/
452 428

	
453 429
/**
454 430
@defgroup min_mean_cycle Minimum Mean Cycle Algorithms
455 431
@ingroup algs
456 432
\brief Algorithms for finding minimum mean cycles.
457 433

	
... ...
@@ -496,34 +472,24 @@
496 472
matchings in graphs and bipartite graphs. The general matching problem is
497 473
finding a subset of the edges for which each node has at most one incident
498 474
edge.
499 475

	
500 476
There are several different algorithms for calculate matchings in
501 477
graphs.  The matching problems in bipartite graphs are generally
502 478
easier than in general graphs. The goal of the matching optimization
503 479
can be finding maximum cardinality, maximum weight or minimum cost
504 480
matching. The search can be constrained to find perfect or
505 481
maximum cardinality matching.
506 482

	
507 483
The matching algorithms implemented in LEMON:
508
- \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm
509
  for calculating maximum cardinality matching in bipartite graphs.
510
- \ref PrBipartiteMatching Push-relabel algorithm
511
  for calculating maximum cardinality matching in bipartite graphs.
512
- \ref MaxWeightedBipartiteMatching
513
  Successive shortest path algorithm for calculating maximum weighted
514
  matching and maximum weighted bipartite matching in bipartite graphs.
515
- \ref MinCostMaxBipartiteMatching
516
  Successive shortest path algorithm for calculating minimum cost maximum
517
  matching in bipartite graphs.
518 484
- \ref MaxMatching Edmond's blossom shrinking algorithm for calculating
519 485
  maximum cardinality matching in general graphs.
520 486
- \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating
521 487
  maximum weighted matching in general graphs.
522 488
- \ref MaxWeightedPerfectMatching
523 489
  Edmond's blossom shrinking algorithm for calculating maximum weighted
524 490
  perfect matching in general graphs.
525 491
- \ref MaxFractionalMatching Push-relabel algorithm for calculating
526 492
  maximum cardinality fractional matching in general graphs.
527 493
- \ref MaxWeightedFractionalMatching Augmenting path algorithm for calculating
528 494
  maximum weighted fractional matching in general graphs.
529 495
- \ref MaxWeightedPerfectFractionalMatching
... ...
@@ -550,33 +516,24 @@
550 516
@defgroup planar Planarity Embedding and Drawing
551 517
@ingroup algs
552 518
\brief Algorithms for planarity checking, embedding and drawing
553 519

	
554 520
This group contains the algorithms for planarity checking,
555 521
embedding and drawing.
556 522

	
557 523
\image html planar.png
558 524
\image latex planar.eps "Plane graph" width=\textwidth
559 525
*/
560 526

	
561 527
/**
562
@defgroup approx Approximation Algorithms
563
@ingroup algs
564
\brief Approximation algorithms.
565

	
566
This group contains the approximation and heuristic algorithms
567
implemented in LEMON.
568
*/
569

	
570
/**
571 528
@defgroup auxalg Auxiliary Algorithms
572 529
@ingroup algs
573 530
\brief Auxiliary algorithms implemented in LEMON.
574 531

	
575 532
This group contains some algorithms implemented in LEMON
576 533
in order to make it easier to implement complex algorithms.
577 534
*/
578 535

	
579 536
/**
580 537
@defgroup gen_opt_group General Optimization Tools
581 538
\brief This group contains some general optimization frameworks
582 539
implemented in LEMON.
... ...
@@ -590,41 +547,24 @@
590 547
@ingroup gen_opt_group
591 548
\brief LP and MIP solver interfaces for LEMON.
592 549

	
593 550
This group contains LP and MIP solver interfaces for LEMON.
594 551
Various LP solvers could be used in the same manner with this
595 552
high-level interface.
596 553

	
597 554
The currently supported solvers are \ref glpk, \ref clp, \ref cbc,
598 555
\ref cplex, \ref soplex.
599 556
*/
600 557

	
601 558
/**
602
@defgroup lp_utils Tools for Lp and Mip Solvers
603
@ingroup lp_group
604
\brief Helper tools to the Lp and Mip solvers.
605

	
606
This group adds some helper tools to general optimization framework
607
implemented in LEMON.
608
*/
609

	
610
/**
611
@defgroup metah Metaheuristics
612
@ingroup gen_opt_group
613
\brief Metaheuristics for LEMON library.
614

	
615
This group contains some metaheuristic optimization tools.
616
*/
617

	
618
/**
619 559
@defgroup utils Tools and Utilities
620 560
\brief Tools and utilities for programming in LEMON
621 561

	
622 562
Tools and utilities for programming in LEMON.
623 563
*/
624 564

	
625 565
/**
626 566
@defgroup gutils Basic Graph Utilities
627 567
@ingroup utils
628 568
\brief Simple basic graph utilities.
629 569

	
630 570
This group contains some simple basic graph utilities.
0 comments (0 inline)