source: lemon-0.x/doc/groups.dox @ 861:021e513a2d83

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

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

Hugolib provides several data 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.

Hugolib also offers special graphs that cannot be used alone but only
in conjunction with other graph representation. The examples for this are
\ref hugo::EdgeSet "EdgeSet", \ref hugo::NodeSet "NodeSet"
and the large variety of \ref gwrappers "graph wrappers".

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 auxdat Auxiliary Data Structures
@ingroup datas
\brief Some data structures implemented in HugoLib.

This group describes the data structures implemented in HugoLib 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 gwrappers Wrapper Classes for Graphs
\brief This group contains several wrapper classes for graphs
@ingroup graphs
*/

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

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

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

/**
@defgroup skeletons Skeletons
\brief Skeletons (a.k.a. concept checking classes)

This group describes the data/algorithm skeletons implemented in HugoLib in
order to make it easier to check if a certain template class or
template function is correctly implemented.
*/


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