source: lemon-0.x/doc/groups.dox @ 1637:9d64d5672b88

/**
@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 strutures, different operations are needed which do 
not alter the physical graph, but gives an other 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 implemenation 
the residual graph can be accessed by an other algorithm, or a node-set 
is to be shrunk for an other 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 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::concept::ReadMap "ReadMap"s. They can
make arithmetic oprerations between one or two maps (negation, scalig,
addition, multiplication etc.) or e.g. convert a map to another one
of different Value type.
*/

/**
@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 graphmapfactory Tools to Make It Easier to Make Graph Maps
@ingroup auxdat
\brief Tools to Make It Easier to Make Graph Maps.

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

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

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

/**
@defgroup gutils General Graph Utilities
\brief This group describes some simple general graph utilities.
@ingroup galgs

This group describes some simple general graph utilities.
*/

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

\brief This group describes some general optimization frameworks
implemented in LEMON.

*/

/**
@defgroup flowalgs Path and Flow Algorithms
@ingroup galgs
\brief This group describes the algorithms
for finding paths and flows in graphs.
*/

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

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

/**
@defgroup io_group Input Output
Here you can find tools for imporing and exporting graphs and graph related
data
*/

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

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

One aim of these classes is to make it easier to check if a certain
class or template function is correctly implemented.

The other (sometimes even more important) aim is to document the concepts.

*/

/**
@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>./compile;make</tt>) will compile them,
as well. 

*/