COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/groups.dox @ 1030:c8a41699e613

Last change on this file since 1030:c8a41699e613 was 1030:c8a41699e613, checked in by Mihaly Barasz, 16 years ago

Undirected graph documentation and concept refinements.

  • quite a few bug fixes
  • concept::UndirGraph? is almost complete and looks quite good.
File size: 2.9 KB
Line 
1
2/**
3@defgroup datas Data Structures
4This group describes the several graph structures implemented in LEMON.
5*/
6
7/**
8@defgroup graphs Graph Structures
9@ingroup datas
10\brief Graph structures implemented in LEMON.
11
12LEMON 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
18LEMON also offers special graphs that cannot be used alone but only
19in conjunction with other graph representation. The examples for this are
20\ref lemon::EdgeSet "EdgeSet", \ref lemon::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 LEMON.
32
33This group describes the data structures implemented in LEMON 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 LEMON.
56
57This group describes the several graph algorithms
58implemented in LEMON.
59*/
60
61/**
62@defgroup gutils General Graph Utilities
63\brief This group describes some simple general graph utilities.
64@ingroup galgs
65
66This group describes some simple general graph utilities.
67*/
68
69/**
70@defgroup flowalgs Path and Flow Algorithms
71@ingroup galgs
72\brief This group describes the algorithms
73for finding paths and flows in graphs.
74*/
75
76/**
77@defgroup misc Miscellaneous Tools
78Here you can find several useful tools for development,
79debugging and testing.
80*/
81
82/**
83@defgroup concept Concepts
84\brief Skeleton classes and concept checking classes
85
86This group describes the data/algorithm skeletons and concept checking
87classes implemented in LEMON.
88
89One aim of these classes is to make it easier to check if a certain
90class or template function is correctly implemented.
91
92The other (sometimes even more important) aim is to document the concepts.
93
94*/
95
96/**
97@defgroup graph_concepts Graph Structure Concepts
98@ingroup concept
99\brief Skeleton and concept checking classes for graph structures
100
101This group contains the skeletons and concept checking classes of LEMON's
102graph structures and helper classes used to implement these.
103*/
104
105/**
106@defgroup experimental Experimental Structures and Algorithms
107This group contains some Experimental structures and algorithms.
108The stuff here is subject to change.
109*/
Note: See TracBrowser for help on using the repository browser.