COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/groups.dox @ 1072:ce824c6ffd5d

Last change on this file since 1072:ce824c6ffd5d was 1043:52a2201a88e9, checked in by Alpar Juttner, 16 years ago

Several changes in doc

File size: 3.1 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 maps Maps
30@ingroup datas
31\brief Some special purpose map to make life easier.
32
33LEMON provides several special maps that e.g. combine
34new maps from existing ones.
35*/
36
37/**
38@defgroup auxdat Auxiliary Data Structures
39@ingroup datas
40\brief Some data structures implemented in LEMON.
41
42This group describes the data structures implemented in LEMON in
43order to make it easier to implement combinatorial algorithms.
44*/
45
46/**
47@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
48@ingroup auxdat
49\brief Tools to Make It Easier to Make Graph Maps.
50
51This group describes the tools that makes it easier to make graph maps that
52dynamically update with the graph changes.
53*/
54
55/**
56@defgroup gwrappers Wrapper Classes for Graphs
57\brief This group contains several wrapper classes for graphs
58@ingroup graphs
59*/
60
61/**
62@defgroup galgs Graph Algorithms
63\brief This group describes the several graph algorithms
64implemented in LEMON.
65
66This group describes the several graph algorithms
67implemented in LEMON.
68*/
69
70/**
71@defgroup gutils General Graph Utilities
72\brief This group describes some simple general graph utilities.
73@ingroup galgs
74
75This group describes some simple general graph utilities.
76*/
77
78/**
79@defgroup flowalgs Path and Flow Algorithms
80@ingroup galgs
81\brief This group describes the algorithms
82for finding paths and flows in graphs.
83*/
84
85/**
86@defgroup misc Miscellaneous Tools
87Here you can find several useful tools for development,
88debugging and testing.
89*/
90
91/**
92@defgroup concept Concepts
93\brief Skeleton classes and concept checking classes
94
95This group describes the data/algorithm skeletons and concept checking
96classes implemented in LEMON.
97
98One aim of these classes is to make it easier to check if a certain
99class or template function is correctly implemented.
100
101The other (sometimes even more important) aim is to document the concepts.
102
103*/
104
105/**
106@defgroup graph_concepts Graph Structure Concepts
107@ingroup concept
108\brief Skeleton and concept checking classes for graph structures
109
110This group contains the skeletons and concept checking classes of LEMON's
111graph structures and helper classes used to implement these.
112*/
113
114/**
115@defgroup experimental Experimental Structures and Algorithms
116This group contains some Experimental structures and algorithms.
117The stuff here is subject to change.
118*/
Note: See TracBrowser for help on using the repository browser.