[209] | 1 | /* -*- mode: C++; indent-tabs-mode: nil; -*- |
---|
[40] | 2 | * |
---|
[209] | 3 | * This file is a part of LEMON, a generic C++ optimization library. |
---|
[40] | 4 | * |
---|
[440] | 5 | * Copyright (C) 2003-2009 |
---|
[40] | 6 | * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
| 7 | * (Egervary Research Group on Combinatorial Optimization, EGRES). |
---|
| 8 | * |
---|
| 9 | * Permission to use, modify and distribute this software is granted |
---|
| 10 | * provided that this copyright notice appears in all copies. For |
---|
| 11 | * precise terms see the accompanying LICENSE file. |
---|
| 12 | * |
---|
| 13 | * This software is provided "AS IS" with no warranty of any kind, |
---|
| 14 | * express or implied, and with no claim as to its suitability for any |
---|
| 15 | * purpose. |
---|
| 16 | * |
---|
| 17 | */ |
---|
| 18 | |
---|
[406] | 19 | namespace lemon { |
---|
| 20 | |
---|
[40] | 21 | /** |
---|
| 22 | @defgroup datas Data Structures |
---|
[559] | 23 | This group contains the several data structures implemented in LEMON. |
---|
[40] | 24 | */ |
---|
| 25 | |
---|
| 26 | /** |
---|
| 27 | @defgroup graphs Graph Structures |
---|
| 28 | @ingroup datas |
---|
| 29 | \brief Graph structures implemented in LEMON. |
---|
| 30 | |
---|
[209] | 31 | The implementation of combinatorial algorithms heavily relies on |
---|
| 32 | efficient graph implementations. LEMON offers data structures which are |
---|
| 33 | planned to be easily used in an experimental phase of implementation studies, |
---|
| 34 | and thereafter the program code can be made efficient by small modifications. |
---|
[40] | 35 | |
---|
| 36 | The most efficient implementation of diverse applications require the |
---|
| 37 | usage of different physical graph implementations. These differences |
---|
| 38 | appear in the size of graph we require to handle, memory or time usage |
---|
| 39 | limitations or in the set of operations through which the graph can be |
---|
| 40 | accessed. LEMON provides several physical graph structures to meet |
---|
| 41 | the diverging requirements of the possible users. In order to save on |
---|
| 42 | running time or on memory usage, some structures may fail to provide |
---|
[83] | 43 | some graph features like arc/edge or node deletion. |
---|
[40] | 44 | |
---|
[209] | 45 | Alteration of standard containers need a very limited number of |
---|
| 46 | operations, these together satisfy the everyday requirements. |
---|
| 47 | In the case of graph structures, different operations are needed which do |
---|
| 48 | not alter the physical graph, but gives another view. If some nodes or |
---|
[83] | 49 | arcs have to be hidden or the reverse oriented graph have to be used, then |
---|
[209] | 50 | this is the case. It also may happen that in a flow implementation |
---|
| 51 | the residual graph can be accessed by another algorithm, or a node-set |
---|
| 52 | is to be shrunk for another algorithm. |
---|
| 53 | LEMON also provides a variety of graphs for these requirements called |
---|
| 54 | \ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only |
---|
| 55 | in conjunction with other graph representations. |
---|
[40] | 56 | |
---|
| 57 | You are free to use the graph structure that fit your requirements |
---|
| 58 | the best, most graph algorithms and auxiliary data structures can be used |
---|
[314] | 59 | with any graph structure. |
---|
| 60 | |
---|
| 61 | <b>See also:</b> \ref graph_concepts "Graph Structure Concepts". |
---|
[40] | 62 | */ |
---|
| 63 | |
---|
| 64 | /** |
---|
[451] | 65 | @defgroup graph_adaptors Adaptor Classes for Graphs |
---|
[416] | 66 | @ingroup graphs |
---|
[451] | 67 | \brief Adaptor classes for digraphs and graphs |
---|
| 68 | |
---|
| 69 | This group contains several useful adaptor classes for digraphs and graphs. |
---|
[416] | 70 | |
---|
| 71 | The main parts of LEMON are the different graph structures, generic |
---|
[451] | 72 | graph algorithms, graph concepts, which couple them, and graph |
---|
[416] | 73 | adaptors. While the previous notions are more or less clear, the |
---|
| 74 | latter one needs further explanation. Graph adaptors are graph classes |
---|
| 75 | which serve for considering graph structures in different ways. |
---|
| 76 | |
---|
| 77 | A short example makes this much clearer. Suppose that we have an |
---|
[451] | 78 | instance \c g of a directed graph type, say ListDigraph and an algorithm |
---|
[416] | 79 | \code |
---|
| 80 | template <typename Digraph> |
---|
| 81 | int algorithm(const Digraph&); |
---|
| 82 | \endcode |
---|
| 83 | is needed to run on the reverse oriented graph. It may be expensive |
---|
| 84 | (in time or in memory usage) to copy \c g with the reversed |
---|
| 85 | arcs. In this case, an adaptor class is used, which (according |
---|
[451] | 86 | to LEMON \ref concepts::Digraph "digraph concepts") works as a digraph. |
---|
| 87 | The adaptor uses the original digraph structure and digraph operations when |
---|
| 88 | methods of the reversed oriented graph are called. This means that the adaptor |
---|
| 89 | have minor memory usage, and do not perform sophisticated algorithmic |
---|
[416] | 90 | actions. The purpose of it is to give a tool for the cases when a |
---|
| 91 | graph have to be used in a specific alteration. If this alteration is |
---|
[451] | 92 | obtained by a usual construction like filtering the node or the arc set or |
---|
[416] | 93 | considering a new orientation, then an adaptor is worthwhile to use. |
---|
| 94 | To come back to the reverse oriented graph, in this situation |
---|
| 95 | \code |
---|
| 96 | template<typename Digraph> class ReverseDigraph; |
---|
| 97 | \endcode |
---|
| 98 | template class can be used. The code looks as follows |
---|
| 99 | \code |
---|
| 100 | ListDigraph g; |
---|
[451] | 101 | ReverseDigraph<ListDigraph> rg(g); |
---|
[416] | 102 | int result = algorithm(rg); |
---|
| 103 | \endcode |
---|
[451] | 104 | During running the algorithm, the original digraph \c g is untouched. |
---|
| 105 | This techniques give rise to an elegant code, and based on stable |
---|
[416] | 106 | graph adaptors, complex algorithms can be implemented easily. |
---|
| 107 | |
---|
[451] | 108 | In flow, circulation and matching problems, the residual |
---|
[416] | 109 | graph is of particular importance. Combining an adaptor implementing |
---|
[451] | 110 | this with shortest path algorithms or minimum mean cycle algorithms, |
---|
[416] | 111 | a range of weighted and cardinality optimization algorithms can be |
---|
| 112 | obtained. For other examples, the interested user is referred to the |
---|
| 113 | detailed documentation of particular adaptors. |
---|
| 114 | |
---|
| 115 | The behavior of graph adaptors can be very different. Some of them keep |
---|
| 116 | capabilities of the original graph while in other cases this would be |
---|
[451] | 117 | meaningless. This means that the concepts that they meet depend |
---|
| 118 | on the graph adaptor, and the wrapped graph. |
---|
| 119 | For example, if an arc of a reversed digraph is deleted, this is carried |
---|
| 120 | out by deleting the corresponding arc of the original digraph, thus the |
---|
| 121 | adaptor modifies the original digraph. |
---|
| 122 | However in case of a residual digraph, this operation has no sense. |
---|
[416] | 123 | |
---|
| 124 | Let us stand one more example here to simplify your work. |
---|
[451] | 125 | ReverseDigraph has constructor |
---|
[416] | 126 | \code |
---|
| 127 | ReverseDigraph(Digraph& digraph); |
---|
| 128 | \endcode |
---|
[451] | 129 | This means that in a situation, when a <tt>const %ListDigraph&</tt> |
---|
[416] | 130 | reference to a graph is given, then it have to be instantiated with |
---|
[451] | 131 | <tt>Digraph=const %ListDigraph</tt>. |
---|
[416] | 132 | \code |
---|
| 133 | int algorithm1(const ListDigraph& g) { |
---|
[451] | 134 | ReverseDigraph<const ListDigraph> rg(g); |
---|
[416] | 135 | return algorithm2(rg); |
---|
| 136 | } |
---|
| 137 | \endcode |
---|
| 138 | */ |
---|
| 139 | |
---|
| 140 | /** |
---|
[209] | 141 | @defgroup maps Maps |
---|
[40] | 142 | @ingroup datas |
---|
[50] | 143 | \brief Map structures implemented in LEMON. |
---|
[40] | 144 | |
---|
[559] | 145 | This group contains the map structures implemented in LEMON. |
---|
[50] | 146 | |
---|
[314] | 147 | LEMON provides several special purpose maps and map adaptors that e.g. combine |
---|
[40] | 148 | new maps from existing ones. |
---|
[314] | 149 | |
---|
| 150 | <b>See also:</b> \ref map_concepts "Map Concepts". |
---|
[40] | 151 | */ |
---|
| 152 | |
---|
| 153 | /** |
---|
[209] | 154 | @defgroup graph_maps Graph Maps |
---|
[40] | 155 | @ingroup maps |
---|
[83] | 156 | \brief Special graph-related maps. |
---|
[40] | 157 | |
---|
[559] | 158 | This group contains maps that are specifically designed to assign |
---|
[406] | 159 | values to the nodes and arcs/edges of graphs. |
---|
| 160 | |
---|
| 161 | If you are looking for the standard graph maps (\c NodeMap, \c ArcMap, |
---|
| 162 | \c EdgeMap), see the \ref graph_concepts "Graph Structure Concepts". |
---|
[40] | 163 | */ |
---|
| 164 | |
---|
| 165 | /** |
---|
| 166 | \defgroup map_adaptors Map Adaptors |
---|
| 167 | \ingroup maps |
---|
| 168 | \brief Tools to create new maps from existing ones |
---|
| 169 | |
---|
[559] | 170 | This group contains map adaptors that are used to create "implicit" |
---|
[50] | 171 | maps from other maps. |
---|
[40] | 172 | |
---|
[406] | 173 | Most of them are \ref concepts::ReadMap "read-only maps". |
---|
[83] | 174 | They can make arithmetic and logical operations between one or two maps |
---|
| 175 | (negation, shifting, addition, multiplication, logical 'and', 'or', |
---|
| 176 | 'not' etc.) or e.g. convert a map to another one of different Value type. |
---|
[40] | 177 | |
---|
[50] | 178 | The typical usage of this classes is passing implicit maps to |
---|
[40] | 179 | algorithms. If a function type algorithm is called then the function |
---|
| 180 | type map adaptors can be used comfortable. For example let's see the |
---|
[314] | 181 | usage of map adaptors with the \c graphToEps() function. |
---|
[40] | 182 | \code |
---|
| 183 | Color nodeColor(int deg) { |
---|
| 184 | if (deg >= 2) { |
---|
| 185 | return Color(0.5, 0.0, 0.5); |
---|
| 186 | } else if (deg == 1) { |
---|
| 187 | return Color(1.0, 0.5, 1.0); |
---|
| 188 | } else { |
---|
| 189 | return Color(0.0, 0.0, 0.0); |
---|
| 190 | } |
---|
| 191 | } |
---|
[209] | 192 | |
---|
[83] | 193 | Digraph::NodeMap<int> degree_map(graph); |
---|
[209] | 194 | |
---|
[314] | 195 | graphToEps(graph, "graph.eps") |
---|
[40] | 196 | .coords(coords).scaleToA4().undirected() |
---|
[83] | 197 | .nodeColors(composeMap(functorToMap(nodeColor), degree_map)) |
---|
[40] | 198 | .run(); |
---|
[209] | 199 | \endcode |
---|
[83] | 200 | The \c functorToMap() function makes an \c int to \c Color map from the |
---|
[314] | 201 | \c nodeColor() function. The \c composeMap() compose the \c degree_map |
---|
[83] | 202 | and the previously created map. The composed map is a proper function to |
---|
| 203 | get the color of each node. |
---|
[40] | 204 | |
---|
| 205 | The usage with class type algorithms is little bit harder. In this |
---|
| 206 | case the function type map adaptors can not be used, because the |
---|
[50] | 207 | function map adaptors give back temporary objects. |
---|
[40] | 208 | \code |
---|
[83] | 209 | Digraph graph; |
---|
| 210 | |
---|
| 211 | typedef Digraph::ArcMap<double> DoubleArcMap; |
---|
| 212 | DoubleArcMap length(graph); |
---|
| 213 | DoubleArcMap speed(graph); |
---|
| 214 | |
---|
| 215 | typedef DivMap<DoubleArcMap, DoubleArcMap> TimeMap; |
---|
[40] | 216 | TimeMap time(length, speed); |
---|
[209] | 217 | |
---|
[83] | 218 | Dijkstra<Digraph, TimeMap> dijkstra(graph, time); |
---|
[40] | 219 | dijkstra.run(source, target); |
---|
| 220 | \endcode |
---|
[83] | 221 | We have a length map and a maximum speed map on the arcs of a digraph. |
---|
| 222 | The minimum time to pass the arc can be calculated as the division of |
---|
| 223 | the two maps which can be done implicitly with the \c DivMap template |
---|
[40] | 224 | class. We use the implicit minimum time map as the length map of the |
---|
| 225 | \c Dijkstra algorithm. |
---|
| 226 | */ |
---|
| 227 | |
---|
| 228 | /** |
---|
| 229 | @defgroup paths Path Structures |
---|
| 230 | @ingroup datas |
---|
[318] | 231 | \brief %Path structures implemented in LEMON. |
---|
[40] | 232 | |
---|
[559] | 233 | This group contains the path structures implemented in LEMON. |
---|
[40] | 234 | |
---|
[50] | 235 | LEMON provides flexible data structures to work with paths. |
---|
| 236 | All of them have similar interfaces and they can be copied easily with |
---|
| 237 | assignment operators and copy constructors. This makes it easy and |
---|
[40] | 238 | efficient to have e.g. the Dijkstra algorithm to store its result in |
---|
| 239 | any kind of path structure. |
---|
| 240 | |
---|
[710] | 241 | \sa \ref concepts::Path "Path concept" |
---|
| 242 | */ |
---|
| 243 | |
---|
| 244 | /** |
---|
| 245 | @defgroup heaps Heap Structures |
---|
| 246 | @ingroup datas |
---|
| 247 | \brief %Heap structures implemented in LEMON. |
---|
| 248 | |
---|
| 249 | This group contains the heap structures implemented in LEMON. |
---|
| 250 | |
---|
| 251 | LEMON provides several heap classes. They are efficient implementations |
---|
| 252 | of the abstract data type \e priority \e queue. They store items with |
---|
| 253 | specified values called \e priorities in such a way that finding and |
---|
| 254 | removing the item with minimum priority are efficient. |
---|
| 255 | The basic operations are adding and erasing items, changing the priority |
---|
| 256 | of an item, etc. |
---|
| 257 | |
---|
| 258 | Heaps are crucial in several algorithms, such as Dijkstra and Prim. |
---|
| 259 | The heap implementations have the same interface, thus any of them can be |
---|
| 260 | used easily in such algorithms. |
---|
| 261 | |
---|
| 262 | \sa \ref concepts::Heap "Heap concept" |
---|
| 263 | */ |
---|
| 264 | |
---|
| 265 | /** |
---|
| 266 | @defgroup matrices Matrices |
---|
| 267 | @ingroup datas |
---|
| 268 | \brief Two dimensional data storages implemented in LEMON. |
---|
| 269 | |
---|
| 270 | This group contains two dimensional data storages implemented in LEMON. |
---|
[40] | 271 | */ |
---|
| 272 | |
---|
| 273 | /** |
---|
| 274 | @defgroup auxdat Auxiliary Data Structures |
---|
| 275 | @ingroup datas |
---|
[50] | 276 | \brief Auxiliary data structures implemented in LEMON. |
---|
[40] | 277 | |
---|
[559] | 278 | This group contains some data structures implemented in LEMON in |
---|
[40] | 279 | order to make it easier to implement combinatorial algorithms. |
---|
| 280 | */ |
---|
| 281 | |
---|
| 282 | /** |
---|
[714] | 283 | @defgroup geomdat Geometric Data Structures |
---|
| 284 | @ingroup auxdat |
---|
| 285 | \brief Geometric data structures implemented in LEMON. |
---|
| 286 | |
---|
| 287 | This group contains geometric data structures implemented in LEMON. |
---|
| 288 | |
---|
| 289 | - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional |
---|
| 290 | vector with the usual operations. |
---|
| 291 | - \ref lemon::dim2::Box "dim2::Box" can be used to determine the |
---|
| 292 | rectangular bounding box of a set of \ref lemon::dim2::Point |
---|
| 293 | "dim2::Point"'s. |
---|
| 294 | */ |
---|
| 295 | |
---|
| 296 | /** |
---|
| 297 | @defgroup matrices Matrices |
---|
| 298 | @ingroup auxdat |
---|
| 299 | \brief Two dimensional data storages implemented in LEMON. |
---|
| 300 | |
---|
| 301 | This group contains two dimensional data storages implemented in LEMON. |
---|
| 302 | */ |
---|
| 303 | |
---|
| 304 | /** |
---|
[40] | 305 | @defgroup algs Algorithms |
---|
[559] | 306 | \brief This group contains the several algorithms |
---|
[40] | 307 | implemented in LEMON. |
---|
| 308 | |
---|
[559] | 309 | This group contains the several algorithms |
---|
[40] | 310 | implemented in LEMON. |
---|
| 311 | */ |
---|
| 312 | |
---|
| 313 | /** |
---|
| 314 | @defgroup search Graph Search |
---|
| 315 | @ingroup algs |
---|
[50] | 316 | \brief Common graph search algorithms. |
---|
[40] | 317 | |
---|
[559] | 318 | This group contains the common graph search algorithms, namely |
---|
[755] | 319 | \e breadth-first \e search (BFS) and \e depth-first \e search (DFS) |
---|
| 320 | \ref clrs01algorithms. |
---|
[40] | 321 | */ |
---|
| 322 | |
---|
| 323 | /** |
---|
[314] | 324 | @defgroup shortest_path Shortest Path Algorithms |
---|
[40] | 325 | @ingroup algs |
---|
[50] | 326 | \brief Algorithms for finding shortest paths. |
---|
[40] | 327 | |
---|
[755] | 328 | This group contains the algorithms for finding shortest paths in digraphs |
---|
| 329 | \ref clrs01algorithms. |
---|
[406] | 330 | |
---|
| 331 | - \ref Dijkstra algorithm for finding shortest paths from a source node |
---|
| 332 | when all arc lengths are non-negative. |
---|
| 333 | - \ref BellmanFord "Bellman-Ford" algorithm for finding shortest paths |
---|
| 334 | from a source node when arc lenghts can be either positive or negative, |
---|
| 335 | but the digraph should not contain directed cycles with negative total |
---|
| 336 | length. |
---|
| 337 | - \ref FloydWarshall "Floyd-Warshall" and \ref Johnson "Johnson" algorithms |
---|
| 338 | for solving the \e all-pairs \e shortest \e paths \e problem when arc |
---|
| 339 | lenghts can be either positive or negative, but the digraph should |
---|
| 340 | not contain directed cycles with negative total length. |
---|
| 341 | - \ref Suurballe A successive shortest path algorithm for finding |
---|
| 342 | arc-disjoint paths between two nodes having minimum total length. |
---|
[40] | 343 | */ |
---|
| 344 | |
---|
[209] | 345 | /** |
---|
[714] | 346 | @defgroup spantree Minimum Spanning Tree Algorithms |
---|
| 347 | @ingroup algs |
---|
| 348 | \brief Algorithms for finding minimum cost spanning trees and arborescences. |
---|
| 349 | |
---|
| 350 | This group contains the algorithms for finding minimum cost spanning |
---|
[755] | 351 | trees and arborescences \ref clrs01algorithms. |
---|
[714] | 352 | */ |
---|
| 353 | |
---|
| 354 | /** |
---|
[314] | 355 | @defgroup max_flow Maximum Flow Algorithms |
---|
[209] | 356 | @ingroup algs |
---|
[50] | 357 | \brief Algorithms for finding maximum flows. |
---|
[40] | 358 | |
---|
[559] | 359 | This group contains the algorithms for finding maximum flows and |
---|
[755] | 360 | feasible circulations \ref clrs01algorithms, \ref amo93networkflows. |
---|
[40] | 361 | |
---|
[406] | 362 | The \e maximum \e flow \e problem is to find a flow of maximum value between |
---|
| 363 | a single source and a single target. Formally, there is a \f$G=(V,A)\f$ |
---|
[609] | 364 | digraph, a \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function and |
---|
[406] | 365 | \f$s, t \in V\f$ source and target nodes. |
---|
[609] | 366 | A maximum flow is an \f$f: A\rightarrow\mathbf{R}^+_0\f$ solution of the |
---|
[406] | 367 | following optimization problem. |
---|
[40] | 368 | |
---|
[609] | 369 | \f[ \max\sum_{sv\in A} f(sv) - \sum_{vs\in A} f(vs) \f] |
---|
| 370 | \f[ \sum_{uv\in A} f(uv) = \sum_{vu\in A} f(vu) |
---|
| 371 | \quad \forall u\in V\setminus\{s,t\} \f] |
---|
| 372 | \f[ 0 \leq f(uv) \leq cap(uv) \quad \forall uv\in A \f] |
---|
[40] | 373 | |
---|
[50] | 374 | LEMON contains several algorithms for solving maximum flow problems: |
---|
[755] | 375 | - \ref EdmondsKarp Edmonds-Karp algorithm |
---|
| 376 | \ref edmondskarp72theoretical. |
---|
| 377 | - \ref Preflow Goldberg-Tarjan's preflow push-relabel algorithm |
---|
| 378 | \ref goldberg88newapproach. |
---|
| 379 | - \ref DinitzSleatorTarjan Dinitz's blocking flow algorithm with dynamic trees |
---|
| 380 | \ref dinic70algorithm, \ref sleator83dynamic. |
---|
| 381 | - \ref GoldbergTarjan !Preflow push-relabel algorithm with dynamic trees |
---|
| 382 | \ref goldberg88newapproach, \ref sleator83dynamic. |
---|
[40] | 383 | |
---|
[755] | 384 | In most cases the \ref Preflow algorithm provides the |
---|
[406] | 385 | fastest method for computing a maximum flow. All implementations |
---|
[651] | 386 | also provide functions to query the minimum cut, which is the dual |
---|
| 387 | problem of maximum flow. |
---|
| 388 | |
---|
| 389 | \ref Circulation is a preflow push-relabel algorithm implemented directly |
---|
| 390 | for finding feasible circulations, which is a somewhat different problem, |
---|
| 391 | but it is strongly related to maximum flow. |
---|
| 392 | For more information, see \ref Circulation. |
---|
[40] | 393 | */ |
---|
| 394 | |
---|
| 395 | /** |
---|
[663] | 396 | @defgroup min_cost_flow_algs Minimum Cost Flow Algorithms |
---|
[40] | 397 | @ingroup algs |
---|
| 398 | |
---|
[50] | 399 | \brief Algorithms for finding minimum cost flows and circulations. |
---|
[40] | 400 | |
---|
[609] | 401 | This group contains the algorithms for finding minimum cost flows and |
---|
[755] | 402 | circulations \ref amo93networkflows. For more information about this |
---|
| 403 | problem and its dual solution, see \ref min_cost_flow |
---|
| 404 | "Minimum Cost Flow Problem". |
---|
[406] | 405 | |
---|
[663] | 406 | LEMON contains several algorithms for this problem. |
---|
[609] | 407 | - \ref NetworkSimplex Primal Network Simplex algorithm with various |
---|
[755] | 408 | pivot strategies \ref dantzig63linearprog, \ref kellyoneill91netsimplex. |
---|
[609] | 409 | - \ref CostScaling Push-Relabel and Augment-Relabel algorithms based on |
---|
[755] | 410 | cost scaling \ref goldberg90approximation, \ref goldberg97efficient, |
---|
| 411 | \ref bunnagel98efficient. |
---|
[609] | 412 | - \ref CapacityScaling Successive Shortest %Path algorithm with optional |
---|
[755] | 413 | capacity scaling \ref edmondskarp72theoretical. |
---|
| 414 | - \ref CancelAndTighten The Cancel and Tighten algorithm |
---|
| 415 | \ref goldberg89cyclecanceling. |
---|
| 416 | - \ref CycleCanceling Cycle-Canceling algorithms |
---|
| 417 | \ref klein67primal, \ref goldberg89cyclecanceling. |
---|
[609] | 418 | |
---|
| 419 | In general NetworkSimplex is the most efficient implementation, |
---|
| 420 | but in special cases other algorithms could be faster. |
---|
| 421 | For example, if the total supply and/or capacities are rather small, |
---|
| 422 | CapacityScaling is usually the fastest algorithm (without effective scaling). |
---|
[40] | 423 | */ |
---|
| 424 | |
---|
| 425 | /** |
---|
[314] | 426 | @defgroup min_cut Minimum Cut Algorithms |
---|
[209] | 427 | @ingroup algs |
---|
[40] | 428 | |
---|
[50] | 429 | \brief Algorithms for finding minimum cut in graphs. |
---|
[40] | 430 | |
---|
[559] | 431 | This group contains the algorithms for finding minimum cut in graphs. |
---|
[40] | 432 | |
---|
[406] | 433 | The \e minimum \e cut \e problem is to find a non-empty and non-complete |
---|
| 434 | \f$X\f$ subset of the nodes with minimum overall capacity on |
---|
| 435 | outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a |
---|
| 436 | \f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum |
---|
[50] | 437 | cut is the \f$X\f$ solution of the next optimization problem: |
---|
[40] | 438 | |
---|
[210] | 439 | \f[ \min_{X \subset V, X\not\in \{\emptyset, V\}} |
---|
[713] | 440 | \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f] |
---|
[40] | 441 | |
---|
[50] | 442 | LEMON contains several algorithms related to minimum cut problems: |
---|
[40] | 443 | |
---|
[406] | 444 | - \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut |
---|
| 445 | in directed graphs. |
---|
| 446 | - \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for |
---|
| 447 | calculating minimum cut in undirected graphs. |
---|
[559] | 448 | - \ref GomoryHu "Gomory-Hu tree computation" for calculating |
---|
[406] | 449 | all-pairs minimum cut in undirected graphs. |
---|
[40] | 450 | |
---|
| 451 | If you want to find minimum cut just between two distinict nodes, |
---|
[406] | 452 | see the \ref max_flow "maximum flow problem". |
---|
[40] | 453 | */ |
---|
| 454 | |
---|
| 455 | /** |
---|
[314] | 456 | @defgroup matching Matching Algorithms |
---|
[40] | 457 | @ingroup algs |
---|
[50] | 458 | \brief Algorithms for finding matchings in graphs and bipartite graphs. |
---|
[40] | 459 | |
---|
[590] | 460 | This group contains the algorithms for calculating |
---|
[40] | 461 | matchings in graphs and bipartite graphs. The general matching problem is |
---|
[590] | 462 | finding a subset of the edges for which each node has at most one incident |
---|
| 463 | edge. |
---|
[209] | 464 | |
---|
[40] | 465 | There are several different algorithms for calculate matchings in |
---|
| 466 | graphs. The matching problems in bipartite graphs are generally |
---|
| 467 | easier than in general graphs. The goal of the matching optimization |
---|
[406] | 468 | can be finding maximum cardinality, maximum weight or minimum cost |
---|
[40] | 469 | matching. The search can be constrained to find perfect or |
---|
| 470 | maximum cardinality matching. |
---|
| 471 | |
---|
[406] | 472 | The matching algorithms implemented in LEMON: |
---|
| 473 | - \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm |
---|
| 474 | for calculating maximum cardinality matching in bipartite graphs. |
---|
| 475 | - \ref PrBipartiteMatching Push-relabel algorithm |
---|
| 476 | for calculating maximum cardinality matching in bipartite graphs. |
---|
| 477 | - \ref MaxWeightedBipartiteMatching |
---|
| 478 | Successive shortest path algorithm for calculating maximum weighted |
---|
| 479 | matching and maximum weighted bipartite matching in bipartite graphs. |
---|
| 480 | - \ref MinCostMaxBipartiteMatching |
---|
| 481 | Successive shortest path algorithm for calculating minimum cost maximum |
---|
| 482 | matching in bipartite graphs. |
---|
| 483 | - \ref MaxMatching Edmond's blossom shrinking algorithm for calculating |
---|
| 484 | maximum cardinality matching in general graphs. |
---|
| 485 | - \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating |
---|
| 486 | maximum weighted matching in general graphs. |
---|
| 487 | - \ref MaxWeightedPerfectMatching |
---|
| 488 | Edmond's blossom shrinking algorithm for calculating maximum weighted |
---|
| 489 | perfect matching in general graphs. |
---|
[40] | 490 | |
---|
| 491 | \image html bipartite_matching.png |
---|
| 492 | \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth |
---|
| 493 | */ |
---|
| 494 | |
---|
| 495 | /** |
---|
[714] | 496 | @defgroup graph_properties Connectivity and Other Graph Properties |
---|
[40] | 497 | @ingroup algs |
---|
[714] | 498 | \brief Algorithms for discovering the graph properties |
---|
[40] | 499 | |
---|
[714] | 500 | This group contains the algorithms for discovering the graph properties |
---|
| 501 | like connectivity, bipartiteness, euler property, simplicity etc. |
---|
| 502 | |
---|
| 503 | \image html connected_components.png |
---|
| 504 | \image latex connected_components.eps "Connected components" width=\textwidth |
---|
| 505 | */ |
---|
| 506 | |
---|
| 507 | /** |
---|
| 508 | @defgroup planar Planarity Embedding and Drawing |
---|
| 509 | @ingroup algs |
---|
| 510 | \brief Algorithms for planarity checking, embedding and drawing |
---|
| 511 | |
---|
| 512 | This group contains the algorithms for planarity checking, |
---|
| 513 | embedding and drawing. |
---|
| 514 | |
---|
| 515 | \image html planar.png |
---|
| 516 | \image latex planar.eps "Plane graph" width=\textwidth |
---|
| 517 | */ |
---|
| 518 | |
---|
| 519 | /** |
---|
| 520 | @defgroup approx Approximation Algorithms |
---|
| 521 | @ingroup algs |
---|
| 522 | \brief Approximation algorithms. |
---|
| 523 | |
---|
| 524 | This group contains the approximation and heuristic algorithms |
---|
| 525 | implemented in LEMON. |
---|
[40] | 526 | */ |
---|
| 527 | |
---|
| 528 | /** |
---|
[314] | 529 | @defgroup auxalg Auxiliary Algorithms |
---|
[40] | 530 | @ingroup algs |
---|
[50] | 531 | \brief Auxiliary algorithms implemented in LEMON. |
---|
[40] | 532 | |
---|
[559] | 533 | This group contains some algorithms implemented in LEMON |
---|
[50] | 534 | in order to make it easier to implement complex algorithms. |
---|
[40] | 535 | */ |
---|
| 536 | |
---|
| 537 | /** |
---|
| 538 | @defgroup gen_opt_group General Optimization Tools |
---|
[559] | 539 | \brief This group contains some general optimization frameworks |
---|
[40] | 540 | implemented in LEMON. |
---|
| 541 | |
---|
[559] | 542 | This group contains some general optimization frameworks |
---|
[40] | 543 | implemented in LEMON. |
---|
| 544 | */ |
---|
| 545 | |
---|
| 546 | /** |
---|
[755] | 547 | @defgroup lp_group LP and MIP Solvers |
---|
[40] | 548 | @ingroup gen_opt_group |
---|
[755] | 549 | \brief LP and MIP solver interfaces for LEMON. |
---|
[40] | 550 | |
---|
[755] | 551 | This group contains LP and MIP solver interfaces for LEMON. |
---|
| 552 | Various LP solvers could be used in the same manner with this |
---|
| 553 | high-level interface. |
---|
| 554 | |
---|
| 555 | The currently supported solvers are \ref glpk, \ref clp, \ref cbc, |
---|
| 556 | \ref cplex, \ref soplex. |
---|
[40] | 557 | */ |
---|
| 558 | |
---|
[209] | 559 | /** |
---|
[314] | 560 | @defgroup lp_utils Tools for Lp and Mip Solvers |
---|
[40] | 561 | @ingroup lp_group |
---|
[50] | 562 | \brief Helper tools to the Lp and Mip solvers. |
---|
[40] | 563 | |
---|
| 564 | This group adds some helper tools to general optimization framework |
---|
| 565 | implemented in LEMON. |
---|
| 566 | */ |
---|
| 567 | |
---|
| 568 | /** |
---|
| 569 | @defgroup metah Metaheuristics |
---|
| 570 | @ingroup gen_opt_group |
---|
| 571 | \brief Metaheuristics for LEMON library. |
---|
| 572 | |
---|
[559] | 573 | This group contains some metaheuristic optimization tools. |
---|
[40] | 574 | */ |
---|
| 575 | |
---|
| 576 | /** |
---|
[209] | 577 | @defgroup utils Tools and Utilities |
---|
[50] | 578 | \brief Tools and utilities for programming in LEMON |
---|
[40] | 579 | |
---|
[50] | 580 | Tools and utilities for programming in LEMON. |
---|
[40] | 581 | */ |
---|
| 582 | |
---|
| 583 | /** |
---|
| 584 | @defgroup gutils Basic Graph Utilities |
---|
| 585 | @ingroup utils |
---|
[50] | 586 | \brief Simple basic graph utilities. |
---|
[40] | 587 | |
---|
[559] | 588 | This group contains some simple basic graph utilities. |
---|
[40] | 589 | */ |
---|
| 590 | |
---|
| 591 | /** |
---|
| 592 | @defgroup misc Miscellaneous Tools |
---|
| 593 | @ingroup utils |
---|
[50] | 594 | \brief Tools for development, debugging and testing. |
---|
| 595 | |
---|
[559] | 596 | This group contains several useful tools for development, |
---|
[40] | 597 | debugging and testing. |
---|
| 598 | */ |
---|
| 599 | |
---|
| 600 | /** |
---|
[314] | 601 | @defgroup timecount Time Measuring and Counting |
---|
[40] | 602 | @ingroup misc |
---|
[50] | 603 | \brief Simple tools for measuring the performance of algorithms. |
---|
| 604 | |
---|
[559] | 605 | This group contains simple tools for measuring the performance |
---|
[40] | 606 | of algorithms. |
---|
| 607 | */ |
---|
| 608 | |
---|
| 609 | /** |
---|
| 610 | @defgroup exceptions Exceptions |
---|
| 611 | @ingroup utils |
---|
[50] | 612 | \brief Exceptions defined in LEMON. |
---|
| 613 | |
---|
[559] | 614 | This group contains the exceptions defined in LEMON. |
---|
[40] | 615 | */ |
---|
| 616 | |
---|
| 617 | /** |
---|
| 618 | @defgroup io_group Input-Output |
---|
[50] | 619 | \brief Graph Input-Output methods |
---|
[40] | 620 | |
---|
[559] | 621 | This group contains the tools for importing and exporting graphs |
---|
[314] | 622 | and graph related data. Now it supports the \ref lgf-format |
---|
| 623 | "LEMON Graph Format", the \c DIMACS format and the encapsulated |
---|
| 624 | postscript (EPS) format. |
---|
[40] | 625 | */ |
---|
| 626 | |
---|
| 627 | /** |
---|
[351] | 628 | @defgroup lemon_io LEMON Graph Format |
---|
[40] | 629 | @ingroup io_group |
---|
[314] | 630 | \brief Reading and writing LEMON Graph Format. |
---|
[40] | 631 | |
---|
[559] | 632 | This group contains methods for reading and writing |
---|
[236] | 633 | \ref lgf-format "LEMON Graph Format". |
---|
[40] | 634 | */ |
---|
| 635 | |
---|
| 636 | /** |
---|
[314] | 637 | @defgroup eps_io Postscript Exporting |
---|
[40] | 638 | @ingroup io_group |
---|
| 639 | \brief General \c EPS drawer and graph exporter |
---|
| 640 | |
---|
[559] | 641 | This group contains general \c EPS drawing methods and special |
---|
[209] | 642 | graph exporting tools. |
---|
[40] | 643 | */ |
---|
| 644 | |
---|
| 645 | /** |
---|
[714] | 646 | @defgroup dimacs_group DIMACS Format |
---|
[388] | 647 | @ingroup io_group |
---|
| 648 | \brief Read and write files in DIMACS format |
---|
| 649 | |
---|
| 650 | Tools to read a digraph from or write it to a file in DIMACS format data. |
---|
| 651 | */ |
---|
| 652 | |
---|
| 653 | /** |
---|
[351] | 654 | @defgroup nauty_group NAUTY Format |
---|
| 655 | @ingroup io_group |
---|
| 656 | \brief Read \e Nauty format |
---|
[388] | 657 | |
---|
[351] | 658 | Tool to read graphs from \e Nauty format data. |
---|
| 659 | */ |
---|
| 660 | |
---|
| 661 | /** |
---|
[40] | 662 | @defgroup concept Concepts |
---|
| 663 | \brief Skeleton classes and concept checking classes |
---|
| 664 | |
---|
[559] | 665 | This group contains the data/algorithm skeletons and concept checking |
---|
[40] | 666 | classes implemented in LEMON. |
---|
| 667 | |
---|
| 668 | The purpose of the classes in this group is fourfold. |
---|
[209] | 669 | |
---|
[318] | 670 | - These classes contain the documentations of the %concepts. In order |
---|
[40] | 671 | to avoid document multiplications, an implementation of a concept |
---|
| 672 | simply refers to the corresponding concept class. |
---|
| 673 | |
---|
| 674 | - These classes declare every functions, <tt>typedef</tt>s etc. an |
---|
[318] | 675 | implementation of the %concepts should provide, however completely |
---|
[40] | 676 | without implementations and real data structures behind the |
---|
| 677 | interface. On the other hand they should provide nothing else. All |
---|
| 678 | the algorithms working on a data structure meeting a certain concept |
---|
| 679 | should compile with these classes. (Though it will not run properly, |
---|
| 680 | of course.) In this way it is easily to check if an algorithm |
---|
| 681 | doesn't use any extra feature of a certain implementation. |
---|
| 682 | |
---|
| 683 | - The concept descriptor classes also provide a <em>checker class</em> |
---|
[50] | 684 | that makes it possible to check whether a certain implementation of a |
---|
[40] | 685 | concept indeed provides all the required features. |
---|
| 686 | |
---|
| 687 | - Finally, They can serve as a skeleton of a new implementation of a concept. |
---|
| 688 | */ |
---|
| 689 | |
---|
| 690 | /** |
---|
| 691 | @defgroup graph_concepts Graph Structure Concepts |
---|
| 692 | @ingroup concept |
---|
| 693 | \brief Skeleton and concept checking classes for graph structures |
---|
| 694 | |
---|
[735] | 695 | This group contains the skeletons and concept checking classes of |
---|
| 696 | graph structures. |
---|
[40] | 697 | */ |
---|
| 698 | |
---|
[314] | 699 | /** |
---|
| 700 | @defgroup map_concepts Map Concepts |
---|
| 701 | @ingroup concept |
---|
| 702 | \brief Skeleton and concept checking classes for maps |
---|
| 703 | |
---|
[559] | 704 | This group contains the skeletons and concept checking classes of maps. |
---|
[40] | 705 | */ |
---|
| 706 | |
---|
| 707 | /** |
---|
[714] | 708 | @defgroup tools Standalone Utility Applications |
---|
| 709 | |
---|
| 710 | Some utility applications are listed here. |
---|
| 711 | |
---|
| 712 | The standard compilation procedure (<tt>./configure;make</tt>) will compile |
---|
| 713 | them, as well. |
---|
| 714 | */ |
---|
| 715 | |
---|
| 716 | /** |
---|
[40] | 717 | \anchor demoprograms |
---|
| 718 | |
---|
[406] | 719 | @defgroup demos Demo Programs |
---|
[40] | 720 | |
---|
| 721 | Some demo programs are listed here. Their full source codes can be found in |
---|
| 722 | the \c demo subdirectory of the source tree. |
---|
| 723 | |
---|
[564] | 724 | In order to compile them, use the <tt>make demo</tt> or the |
---|
| 725 | <tt>make check</tt> commands. |
---|
[40] | 726 | */ |
---|
| 727 | |
---|
[406] | 728 | } |
---|