COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/groups.dox @ 1328:a8dd11348853

Last change on this file since 1328:a8dd11348853 was 1287:984723507b86, checked in by Alpar Juttner, 16 years ago

New groups called io_group and dimacs_group added

File size: 4.3 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
12The implementation of combinatorial algorithms heavily relies on
13efficient graph implementations. LEMON offers data structures which are
14planned to be easily used in an experimental phase of implementation studies,
15and thereafter the program code can be made efficient by small modifications.
16
17The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of
18graph we require to handle, memory or time usage limitations or in
19the set of operations through which the graph can be accessed.
20LEMON provides several physical graph structures to meet the
21diverging requirements of the possible users.
22In order to save on running time or on memory usage, some structures may
23fail to provide some graph features like edge or node deletion.
24
25Alteration of standard containers need a very limited number of
26operations, these together satisfy the everyday requirements.
27In the case of graph strutures, different operations are needed which do
28not alter the physical graph, but gives an other view. If some nodes or
29edges have to be hidden or the reverse oriented graph have to be used, then
30this is the case. It also may happen that in a flow implemenation
31the residual graph can be accessed by an other algorithm, or a node-set
32is to be shrunk for an other algorithm.
33LEMON also provides a variety of graphs for these requirements called
34\ref gwrappers "graph wrappers". Wrappers cannot be used alone but only
35in conjunction with other graph representation.
36
37You are free to use the graph structure that fit your requirements
38the best, most graph algorithms and auxiliary data structures can be used
39with any graph structures.
40*/
41
42/**
43@defgroup maps Maps
44@ingroup datas
45\brief Some special purpose map to make life easier.
46
47LEMON provides several special maps that e.g. combine
48new maps from existing ones.
49*/
50
51/**
52@defgroup auxdat Auxiliary Data Structures
53@ingroup datas
54\brief Some data structures implemented in LEMON.
55
56This group describes the data structures implemented in LEMON in
57order to make it easier to implement combinatorial algorithms.
58*/
59
60/**
61@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
62@ingroup auxdat
63\brief Tools to Make It Easier to Make Graph Maps.
64
65This group describes the tools that makes it easier to make graph maps that
66dynamically update with the graph changes.
67*/
68
69/**
70@defgroup galgs Graph Algorithms
71\brief This group describes the several graph algorithms
72implemented in LEMON.
73
74This group describes the several graph algorithms
75implemented in LEMON.
76*/
77
78/**
79@defgroup gutils General Graph Utilities
80\brief This group describes some simple general graph utilities.
81@ingroup galgs
82
83This group describes some simple general graph utilities.
84*/
85
86/**
87@defgroup flowalgs Path and Flow Algorithms
88@ingroup galgs
89\brief This group describes the algorithms
90for finding paths and flows in graphs.
91*/
92
93/**
94@defgroup exceptions Exceptions
95This group contains the exceptions thrown by LEMON library
96*/
97
98/**
99@defgroup misc Miscellaneous Tools
100Here you can find several useful tools for development,
101debugging and testing.
102*/
103
104/**
105@defgroup io_group Input Output
106Here you can find tools for imporing and exporting graphs and graph related
107data
108*/
109
110/**
111@defgroup concept Concepts
112\brief Skeleton classes and concept checking classes
113
114This group describes the data/algorithm skeletons and concept checking
115classes implemented in LEMON.
116
117One aim of these classes is to make it easier to check if a certain
118class or template function is correctly implemented.
119
120The other (sometimes even more important) aim is to document the concepts.
121
122*/
123
124/**
125@defgroup graph_concepts Graph Structure Concepts
126@ingroup concept
127\brief Skeleton and concept checking classes for graph structures
128
129This group contains the skeletons and concept checking classes of LEMON's
130graph structures and helper classes used to implement these.
131*/
132
133/**
134@defgroup experimental Experimental Structures and Algorithms
135This group contains some Experimental structures and algorithms.
136The stuff here is subject to change.
137*/
138
Note: See TracBrowser for help on using the repository browser.