COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/groups.dox @ 794:d9ec436d11fe

Last change on this file since 794:d9ec436d11fe was 794:d9ec436d11fe, checked in by Alpar Juttner, 15 years ago

New doxygen module "skeletons" for the skeletons.

File size: 2.3 KB
Line 
1/**
2@defgroup datas Data Structures
3This group describes the several graph structures implemented in HugoLib.
4*/
5
6/**
7@defgroup graphs Graph Structures
8@ingroup datas
9\brief Graph structures implemented in Hugo.
10
11Hugolib provides several data structures to meet the diverging requirements
12of the possible users.
13In order to save on running time or on memory usage, some structures may
14fail to provide
15some graph features like edge or node deletion.
16
17Hugolib also offers special graphs that cannot be used alone but only
18in conjunction with other graph representation. The examples for this are
19\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
20
21You are free to use the graph structure that fit your requirements
22the best, most graph algorithms and auxiliary data structures can be used
23with any graph structures.
24*/
25
26/**
27@defgroup auxdat Auxiliary Data Structures
28@ingroup datas
29\brief Some data structures implemented in HugoLib.
30
31This group describes the data structures implemented in HugoLib in
32order to make it easier to implement combinatorial algorithms.
33*/
34
35/**
36@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
37@ingroup auxdat
38\brief Tools to Make It Easier to Make Graph Maps.
39
40This group describes the tools that makes it easier to make graph maps that
41dynamically update with the graph changes.
42*/
43
44/**
45@defgroup gwrappers Wrapper Classes for Graphs
46\brief This group contains several wrapper classes for graphs
47@ingroup graphs
48*/
49
50/**
51@defgroup galgs Graph Algorithms
52\brief This group describes the several graph algorithms
53implemented in HugoLib.
54*/
55
56/**
57@defgroup flowalgs Path and Flow Algorithms
58@ingroup galgs
59\brief This group describes the algorithms
60for finding paths and flows in graphs.
61*/
62
63/**
64@defgroup misc Miscellaneous Tools
65Here you can find several useful tools for development,
66debugging and testing.
67*/
68
69/**
70@defgroup skeletons Skeletons
71\brief Skeletons (a.k.a. concept checking classes)
72
73This group describes the data/algorithm skeletons implemented in HugoLib in
74order to make it easier to check if a certain template class or
75template function is correctly implemented.
76*/
77
78
79/**
80@defgroup experimental Experimental Structures and Algorithms
81This group contains some Experimental structures and algorithms.
82The stuff here is subject to change.
83*/
84
85/// \ingroup misc experimental
86namespace hugo { }
Note: See TracBrowser for help on using the repository browser.