source: lemon-0.x/doc/groups.dox @ 2395:fe5966d8acfc

/* -*- C++ -*-
 *
 * This file is a part of LEMON, a generic C++ optimization library
 *
 * Copyright (C) 2003-2007
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
 *
 * Permission to use, modify and distribute this software is granted
 * provided that this copyright notice appears in all copies. For
 * precise terms see the accompanying LICENSE file.
 *
 * This software is provided "AS IS" with no warranty of any kind,
 * express or implied, and with no claim as to its suitability for any
 * purpose.
 *
 */

/**
@defgroup datas Data Structures
This group describes the several graph structures implemented in LEMON.
*/

/**
@defgroup graphs Graph Structures
@ingroup datas
\brief Graph structures implemented in LEMON.

The implementation of combinatorial algorithms heavily relies on 
efficient graph implementations. LEMON offers data structures which are 
planned to be easily used in an experimental phase of implementation studies, 
and thereafter the program code can be made efficient by small modifications. 

The most efficient implementation of diverse applications require the
usage of different physical graph implementations. These differences
appear in the size of graph we require to handle, memory or time usage
limitations or in the set of operations through which the graph can be
accessed.  LEMON provides several physical graph structures to meet
the diverging requirements of the possible users.  In order to save on
running time or on memory usage, some structures may fail to provide
some graph features like edge or node deletion.

Alteration of standard containers need a very limited number of 
operations, these together satisfy the everyday requirements. 
In the case of graph structures, different operations are needed which do 
not alter the physical graph, but gives another view. If some nodes or 
edges have to be hidden or the reverse oriented graph have to be used, then 
this is the case. It also may happen that in a flow implementation 
the residual graph can be accessed by another algorithm, or a node-set 
is to be shrunk for another algorithm. 
LEMON also provides a variety of graphs for these requirements called 
\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only 
in conjunction with other graph representation. 

You are free to use the graph structure that fit your requirements
the best, most graph algorithms and auxiliary data structures can be used
with any graph structures. 
*/

/**
@defgroup semi_adaptors Semi-Adaptors Classes for Graphs
@ingroup graphs
\brief Graph types between real graphs and graph adaptors.

Graph types between real graphs and graph adaptors. These classes wrap
graphs to give new functionality as the adaptors do it. On the other
hand they are not light-weight structures as the adaptors.
*/

/**
@defgroup maps Maps 
@ingroup datas
\brief Some special purpose map to make life easier.

LEMON provides several special maps that e.g. combine
new maps from existing ones.
*/

/**
@defgroup graph_maps Graph Maps 
@ingroup maps
\brief Special Graph-Related Maps.

These maps are specifically designed to assign values to the nodes and edges of
graphs.
*/


/**
\defgroup map_adaptors Map Adaptors
\ingroup maps
\brief Tools to create new maps from existing ones

Map adaptors are used to create "implicit" maps from other maps.

Most of them are \ref lemon::concepts::ReadMap "ReadMap"s. They can
make arithmetic operations between one or two maps (negation, scaling,
addition, multiplication etc.) or e.g. convert a map to another one
of different Value type.
*/

/**
@defgroup matrices Matrices 
@ingroup datas
\brief Two dimensional data storages.

Two dimensional data storages.
*/

/**
@defgroup paths Path Structures
@ingroup datas
\brief Path structures implemented in LEMON.

LEMON provides flexible data structures
to work with paths.

All of them have the same interface, especially they can be built or extended
using a standard Builder subclass. This make is easy to have e.g. the Dijkstra
algorithm to store its result in any kind of path structure.

\sa lemon::concepts::Path

*/

/**
@defgroup auxdat Auxiliary Data Structures
@ingroup datas
\brief Some data structures implemented in LEMON.

This group describes the data structures implemented in LEMON in
order to make it easier to implement combinatorial algorithms.
*/


/**
@defgroup algs Algorithms
\brief This group describes the several algorithms
implemented in LEMON.

This group describes the several algorithms
implemented in LEMON.
*/

/**
@defgroup search Graph Search
@ingroup algs
\brief This group contains the common graph
search algorithms.

This group contains the common graph
search algorithms like Bfs and Dfs.
*/

/**
@defgroup shortest_path Shortest Path algorithms
@ingroup algs
\brief This group describes the algorithms
for finding shortest paths.

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

*/

/** 
@defgroup max_flow Maximum Flow algorithms 
@ingroup algs 
\brief This group describes the algorithms for finding maximum flows.

This group describes the algorithms for finding maximum flows and
feasible circulations.

\image html flow.png
\image latex flow.eps "Graph flow" width=\textwidth
*/

/**
@defgroup min_cost_flow Minimum Cost Flow algorithms
@ingroup algs

\brief This group describes the algorithms
for finding minimum cost flows and circulations.

This group describes the algorithms for finding minimum cost flows and
circulations.  
*/

/**
@defgroup min_cut Minimum Cut algorithms
@ingroup algs
\brief This group describes the algorithms
for finding minimum cut in graphs.

This group describes the algorithms
for finding minimum cut in graphs.
*/

/**
@defgroup topology Topology related algorithms
@ingroup algs
\brief This group describes the algorithms
for discover the topology of the graphs.

This group describes the algorithms
for discover the topology of the graphs.

\image html edge_biconnected_components.png
\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
*/

/**
@defgroup matching Matching algorithms 
@ingroup algs
\brief This group describes the algorithms
for find matchings in graphs and bipartite graphs.

This group provides some algorithm objects and function
to calculate matchings in graphs and bipartite graphs.

\image html bipartite_matching.png
\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth

*/

/**
@defgroup spantree Minimum Spanning Tree algorithms
@ingroup algs
\brief This group contains the algorithms for finding a minimum cost spanning
tree in a graph

This group contains the algorithms for finding a minimum cost spanning
tree in a graph
*/


/**
@defgroup auxalg Auxiliary algorithms
@ingroup algs
\brief Some algorithms implemented in LEMON.

This group describes the algorithms in LEMON in order to make 
it easier to implement complex algorithms.
*/

/**
@defgroup approx Approximation algorithms
\brief Approximation algorithms

Approximation and heuristic algorithms
*/

/**
@defgroup gen_opt_group General Optimization Tools
\brief This group describes some general optimization frameworks
implemented in LEMON.

This group describes some general optimization frameworks
implemented in LEMON.

*/

/**
@defgroup lp_group Lp and Mip solvers
@ingroup gen_opt_group
\brief Lp and Mip solver interfaces for LEMON.

This group describes Lp and Mip solver interfaces for LEMON. The
various LP solvers could be used in the same manner with this
interface.

*/

/** 
@defgroup lp_utils Tools for Lp and Mip solvers 
@ingroup lp_group
\brief This group adds some helper tools to the Lp and Mip solvers
implemented in LEMON.

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

/**
@defgroup metah Metaheuristics
@ingroup gen_opt_group
\brief Metaheuristics for LEMON library.

This group contains some metaheuristic optimization tools.
*/

/**
@defgroup utils Tools and Utilities 
\brief Tools and Utilities for Programming in LEMON

Tools and Utilities for Programming in LEMON
*/

/**
@defgroup gutils Basic Graph Utilities
@ingroup utils
\brief This group describes some simple basic graph utilities.

This group describes some simple basic graph utilities.
*/

/**
@defgroup misc Miscellaneous Tools
@ingroup utils
Here you can find several useful tools for development,
debugging and testing.
*/


/**
@defgroup timecount Time measuring and Counting
@ingroup misc
Here you can find simple tools for measuring the performance
of algorithms.
*/

/**
@defgroup graphbits Tools for Graph Implementation
@ingroup utils
\brief Tools to Make It Easier to Make Graphs.

This group describes the tools that makes it easier to make graphs and
the maps that dynamically update with the graph changes.
*/

/**
@defgroup exceptions Exceptions
@ingroup utils
This group contains the exceptions thrown by LEMON library
*/

/**
@defgroup io_group Input-Output
\brief Several Graph Input-Output methods

Here you can find tools for importing and exporting graphs 
and graph related data. Now it supports the LEMON format, the
\c DIMACS format and the encapsulated postscript format.
*/

/**
@defgroup lemon_io Lemon Input-Output
@ingroup io_group
\brief Reading and writing LEMON format

Methods for reading and writing LEMON format. More about this
format you can find on the \ref graph-io-page "Graph Input-Output"
tutorial pages.
*/

/**
@defgroup section_io Section readers and writers
@ingroup lemon_io
\brief Section readers and writers for lemon Input-Output.

Here you can find which section readers and writers can attach to
the LemonReader and LemonWriter.
*/

/**
@defgroup item_io Item Readers and Writers
@ingroup lemon_io
\brief Item readers and writers for lemon Input-Output.

The Input-Output classes can handle more data type by example
as map or attribute value. Each of these should be written and
read some way. The module make possible to do this.  
*/

/**
@defgroup eps_io Postscript exporting
@ingroup io_group
\brief General \c EPS drawer and graph exporter

This group contains general \c EPS drawing methods and special
graph exporting tools. 
*/


/**
@defgroup concept Concepts
\brief Skeleton classes and concept checking classes

This group describes the data/algorithm skeletons and concept checking
classes implemented in LEMON.

The purpose of the classes in this group is fourfold.
 
- These classes contain the documentations of the concepts. In order
  to avoid document multiplications, an implementation of a concept
  simply refers to the corresponding concept class.

- These classes declare every functions, <tt>typedef</tt>s etc. an
  implementation of the concepts should provide, however completely
  without implementations and real data structures behind the
  interface. On the other hand they should provide nothing else. All
  the algorithms working on a data structure meeting a certain concept
  should compile with these classes. (Though it will not run properly,
  of course.) In this way it is easily to check if an algorithm
  doesn't use any extra feature of a certain implementation.

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

- Finally, They can serve as a skeleton of a new implementation of a concept.

*/


/**
@defgroup graph_concepts Graph Structure Concepts
@ingroup concept
\brief Skeleton and concept checking classes for graph structures

This group contains the skeletons and concept checking classes of LEMON's
graph structures and helper classes used to implement these.
*/

/* --- Unused group
@defgroup experimental Experimental Structures and Algorithms
This group contains some Experimental structures and algorithms.
The stuff here is subject to change.
*/

/**
\anchor demoprograms

@defgroup demos Demo programs

Some demo programs are listed here. Their full source codes can be found in
the \c demo subdirectory of the source tree.

The standard compilation procedure (<tt>./configure;make</tt>) will compile
them, as well. 

*/