1 | |
---|
2 | /** |
---|
3 | @defgroup datas Data Structures |
---|
4 | This 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 | |
---|
12 | LEMON provides several data structures to meet the diverging requirements |
---|
13 | of the possible users. |
---|
14 | In order to save on running time or on memory usage, some structures may |
---|
15 | fail to provide |
---|
16 | some graph features like edge or node deletion. |
---|
17 | |
---|
18 | LEMON also offers special graphs that cannot be used alone but only |
---|
19 | in conjunction with other graph representation. The examples for this are |
---|
20 | \ref lemon::EdgeSet "EdgeSet", \ref lemon::NodeSet "NodeSet" |
---|
21 | and the large variety of \ref gwrappers "graph wrappers". |
---|
22 | |
---|
23 | You are free to use the graph structure that fit your requirements |
---|
24 | the best, most graph algorithms and auxiliary data structures can be used |
---|
25 | with any graph structures. |
---|
26 | */ |
---|
27 | |
---|
28 | /** |
---|
29 | @defgroup maps Maps |
---|
30 | @ingroup datas |
---|
31 | \brief Some special purpose map to make life easier. |
---|
32 | |
---|
33 | LEMON provides several special maps that e.g. combine |
---|
34 | new 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 | |
---|
42 | This group describes the data structures implemented in LEMON in |
---|
43 | order 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 | |
---|
51 | This group describes the tools that makes it easier to make graph maps that |
---|
52 | dynamically 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 |
---|
64 | implemented in LEMON. |
---|
65 | |
---|
66 | This group describes the several graph algorithms |
---|
67 | implemented 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 | |
---|
75 | This 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 |
---|
82 | for finding paths and flows in graphs. |
---|
83 | */ |
---|
84 | |
---|
85 | /** |
---|
86 | @defgroup exceptions Exceptions |
---|
87 | This group contains the exceptions thrown by LEMON library |
---|
88 | */ |
---|
89 | |
---|
90 | /** |
---|
91 | @defgroup misc Miscellaneous Tools |
---|
92 | Here you can find several useful tools for development, |
---|
93 | debugging and testing. |
---|
94 | */ |
---|
95 | |
---|
96 | /** |
---|
97 | @defgroup concept Concepts |
---|
98 | \brief Skeleton classes and concept checking classes |
---|
99 | |
---|
100 | This group describes the data/algorithm skeletons and concept checking |
---|
101 | classes implemented in LEMON. |
---|
102 | |
---|
103 | One aim of these classes is to make it easier to check if a certain |
---|
104 | class or template function is correctly implemented. |
---|
105 | |
---|
106 | The other (sometimes even more important) aim is to document the concepts. |
---|
107 | |
---|
108 | */ |
---|
109 | |
---|
110 | /** |
---|
111 | @defgroup graph_concepts Graph Structure Concepts |
---|
112 | @ingroup concept |
---|
113 | \brief Skeleton and concept checking classes for graph structures |
---|
114 | |
---|
115 | This group contains the skeletons and concept checking classes of LEMON's |
---|
116 | graph structures and helper classes used to implement these. |
---|
117 | */ |
---|
118 | |
---|
119 | /** |
---|
120 | @defgroup experimental Experimental Structures and Algorithms |
---|
121 | This group contains some Experimental structures and algorithms. |
---|
122 | The stuff here is subject to change. |
---|
123 | */ |
---|
124 | |
---|