| ... |
... |
@@ -371,180 +371,187 @@
|
| 371 |
371 |
@defgroup approx Approximation Algorithms
|
| 372 |
372 |
@ingroup algs
|
| 373 |
373 |
\brief Approximation algorithms.
|
| 374 |
374 |
|
| 375 |
375 |
This group describes the approximation and heuristic algorithms
|
| 376 |
376 |
implemented in LEMON.
|
| 377 |
377 |
*/
|
| 378 |
378 |
|
| 379 |
379 |
/**
|
| 380 |
380 |
@defgroup gen_opt_group General Optimization Tools
|
| 381 |
381 |
\brief This group describes some general optimization frameworks
|
| 382 |
382 |
implemented in LEMON.
|
| 383 |
383 |
|
| 384 |
384 |
This group describes some general optimization frameworks
|
| 385 |
385 |
implemented in LEMON.
|
| 386 |
386 |
*/
|
| 387 |
387 |
|
| 388 |
388 |
/**
|
| 389 |
389 |
@defgroup lp_group Lp and Mip Solvers
|
| 390 |
390 |
@ingroup gen_opt_group
|
| 391 |
391 |
\brief Lp and Mip solver interfaces for LEMON.
|
| 392 |
392 |
|
| 393 |
393 |
This group describes Lp and Mip solver interfaces for LEMON. The
|
| 394 |
394 |
various LP solvers could be used in the same manner with this
|
| 395 |
395 |
interface.
|
| 396 |
396 |
*/
|
| 397 |
397 |
|
| 398 |
398 |
/**
|
| 399 |
399 |
@defgroup lp_utils Tools for Lp and Mip Solvers
|
| 400 |
400 |
@ingroup lp_group
|
| 401 |
401 |
\brief Helper tools to the Lp and Mip solvers.
|
| 402 |
402 |
|
| 403 |
403 |
This group adds some helper tools to general optimization framework
|
| 404 |
404 |
implemented in LEMON.
|
| 405 |
405 |
*/
|
| 406 |
406 |
|
| 407 |
407 |
/**
|
| 408 |
408 |
@defgroup metah Metaheuristics
|
| 409 |
409 |
@ingroup gen_opt_group
|
| 410 |
410 |
\brief Metaheuristics for LEMON library.
|
| 411 |
411 |
|
| 412 |
412 |
This group describes some metaheuristic optimization tools.
|
| 413 |
413 |
*/
|
| 414 |
414 |
|
| 415 |
415 |
/**
|
| 416 |
416 |
@defgroup utils Tools and Utilities
|
| 417 |
417 |
\brief Tools and utilities for programming in LEMON
|
| 418 |
418 |
|
| 419 |
419 |
Tools and utilities for programming in LEMON.
|
| 420 |
420 |
*/
|
| 421 |
421 |
|
| 422 |
422 |
/**
|
| 423 |
423 |
@defgroup gutils Basic Graph Utilities
|
| 424 |
424 |
@ingroup utils
|
| 425 |
425 |
\brief Simple basic graph utilities.
|
| 426 |
426 |
|
| 427 |
427 |
This group describes some simple basic graph utilities.
|
| 428 |
428 |
*/
|
| 429 |
429 |
|
| 430 |
430 |
/**
|
| 431 |
431 |
@defgroup misc Miscellaneous Tools
|
| 432 |
432 |
@ingroup utils
|
| 433 |
433 |
\brief Tools for development, debugging and testing.
|
| 434 |
434 |
|
| 435 |
435 |
This group describes several useful tools for development,
|
| 436 |
436 |
debugging and testing.
|
| 437 |
437 |
*/
|
| 438 |
438 |
|
| 439 |
439 |
/**
|
| 440 |
440 |
@defgroup timecount Time Measuring and Counting
|
| 441 |
441 |
@ingroup misc
|
| 442 |
442 |
\brief Simple tools for measuring the performance of algorithms.
|
| 443 |
443 |
|
| 444 |
444 |
This group describes simple tools for measuring the performance
|
| 445 |
445 |
of algorithms.
|
| 446 |
446 |
*/
|
| 447 |
447 |
|
| 448 |
448 |
/**
|
| 449 |
449 |
@defgroup exceptions Exceptions
|
| 450 |
450 |
@ingroup utils
|
| 451 |
451 |
\brief Exceptions defined in LEMON.
|
| 452 |
452 |
|
| 453 |
453 |
This group describes the exceptions defined in LEMON.
|
| 454 |
454 |
*/
|
| 455 |
455 |
|
| 456 |
456 |
/**
|
| 457 |
457 |
@defgroup io_group Input-Output
|
| 458 |
458 |
\brief Graph Input-Output methods
|
| 459 |
459 |
|
| 460 |
460 |
This group describes the tools for importing and exporting graphs
|
| 461 |
461 |
and graph related data. Now it supports the \ref lgf-format
|
| 462 |
462 |
"LEMON Graph Format", the \c DIMACS format and the encapsulated
|
| 463 |
463 |
postscript (EPS) format.
|
| 464 |
464 |
*/
|
| 465 |
465 |
|
| 466 |
466 |
/**
|
| 467 |
|
@defgroup lemon_io LEMON Input-Output
|
|
467 |
@defgroup lemon_io LEMON Graph Format
|
| 468 |
468 |
@ingroup io_group
|
| 469 |
469 |
\brief Reading and writing LEMON Graph Format.
|
| 470 |
470 |
|
| 471 |
471 |
This group describes methods for reading and writing
|
| 472 |
472 |
\ref lgf-format "LEMON Graph Format".
|
| 473 |
473 |
*/
|
| 474 |
474 |
|
| 475 |
475 |
/**
|
| 476 |
476 |
@defgroup eps_io Postscript Exporting
|
| 477 |
477 |
@ingroup io_group
|
| 478 |
478 |
\brief General \c EPS drawer and graph exporter
|
| 479 |
479 |
|
| 480 |
480 |
This group describes general \c EPS drawing methods and special
|
| 481 |
481 |
graph exporting tools.
|
| 482 |
482 |
*/
|
| 483 |
483 |
|
| 484 |
484 |
/**
|
|
485 |
@defgroup nauty_group NAUTY Format
|
|
486 |
@ingroup io_group
|
|
487 |
\brief Read \e Nauty format
|
|
488 |
Tool to read graphs from \e Nauty format data.
|
|
489 |
*/
|
|
490 |
|
|
491 |
/**
|
| 485 |
492 |
@defgroup concept Concepts
|
| 486 |
493 |
\brief Skeleton classes and concept checking classes
|
| 487 |
494 |
|
| 488 |
495 |
This group describes the data/algorithm skeletons and concept checking
|
| 489 |
496 |
classes implemented in LEMON.
|
| 490 |
497 |
|
| 491 |
498 |
The purpose of the classes in this group is fourfold.
|
| 492 |
499 |
|
| 493 |
500 |
- These classes contain the documentations of the %concepts. In order
|
| 494 |
501 |
to avoid document multiplications, an implementation of a concept
|
| 495 |
502 |
simply refers to the corresponding concept class.
|
| 496 |
503 |
|
| 497 |
504 |
- These classes declare every functions, <tt>typedef</tt>s etc. an
|
| 498 |
505 |
implementation of the %concepts should provide, however completely
|
| 499 |
506 |
without implementations and real data structures behind the
|
| 500 |
507 |
interface. On the other hand they should provide nothing else. All
|
| 501 |
508 |
the algorithms working on a data structure meeting a certain concept
|
| 502 |
509 |
should compile with these classes. (Though it will not run properly,
|
| 503 |
510 |
of course.) In this way it is easily to check if an algorithm
|
| 504 |
511 |
doesn't use any extra feature of a certain implementation.
|
| 505 |
512 |
|
| 506 |
513 |
- The concept descriptor classes also provide a <em>checker class</em>
|
| 507 |
514 |
that makes it possible to check whether a certain implementation of a
|
| 508 |
515 |
concept indeed provides all the required features.
|
| 509 |
516 |
|
| 510 |
517 |
- Finally, They can serve as a skeleton of a new implementation of a concept.
|
| 511 |
518 |
*/
|
| 512 |
519 |
|
| 513 |
520 |
/**
|
| 514 |
521 |
@defgroup graph_concepts Graph Structure Concepts
|
| 515 |
522 |
@ingroup concept
|
| 516 |
523 |
\brief Skeleton and concept checking classes for graph structures
|
| 517 |
524 |
|
| 518 |
525 |
This group describes the skeletons and concept checking classes of LEMON's
|
| 519 |
526 |
graph structures and helper classes used to implement these.
|
| 520 |
527 |
*/
|
| 521 |
528 |
|
| 522 |
529 |
/**
|
| 523 |
530 |
@defgroup map_concepts Map Concepts
|
| 524 |
531 |
@ingroup concept
|
| 525 |
532 |
\brief Skeleton and concept checking classes for maps
|
| 526 |
533 |
|
| 527 |
534 |
This group describes the skeletons and concept checking classes of maps.
|
| 528 |
535 |
*/
|
| 529 |
536 |
|
| 530 |
537 |
/**
|
| 531 |
538 |
\anchor demoprograms
|
| 532 |
539 |
|
| 533 |
540 |
@defgroup demos Demo programs
|
| 534 |
541 |
|
| 535 |
542 |
Some demo programs are listed here. Their full source codes can be found in
|
| 536 |
543 |
the \c demo subdirectory of the source tree.
|
| 537 |
544 |
|
| 538 |
545 |
It order to compile them, use <tt>--enable-demo</tt> configure option when
|
| 539 |
546 |
build the library.
|
| 540 |
547 |
*/
|
| 541 |
548 |
|
| 542 |
549 |
/**
|
| 543 |
550 |
@defgroup tools Standalone utility applications
|
| 544 |
551 |
|
| 545 |
552 |
Some utility applications are listed here.
|
| 546 |
553 |
|
| 547 |
554 |
The standard compilation procedure (<tt>./configure;make</tt>) will compile
|
| 548 |
555 |
them, as well.
|
| 549 |
556 |
*/
|
| 550 |
557 |
|