... | ... |
@@ -20,3 +20,3 @@ |
20 | 20 |
@defgroup datas Data Structures |
21 |
This group describes the several |
|
21 |
This group describes the several data structures implemented in LEMON. |
|
22 | 22 |
*/ |
... | ... |
@@ -52,3 +52,3 @@ |
52 | 52 |
\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only |
53 |
in conjunction with other graph |
|
53 |
in conjunction with other graph representations. |
|
54 | 54 |
|
... | ... |
@@ -60,3 +60,3 @@ |
60 | 60 |
/** |
61 |
@defgroup semi_adaptors Semi- |
|
61 |
@defgroup semi_adaptors Semi-Adaptor Classes for Graphs |
|
62 | 62 |
@ingroup graphs |
... | ... |
@@ -64,5 +64,5 @@ |
64 | 64 |
|
65 |
Graph types between real graphs and graph adaptors. These classes wrap |
|
66 |
graphs to give new functionality as the adaptors do it. On the other |
|
67 |
|
|
65 |
This group describes some graph types between real graphs and graph adaptors. |
|
66 |
These classes wrap graphs to give new functionality as the adaptors do it. |
|
67 |
On the other hand they are not light-weight structures as the adaptors. |
|
68 | 68 |
*/ |
... | ... |
@@ -72,5 +72,7 @@ |
72 | 72 |
@ingroup datas |
73 |
\brief |
|
73 |
\brief Map structures implemented in LEMON. |
|
74 | 74 |
|
75 |
|
|
75 |
This group describes the map structures implemented in LEMON. |
|
76 |
|
|
77 |
LEMON provides several special purpose maps that e.g. combine |
|
76 | 78 |
new maps from existing ones. |
... | ... |
@@ -83,4 +85,4 @@ |
83 | 85 |
|
84 |
These maps are specifically designed to assign values to the nodes and edges of |
|
85 |
graphs. |
|
86 |
This group describes maps that are specifically designed to assign |
|
87 |
values to the nodes and edges of graphs. |
|
86 | 88 |
*/ |
... | ... |
@@ -93,3 +95,4 @@ |
93 | 95 |
|
94 |
|
|
96 |
This group describes map adaptors that are used to create "implicit" |
|
97 |
maps from other maps. |
|
95 | 98 |
|
... | ... |
@@ -100,3 +103,3 @@ |
100 | 103 |
|
101 |
The typical usage of this classes is |
|
104 |
The typical usage of this classes is passing implicit maps to |
|
102 | 105 |
algorithms. If a function type algorithm is called then the function |
... | ... |
@@ -129,3 +132,3 @@ |
129 | 132 |
case the function type map adaptors can not be used, because the |
130 |
function map adaptors give back |
|
133 |
function map adaptors give back temporary objects. |
|
131 | 134 |
\code |
... | ... |
@@ -155,5 +158,5 @@ |
155 | 158 |
@ingroup datas |
156 |
\brief Two dimensional data storages. |
|
159 |
\brief Two dimensional data storages implemented in LEMON. |
|
157 | 160 |
|
158 |
|
|
161 |
This group describes two dimensional data storages implemented in LEMON. |
|
159 | 162 |
*/ |
... | ... |
@@ -165,7 +168,7 @@ |
165 | 168 |
|
166 |
LEMON provides flexible data structures |
|
167 |
to work with paths. |
|
169 |
This group describes the path structures implemented in LEMON. |
|
168 | 170 |
|
169 |
All of them have similar interfaces, and it can be copied easily with |
|
170 |
assignment operator and copy constructor. This make it easy and |
|
171 |
LEMON provides flexible data structures to work with paths. |
|
172 |
All of them have similar interfaces and they can be copied easily with |
|
173 |
assignment operators and copy constructors. This makes it easy and |
|
171 | 174 |
efficient to have e.g. the Dijkstra algorithm to store its result in |
... | ... |
@@ -180,5 +183,5 @@ |
180 | 183 |
@ingroup datas |
181 |
\brief |
|
184 |
\brief Auxiliary data structures implemented in LEMON. |
|
182 | 185 |
|
183 |
This group describes |
|
186 |
This group describes some data structures implemented in LEMON in |
|
184 | 187 |
order to make it easier to implement combinatorial algorithms. |
... | ... |
@@ -199,7 +202,6 @@ |
199 | 202 |
@ingroup algs |
200 |
\brief This group contains the common graph |
|
201 |
search algorithms. |
|
203 |
\brief Common graph search algorithms. |
|
202 | 204 |
|
203 |
This group contains the common graph |
|
204 |
search algorithms like Bfs and Dfs. |
|
205 |
This group describes the common graph search algorithms like |
|
206 |
Breadth-first search (Bfs) and Depth-first search (Dfs). |
|
205 | 207 |
*/ |
... | ... |
@@ -209,8 +211,5 @@ |
209 | 211 |
@ingroup algs |
210 |
\brief This group describes the algorithms |
|
211 |
for finding shortest paths. |
|
212 |
\brief Algorithms for finding shortest paths. |
|
212 | 213 |
|
213 |
This group describes the algorithms for finding shortest paths in |
|
214 |
graphs. |
|
215 |
|
|
214 |
This group describes the algorithms for finding shortest paths in graphs. |
|
216 | 215 |
*/ |
... | ... |
@@ -220,3 +219,3 @@ |
220 | 219 |
@ingroup algs |
221 |
\brief |
|
220 |
\brief Algorithms for finding maximum flows. |
|
222 | 221 |
|
... | ... |
@@ -225,22 +224,22 @@ |
225 | 224 |
|
226 |
The maximum flow problem is to find a flow between a single-source and |
|
227 |
single-target that is maximum. Formally, there is \f$G=(V,A)\f$ |
|
225 |
The maximum flow problem is to find a flow between a single source and |
|
226 |
a single target that is maximum. Formally, there is a \f$G=(V,A)\f$ |
|
228 | 227 |
directed graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity |
229 | 228 |
function and given \f$s, t \in V\f$ source and target node. The |
230 |
maximum flow is the solution of the next optimization problem: |
|
229 |
maximum flow is the \f$f_a\f$ solution of the next optimization problem: |
|
231 | 230 |
|
232 | 231 |
\f[ 0 \le f_a \le c_a \f] |
233 |
\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \ |
|
232 |
\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv} \qquad \forall u \in V \setminus \{s,t\}\f] |
|
234 | 233 |
\f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f] |
235 | 234 |
|
236 |
|
|
235 |
LEMON contains several algorithms for solving maximum flow problems: |
|
237 | 236 |
- \ref lemon::EdmondsKarp "Edmonds-Karp" |
238 | 237 |
- \ref lemon::Preflow "Goldberg's Preflow algorithm" |
239 |
- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic |
|
238 |
- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees" |
|
240 | 239 |
- \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees" |
241 | 240 |
|
242 |
In most cases the \ref lemon::Preflow " |
|
241 |
In most cases the \ref lemon::Preflow "Preflow" algorithm provides the |
|
243 | 242 |
fastest method to compute the maximum flow. All impelementations |
244 |
provides functions for query the minimum cut, which is the dual linear |
|
245 |
programming probelm of the maximum flow. |
|
243 |
provides functions to query the minimum cut, which is the dual linear |
|
244 |
programming problem of the maximum flow. |
|
246 | 245 |
|
... | ... |
@@ -252,4 +251,3 @@ |
252 | 251 |
|
253 |
\brief This group describes the algorithms |
|
254 |
for finding minimum cost flows and circulations. |
|
252 |
\brief Algorithms for finding minimum cost flows and circulations. |
|
255 | 253 |
|
... | ... |
@@ -263,4 +261,3 @@ |
263 | 261 |
|
264 |
\brief This group describes the algorithms for finding minimum cut in |
|
265 |
graphs. |
|
262 |
\brief Algorithms for finding minimum cut in graphs. |
|
266 | 263 |
|
... | ... |
@@ -272,3 +269,3 @@ |
272 | 269 |
\f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum |
273 |
cut is the solution of the next optimization problem: |
|
270 |
cut is the \f$X\f$ solution of the next optimization problem: |
|
274 | 271 |
|
... | ... |
@@ -276,9 +273,9 @@ |
276 | 273 |
|
277 |
|
|
274 |
LEMON contains several algorithms related to minimum cut problems: |
|
278 | 275 |
|
279 |
- \ref lemon::HaoOrlin "Hao-Orlin algorithm" |
|
276 |
- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut |
|
280 | 277 |
in directed graphs |
281 |
- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" |
|
278 |
- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to |
|
282 | 279 |
calculate minimum cut in undirected graphs |
283 |
- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" |
|
280 |
- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all |
|
284 | 281 |
pairs minimum cut in undirected graphs |
... | ... |
@@ -293,7 +290,6 @@ |
293 | 290 |
@ingroup algs |
294 |
\brief This group describes the algorithms |
|
295 |
for discover the graph properties |
|
291 |
\brief Algorithms for discovering the graph properties |
|
296 | 292 |
|
297 |
This group describes the algorithms for discover the graph properties |
|
298 |
like connectivity, bipartiteness, euler property, simplicity, etc... |
|
293 |
This group describes the algorithms for discovering the graph properties |
|
294 |
like connectivity, bipartiteness, euler property, simplicity etc. |
|
299 | 295 |
|
... | ... |
@@ -306,5 +302,5 @@ |
306 | 302 |
@ingroup algs |
307 |
\brief |
|
303 |
\brief Algorithms for planarity checking, embedding and drawing |
|
308 | 304 |
|
309 |
This group |
|
305 |
This group describes the algorithms for planarity checking, embedding and drawing. |
|
310 | 306 |
|
... | ... |
@@ -317,6 +313,5 @@ |
317 | 313 |
@ingroup algs |
318 |
\brief This group describes the algorithms |
|
319 |
for find matchings in graphs and bipartite graphs. |
|
314 |
\brief Algorithms for finding matchings in graphs and bipartite graphs. |
|
320 | 315 |
|
321 |
This group |
|
316 |
This group contains algorithm objects and functions to calculate |
|
322 | 317 |
matchings in graphs and bipartite graphs. The general matching problem is |
... | ... |
@@ -360,6 +355,5 @@ |
360 | 355 |
@ingroup algs |
361 |
\brief This group contains the algorithms for finding a minimum cost spanning |
|
362 |
tree in a graph |
|
356 |
\brief Algorithms for finding a minimum cost spanning tree in a graph. |
|
363 | 357 |
|
364 |
This group |
|
358 |
This group describes the algorithms for finding a minimum cost spanning |
|
365 | 359 |
tree in a graph |
... | ... |
@@ -371,6 +365,6 @@ |
371 | 365 |
@ingroup algs |
372 |
\brief |
|
366 |
\brief Auxiliary algorithms implemented in LEMON. |
|
373 | 367 |
|
374 |
This group describes the algorithms in LEMON in order to make |
|
375 |
it easier to implement complex algorithms. |
|
368 |
This group describes some algorithms implemented in LEMON |
|
369 |
in order to make it easier to implement complex algorithms. |
|
376 | 370 |
*/ |
... | ... |
@@ -379,5 +373,6 @@ |
379 | 373 |
@defgroup approx Approximation algorithms |
380 |
\brief Approximation algorithms |
|
374 |
\brief Approximation algorithms. |
|
381 | 375 |
|
382 |
|
|
376 |
This group describes the approximation and heuristic algorithms |
|
377 |
implemented in LEMON. |
|
383 | 378 |
*/ |
... | ... |
@@ -408,4 +403,3 @@ |
408 | 403 |
@ingroup lp_group |
409 |
\brief This group adds some helper tools to the Lp and Mip solvers |
|
410 |
implemented in LEMON. |
|
404 |
\brief Helper tools to the Lp and Mip solvers. |
|
411 | 405 |
|
... | ... |
@@ -420,3 +414,3 @@ |
420 | 414 |
|
421 |
This group |
|
415 |
This group describes some metaheuristic optimization tools. |
|
422 | 416 |
*/ |
... | ... |
@@ -425,5 +419,5 @@ |
425 | 419 |
@defgroup utils Tools and Utilities |
426 |
\brief Tools and |
|
420 |
\brief Tools and utilities for programming in LEMON |
|
427 | 421 |
|
428 |
Tools and |
|
422 |
Tools and utilities for programming in LEMON. |
|
429 | 423 |
*/ |
... | ... |
@@ -433,3 +427,3 @@ |
433 | 427 |
@ingroup utils |
434 |
\brief |
|
428 |
\brief Simple basic graph utilities. |
|
435 | 429 |
|
... | ... |
@@ -441,3 +435,5 @@ |
441 | 435 |
@ingroup utils |
442 |
|
|
436 |
\brief Tools for development, debugging and testing. |
|
437 |
|
|
438 |
This group describes several useful tools for development, |
|
443 | 439 |
debugging and testing. |
... | ... |
@@ -445,3 +441,2 @@ |
445 | 441 |
|
446 |
|
|
447 | 442 |
/** |
... | ... |
@@ -449,3 +444,5 @@ |
449 | 444 |
@ingroup misc |
450 |
|
|
445 |
\brief Simple tools for measuring the performance of algorithms. |
|
446 |
|
|
447 |
This group describes simple tools for measuring the performance |
|
451 | 448 |
of algorithms. |
... | ... |
@@ -456,5 +453,5 @@ |
456 | 453 |
@ingroup utils |
457 |
\brief Tools to |
|
454 |
\brief Tools to make it easier to create graphs. |
|
458 | 455 |
|
459 |
This group describes the tools that makes it easier to |
|
456 |
This group describes the tools that makes it easier to create graphs and |
|
460 | 457 |
the maps that dynamically update with the graph changes. |
... | ... |
@@ -465,3 +462,5 @@ |
465 | 462 |
@ingroup utils |
466 |
|
|
463 |
\brief Exceptions defined in LEMON. |
|
464 |
|
|
465 |
This group describes the exceptions defined in LEMON. |
|
467 | 466 |
*/ |
... | ... |
@@ -470,7 +469,7 @@ |
470 | 469 |
@defgroup io_group Input-Output |
471 |
\brief |
|
470 |
\brief Graph Input-Output methods |
|
472 | 471 |
|
473 |
|
|
472 |
This group describes the tools for importing and exporting graphs |
|
474 | 473 |
and graph related data. Now it supports the LEMON format, the |
475 |
\c DIMACS format and the encapsulated postscript format. |
|
474 |
\c DIMACS format and the encapsulated postscript (EPS) format. |
|
476 | 475 |
*/ |
... | ... |
@@ -482,4 +481,4 @@ |
482 | 481 |
|
483 |
Methods for reading and writing LEMON format. More about this |
|
484 |
format you can find on the \ref graph-io-page "Graph Input-Output" |
|
482 |
This group describes methods for reading and writing LEMON format. |
|
483 |
You can find more about this format on the \ref graph-io-page "Graph Input-Output" |
|
485 | 484 |
tutorial pages. |
... | ... |
@@ -492,4 +491,4 @@ |
492 | 491 |
|
493 |
Here you can find which section readers and writers can attach to |
|
494 |
the LemonReader and LemonWriter. |
|
492 |
This group describes section readers and writers that can be attached to |
|
493 |
\ref LemonReader and \ref LemonWriter. |
|
495 | 494 |
*/ |
... | ... |
@@ -511,3 +510,3 @@ |
511 | 510 |
|
512 |
This group |
|
511 |
This group describes general \c EPS drawing methods and special |
|
513 | 512 |
graph exporting tools. |
... | ... |
@@ -539,3 +538,3 @@ |
539 | 538 |
- The concept descriptor classes also provide a <em>checker class</em> |
540 |
that makes it possible check whether a certain implementation of a |
|
539 |
that makes it possible to check whether a certain implementation of a |
|
541 | 540 |
concept indeed provides all the required features. |
... | ... |
@@ -552,3 +551,3 @@ |
552 | 551 |
|
553 |
This group |
|
552 |
This group describes the skeletons and concept checking classes of LEMON's |
|
554 | 553 |
graph structures and helper classes used to implement these. |
... | ... |
@@ -558,3 +557,3 @@ |
558 | 557 |
@defgroup experimental Experimental Structures and Algorithms |
559 |
This group |
|
558 |
This group describes some Experimental structures and algorithms. |
|
560 | 559 |
The stuff here is subject to change. |
... | ... |
@@ -572,3 +571,2 @@ |
572 | 571 |
build the library. |
573 |
|
|
574 | 572 |
*/ |
... | ... |
@@ -582,3 +580,2 @@ |
582 | 580 |
them, as well. |
583 |
|
|
584 | 581 |
*/ |
0 comments (0 inline)