[814] | 1 | |
---|
[678] | 2 | /** |
---|
| 3 | @defgroup datas Data Structures |
---|
[921] | 4 | This group describes the several graph structures implemented in LEMON. |
---|
[678] | 5 | */ |
---|
[430] | 6 | |
---|
[678] | 7 | /** |
---|
| 8 | @defgroup graphs Graph Structures |
---|
| 9 | @ingroup datas |
---|
[921] | 10 | \brief Graph structures implemented in LEMON. |
---|
[430] | 11 | |
---|
[1172] | 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. |
---|
[430] | 16 | |
---|
[1172] | 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. |
---|
| 24 | |
---|
| 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 |
---|
[2006] | 28 | not alter the physical graph, but gives another view. If some nodes or |
---|
[1172] | 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 |
---|
[2006] | 31 | the residual graph can be accessed by another algorithm, or a node-set |
---|
| 32 | is to be shrunk for another algorithm. |
---|
[1172] | 33 | LEMON also provides a variety of graphs for these requirements called |
---|
[1401] | 34 | \ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only |
---|
[1172] | 35 | in conjunction with other graph representation. |
---|
[430] | 36 | |
---|
[678] | 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 |
---|
[1172] | 39 | with any graph structures. |
---|
[678] | 40 | */ |
---|
[430] | 41 | |
---|
[678] | 42 | /** |
---|
[1866] | 43 | @defgroup semi_adaptors Semi-Adaptors Classes for Graphs |
---|
| 44 | @ingroup graphs |
---|
| 45 | \brief Graph types between real graphs and graph adaptors. |
---|
| 46 | |
---|
| 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. |
---|
| 50 | */ |
---|
| 51 | |
---|
| 52 | /** |
---|
[1043] | 53 | @defgroup maps Maps |
---|
| 54 | @ingroup datas |
---|
| 55 | \brief Some special purpose map to make life easier. |
---|
| 56 | |
---|
| 57 | LEMON provides several special maps that e.g. combine |
---|
| 58 | new maps from existing ones. |
---|
| 59 | */ |
---|
| 60 | |
---|
[1402] | 61 | /** |
---|
| 62 | @defgroup graph_maps Graph Maps |
---|
| 63 | @ingroup maps |
---|
| 64 | \brief Special Graph-Related Maps. |
---|
| 65 | |
---|
| 66 | These maps are specifically designed to assign values to the nodes and edges of |
---|
| 67 | graphs. |
---|
| 68 | */ |
---|
| 69 | |
---|
| 70 | |
---|
| 71 | /** |
---|
| 72 | \defgroup map_adaptors Map Adaptors |
---|
| 73 | \ingroup maps |
---|
| 74 | \brief Tools to create new maps from existing ones |
---|
| 75 | |
---|
| 76 | Map adaptors are used to create "implicit" maps from other maps. |
---|
| 77 | |
---|
[1536] | 78 | Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can |
---|
[1402] | 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. |
---|
| 82 | */ |
---|
| 83 | |
---|
[1043] | 84 | /** |
---|
[2072] | 85 | @defgroup matrices Matrices |
---|
| 86 | @ingroup datas |
---|
| 87 | \brief Two dimensional data storages. |
---|
| 88 | |
---|
| 89 | Two dimensional |
---|
| 90 | data storages. |
---|
| 91 | */ |
---|
| 92 | |
---|
| 93 | |
---|
| 94 | /** |
---|
[678] | 95 | @defgroup auxdat Auxiliary Data Structures |
---|
| 96 | @ingroup datas |
---|
[921] | 97 | \brief Some data structures implemented in LEMON. |
---|
[406] | 98 | |
---|
[921] | 99 | This group describes the data structures implemented in LEMON in |
---|
[678] | 100 | order to make it easier to implement combinatorial algorithms. |
---|
| 101 | */ |
---|
[406] | 102 | |
---|
[678] | 103 | /** |
---|
[1996] | 104 | @defgroup graphbits Tools to Make It Easier to Make Graphs |
---|
[785] | 105 | @ingroup auxdat |
---|
[1996] | 106 | \brief Tools to Make It Easier to Make Graphs. |
---|
[785] | 107 | |
---|
[1996] | 108 | This group describes the tools that makes it easier to make graphs and |
---|
| 109 | the maps that dynamically update with the graph changes. |
---|
[785] | 110 | */ |
---|
| 111 | |
---|
| 112 | /** |
---|
[678] | 113 | @defgroup galgs Graph Algorithms |
---|
| 114 | \brief This group describes the several graph algorithms |
---|
[921] | 115 | implemented in LEMON. |
---|
[947] | 116 | |
---|
| 117 | This group describes the several graph algorithms |
---|
| 118 | implemented in LEMON. |
---|
| 119 | */ |
---|
| 120 | |
---|
| 121 | /** |
---|
| 122 | @defgroup gutils General Graph Utilities |
---|
[1914] | 123 | @ingroup galgs |
---|
[947] | 124 | \brief This group describes some simple general graph utilities. |
---|
| 125 | |
---|
| 126 | This group describes some simple general graph utilities. |
---|
[678] | 127 | */ |
---|
| 128 | |
---|
| 129 | /** |
---|
[1329] | 130 | @defgroup gen_opt_group General Optimization Tools |
---|
| 131 | \brief This group describes some general optimization frameworks |
---|
| 132 | implemented in LEMON. |
---|
| 133 | |
---|
[2060] | 134 | This group describes some general optimization frameworks |
---|
[1329] | 135 | implemented in LEMON. |
---|
| 136 | |
---|
| 137 | */ |
---|
| 138 | |
---|
| 139 | /** |
---|
[758] | 140 | @defgroup flowalgs Path and Flow Algorithms |
---|
[678] | 141 | @ingroup galgs |
---|
[758] | 142 | \brief This group describes the algorithms |
---|
| 143 | for finding paths and flows in graphs. |
---|
[2060] | 144 | |
---|
| 145 | This group describes the algorithms |
---|
| 146 | for finding paths and flows in graphs. |
---|
| 147 | |
---|
| 148 | \image html flow.png |
---|
| 149 | \image latex flow.eps "Graph flow" width=\textwidth |
---|
[678] | 150 | */ |
---|
| 151 | |
---|
| 152 | /** |
---|
[1750] | 153 | @defgroup topology Topology related algorithms |
---|
| 154 | @ingroup galgs |
---|
| 155 | \brief This group describes the algorithms |
---|
| 156 | for discover the topology of the graphs. |
---|
[2060] | 157 | |
---|
| 158 | This group describes the algorithms |
---|
| 159 | for discover the topology of the graphs. |
---|
| 160 | |
---|
| 161 | \image html edge_biconnected_components.png |
---|
| 162 | \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth |
---|
| 163 | |
---|
[1750] | 164 | */ |
---|
| 165 | |
---|
| 166 | /** |
---|
[2042] | 167 | @defgroup matching Matching algorithms in graphs and bipartite graphs |
---|
| 168 | @ingroup galgs |
---|
| 169 | \brief This group describes the algorithms |
---|
| 170 | for find matchings in graphs and bipartite graphs. |
---|
[2060] | 171 | |
---|
| 172 | This group provides some algorithm objects and function |
---|
| 173 | to calculate matchings in graphs and bipartite graphs. |
---|
| 174 | |
---|
| 175 | \image html bipartite_matching.png |
---|
| 176 | \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth |
---|
| 177 | |
---|
[2042] | 178 | */ |
---|
| 179 | |
---|
| 180 | /** |
---|
[1151] | 181 | @defgroup exceptions Exceptions |
---|
| 182 | This group contains the exceptions thrown by LEMON library |
---|
| 183 | */ |
---|
| 184 | |
---|
| 185 | /** |
---|
[678] | 186 | @defgroup misc Miscellaneous Tools |
---|
| 187 | Here you can find several useful tools for development, |
---|
| 188 | debugging and testing. |
---|
| 189 | */ |
---|
| 190 | |
---|
| 191 | /** |
---|
[1847] | 192 | @defgroup timecount Time measuring and Counting |
---|
| 193 | @ingroup misc |
---|
| 194 | Here you can find simple tools for measuring the performance |
---|
| 195 | of algorithms. |
---|
| 196 | */ |
---|
| 197 | |
---|
| 198 | /** |
---|
[2016] | 199 | @defgroup io_group Input-Output |
---|
[1287] | 200 | Here you can find tools for imporing and exporting graphs and graph related |
---|
| 201 | data |
---|
| 202 | */ |
---|
| 203 | |
---|
| 204 | /** |
---|
[2016] | 205 | @defgroup section_io Section readers and writers |
---|
| 206 | @ingroup io_group |
---|
| 207 | \brief Section readers and writers for lemon Input-Output. |
---|
| 208 | |
---|
| 209 | Here you can find which section readers and writers can attach to |
---|
| 210 | the LemonReader and LemonWriter. |
---|
| 211 | */ |
---|
| 212 | |
---|
| 213 | /** |
---|
| 214 | @defgroup item_io Item Readers and Writers |
---|
| 215 | @ingroup io_group |
---|
| 216 | \brief Item readers and writers for lemon Input-Output. |
---|
| 217 | |
---|
| 218 | The Input-Output classes can handle more data type by example |
---|
| 219 | as map or attribute value. Each of these should be written and |
---|
| 220 | read some way. The module make possible to do this. |
---|
| 221 | */ |
---|
| 222 | |
---|
| 223 | /** |
---|
[1030] | 224 | @defgroup concept Concepts |
---|
[959] | 225 | \brief Skeleton classes and concept checking classes |
---|
[794] | 226 | |
---|
[959] | 227 | This group describes the data/algorithm skeletons and concept checking |
---|
[1030] | 228 | classes implemented in LEMON. |
---|
| 229 | |
---|
| 230 | One aim of these classes is to make it easier to check if a certain |
---|
| 231 | class or template function is correctly implemented. |
---|
| 232 | |
---|
| 233 | The other (sometimes even more important) aim is to document the concepts. |
---|
| 234 | |
---|
[794] | 235 | */ |
---|
| 236 | |
---|
[1030] | 237 | /** |
---|
| 238 | @defgroup graph_concepts Graph Structure Concepts |
---|
| 239 | @ingroup concept |
---|
| 240 | \brief Skeleton and concept checking classes for graph structures |
---|
| 241 | |
---|
| 242 | This group contains the skeletons and concept checking classes of LEMON's |
---|
| 243 | graph structures and helper classes used to implement these. |
---|
| 244 | */ |
---|
[794] | 245 | |
---|
[1587] | 246 | /* --- Unused group |
---|
[678] | 247 | @defgroup experimental Experimental Structures and Algorithms |
---|
| 248 | This group contains some Experimental structures and algorithms. |
---|
| 249 | The stuff here is subject to change. |
---|
| 250 | */ |
---|
[1151] | 251 | |
---|
[1558] | 252 | /** |
---|
[1582] | 253 | \anchor demoprograms |
---|
| 254 | |
---|
[1558] | 255 | @defgroup demos Demo programs |
---|
| 256 | |
---|
[1559] | 257 | Some demo programs are listed here. Their full source codes can be found in |
---|
[1558] | 258 | the \c demo subdirectory of the source tree. |
---|
| 259 | |
---|
[1639] | 260 | The standard compilation procedure (<tt>./configure;make</tt>) will compile |
---|
| 261 | them, as well. |
---|
[1558] | 262 | |
---|
| 263 | */ |
---|
| 264 | |
---|