COIN-OR::LEMON - Graph Library

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

Last change on this file since 861:021e513a2d83 was 814:d2d747fe1db3, checked in by Alpar Juttner, 20 years ago

Improve docs.

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