3 @defgroup datas Data Structures
4 This group describes the several graph structures implemented in LEMON.
8 @defgroup graphs Graph Structures
10 \brief Graph structures implemented in LEMON.
12 The implementation of combinatorial algorithms heavily relies on
13 efficient graph implementations. LEMON offers data structures which are
14 planned to be easily used in an experimental phase of implementation studies,
15 and thereafter the program code can be made efficient by small modifications.
17 The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of
18 graph we require to handle, memory or time usage limitations or in
19 the set of operations through which the graph can be accessed.
20 LEMON provides several physical graph structures to meet the
21 diverging requirements of the possible users.
22 In order to save on running time or on memory usage, some structures may
23 fail to provide some graph features like edge or node deletion.
25 Alteration of standard containers need a very limited number of
26 operations, these together satisfy the everyday requirements.
27 In the case of graph strutures, different operations are needed which do
28 not alter the physical graph, but gives another view. If some nodes or
29 edges have to be hidden or the reverse oriented graph have to be used, then
30 this is the case. It also may happen that in a flow implemenation
31 the residual graph can be accessed by another algorithm, or a node-set
32 is to be shrunk for another algorithm.
33 LEMON also provides a variety of graphs for these requirements called
34 \ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only
35 in conjunction with other graph representation.
37 You are free to use the graph structure that fit your requirements
38 the best, most graph algorithms and auxiliary data structures can be used
39 with any graph structures.
43 @defgroup semi_adaptors Semi-Adaptors Classes for Graphs
45 \brief Graph types between real graphs and graph adaptors.
47 Graph types between real graphs and graph adaptors. These classes
48 wrap graphs to give new functionality as the adaptors do it. But the
49 other way they are not light-weigth structures as the adaptors.
55 \brief Some special purpose map to make life easier.
57 LEMON provides several special maps that e.g. combine
58 new maps from existing ones.
62 @defgroup graph_maps Graph Maps
64 \brief Special Graph-Related Maps.
66 These maps are specifically designed to assign values to the nodes and edges of
72 \defgroup map_adaptors Map Adaptors
74 \brief Tools to create new maps from existing ones
76 Map adaptors are used to create "implicit" maps from other maps.
78 Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
79 make arithmetic oprerations between one or two maps (negation, scalig,
80 addition, multiplication etc.) or e.g. convert a map to another one
81 of different Value type.
85 @defgroup auxdat Auxiliary Data Structures
87 \brief Some data structures implemented in LEMON.
89 This group describes the data structures implemented in LEMON in
90 order to make it easier to implement combinatorial algorithms.
94 @defgroup graphbits Tools to Make It Easier to Make Graphs
96 \brief Tools to Make It Easier to Make Graphs.
98 This group describes the tools that makes it easier to make graphs and
99 the maps that dynamically update with the graph changes.
103 @defgroup galgs Graph Algorithms
104 \brief This group describes the several graph algorithms
105 implemented in LEMON.
107 This group describes the several graph algorithms
108 implemented in LEMON.
112 @defgroup gutils General Graph Utilities
114 \brief This group describes some simple general graph utilities.
116 This group describes some simple general graph utilities.
120 @defgroup gen_opt_group General Optimization Tools
121 \brief This group describes some general optimization frameworks
122 implemented in LEMON.
124 \brief This group describes some general optimization frameworks
125 implemented in LEMON.
130 @defgroup flowalgs Path and Flow Algorithms
132 \brief This group describes the algorithms
133 for finding paths and flows in graphs.
137 @defgroup topology Topology related algorithms
139 \brief This group describes the algorithms
140 for discover the topology of the graphs.
144 @defgroup exceptions Exceptions
145 This group contains the exceptions thrown by LEMON library
149 @defgroup misc Miscellaneous Tools
150 Here you can find several useful tools for development,
151 debugging and testing.
155 @defgroup timecount Time measuring and Counting
157 Here you can find simple tools for measuring the performance
162 @defgroup io_group Input-Output
163 Here you can find tools for imporing and exporting graphs and graph related
168 @defgroup section_io Section readers and writers
170 \brief Section readers and writers for lemon Input-Output.
172 Here you can find which section readers and writers can attach to
173 the LemonReader and LemonWriter.
177 @defgroup item_io Item Readers and Writers
179 \brief Item readers and writers for lemon Input-Output.
181 The Input-Output classes can handle more data type by example
182 as map or attribute value. Each of these should be written and
183 read some way. The module make possible to do this.
187 @defgroup concept Concepts
188 \brief Skeleton classes and concept checking classes
190 This group describes the data/algorithm skeletons and concept checking
191 classes implemented in LEMON.
193 One aim of these classes is to make it easier to check if a certain
194 class or template function is correctly implemented.
196 The other (sometimes even more important) aim is to document the concepts.
201 @defgroup graph_concepts Graph Structure Concepts
203 \brief Skeleton and concept checking classes for graph structures
205 This group contains the skeletons and concept checking classes of LEMON's
206 graph structures and helper classes used to implement these.
210 @defgroup experimental Experimental Structures and Algorithms
211 This group contains some Experimental structures and algorithms.
212 The stuff here is subject to change.
218 @defgroup demos Demo programs
220 Some demo programs are listed here. Their full source codes can be found in
221 the \c demo subdirectory of the source tree.
223 The standard compilation procedure (<tt>./configure;make</tt>) will compile