0
6
0
... | ... |
@@ -221,37 +221,58 @@ |
221 | 221 |
We have a length map and a maximum speed map on the arcs of a digraph. |
222 | 222 |
The minimum time to pass the arc can be calculated as the division of |
223 | 223 |
the two maps which can be done implicitly with the \c DivMap template |
224 | 224 |
class. We use the implicit minimum time map as the length map of the |
225 | 225 |
\c Dijkstra algorithm. |
226 | 226 |
*/ |
227 | 227 |
|
228 | 228 |
/** |
229 |
@defgroup matrices Matrices |
|
230 |
@ingroup datas |
|
231 |
\brief Two dimensional data storages implemented in LEMON. |
|
232 |
|
|
233 |
This group contains two dimensional data storages implemented in LEMON. |
|
234 |
*/ |
|
235 |
|
|
236 |
/** |
|
237 | 229 |
@defgroup paths Path Structures |
238 | 230 |
@ingroup datas |
239 | 231 |
\brief %Path structures implemented in LEMON. |
240 | 232 |
|
241 | 233 |
This group contains the path structures implemented in LEMON. |
242 | 234 |
|
243 | 235 |
LEMON provides flexible data structures to work with paths. |
244 | 236 |
All of them have similar interfaces and they can be copied easily with |
245 | 237 |
assignment operators and copy constructors. This makes it easy and |
246 | 238 |
efficient to have e.g. the Dijkstra algorithm to store its result in |
247 | 239 |
any kind of path structure. |
248 | 240 |
|
249 |
\sa |
|
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. |
|
250 | 271 |
*/ |
251 | 272 |
|
252 | 273 |
/** |
253 | 274 |
@defgroup auxdat Auxiliary Data Structures |
254 | 275 |
@ingroup datas |
255 | 276 |
\brief Auxiliary data structures implemented in LEMON. |
256 | 277 |
|
257 | 278 |
This group contains some data structures implemented in LEMON in |
... | ... |
@@ -14,27 +14,27 @@ |
14 | 14 |
* express or implied, and with no claim as to its suitability for any |
15 | 15 |
* purpose. |
16 | 16 |
* |
17 | 17 |
*/ |
18 | 18 |
|
19 | 19 |
#ifndef LEMON_BIN_HEAP_H |
20 | 20 |
#define LEMON_BIN_HEAP_H |
21 | 21 |
|
22 |
///\ingroup |
|
22 |
///\ingroup heaps |
|
23 | 23 |
///\file |
24 | 24 |
///\brief Binary heap implementation. |
25 | 25 |
|
26 | 26 |
#include <vector> |
27 | 27 |
#include <utility> |
28 | 28 |
#include <functional> |
29 | 29 |
|
30 | 30 |
namespace lemon { |
31 | 31 |
|
32 |
/// \ingroup |
|
32 |
/// \ingroup heaps |
|
33 | 33 |
/// |
34 | 34 |
/// \brief Binary heap data structure. |
35 | 35 |
/// |
36 | 36 |
/// This class implements the \e binary \e heap data structure. |
37 | 37 |
/// It fully conforms to the \ref concepts::Heap "heap concept". |
38 | 38 |
/// |
39 | 39 |
/// \tparam PR Type of the priorities of the items. |
40 | 40 |
/// \tparam IM A read-writable item map with \c int values, used |
... | ... |
@@ -14,17 +14,17 @@ |
14 | 14 |
* express or implied, and with no claim as to its suitability for any |
15 | 15 |
* purpose. |
16 | 16 |
* |
17 | 17 |
*/ |
18 | 18 |
|
19 | 19 |
#ifndef LEMON_BUCKET_HEAP_H |
20 | 20 |
#define LEMON_BUCKET_HEAP_H |
21 | 21 |
|
22 |
///\ingroup |
|
22 |
///\ingroup heaps |
|
23 | 23 |
///\file |
24 | 24 |
///\brief Bucket heap implementation. |
25 | 25 |
|
26 | 26 |
#include <vector> |
27 | 27 |
#include <utility> |
28 | 28 |
#include <functional> |
29 | 29 |
|
30 | 30 |
namespace lemon { |
... | ... |
@@ -48,17 +48,17 @@ |
48 | 48 |
} |
49 | 49 |
static void increase(int& value) { |
50 | 50 |
--value; |
51 | 51 |
} |
52 | 52 |
}; |
53 | 53 |
|
54 | 54 |
} |
55 | 55 |
|
56 |
/// \ingroup |
|
56 |
/// \ingroup heaps |
|
57 | 57 |
/// |
58 | 58 |
/// \brief Bucket heap data structure. |
59 | 59 |
/// |
60 | 60 |
/// This class implements the \e bucket \e heap data structure. |
61 | 61 |
/// It practically conforms to the \ref concepts::Heap "heap concept", |
62 | 62 |
/// but it has some limitations. |
63 | 63 |
/// |
64 | 64 |
/// The bucket heap is a very simple structure. It can store only |
... | ... |
@@ -366,17 +366,17 @@ |
366 | 366 |
|
367 | 367 |
ItemIntMap& _iim; |
368 | 368 |
std::vector<int> _first; |
369 | 369 |
std::vector<BucketItem> _data; |
370 | 370 |
mutable int _minimum; |
371 | 371 |
|
372 | 372 |
}; // class BucketHeap |
373 | 373 |
|
374 |
/// \ingroup |
|
374 |
/// \ingroup heaps |
|
375 | 375 |
/// |
376 | 376 |
/// \brief Simplified bucket heap data structure. |
377 | 377 |
/// |
378 | 378 |
/// This class implements a simplified \e bucket \e heap data |
379 | 379 |
/// structure. It does not provide some functionality, but it is |
380 | 380 |
/// faster and simpler than BucketHeap. The main difference is |
381 | 381 |
/// that BucketHeap stores a doubly-linked list for each key while |
382 | 382 |
/// this class stores only simply-linked lists. It supports erasing |
... | ... |
@@ -31,17 +31,17 @@ |
31 | 31 |
namespace concepts { |
32 | 32 |
|
33 | 33 |
/// \addtogroup concept |
34 | 34 |
/// @{ |
35 | 35 |
|
36 | 36 |
/// \brief The heap concept. |
37 | 37 |
/// |
38 | 38 |
/// This concept class describes the main interface of heaps. |
39 |
/// The various heap structures are efficient |
|
39 |
/// The various \ref heaps "heap structures" are efficient |
|
40 | 40 |
/// implementations of the abstract data type \e priority \e queue. |
41 | 41 |
/// They store items with specified values called \e priorities |
42 | 42 |
/// in such a way that finding and removing the item with minimum |
43 | 43 |
/// priority are efficient. The basic operations are adding and |
44 | 44 |
/// erasing items, changing the priority of an item, etc. |
45 | 45 |
/// |
46 | 46 |
/// Heaps are crucial in several algorithms, such as Dijkstra and Prim. |
47 | 47 |
/// Any class that conforms to this concept can be used easily in such |
... | ... |
@@ -15,27 +15,27 @@ |
15 | 15 |
* purpose. |
16 | 16 |
* |
17 | 17 |
*/ |
18 | 18 |
|
19 | 19 |
#ifndef LEMON_FIB_HEAP_H |
20 | 20 |
#define LEMON_FIB_HEAP_H |
21 | 21 |
|
22 | 22 |
///\file |
23 |
///\ingroup |
|
23 |
///\ingroup heaps |
|
24 | 24 |
///\brief Fibonacci heap implementation. |
25 | 25 |
|
26 | 26 |
#include <vector> |
27 | 27 |
#include <utility> |
28 | 28 |
#include <functional> |
29 | 29 |
#include <lemon/math.h> |
30 | 30 |
|
31 | 31 |
namespace lemon { |
32 | 32 |
|
33 |
/// \ingroup |
|
33 |
/// \ingroup heaps |
|
34 | 34 |
/// |
35 | 35 |
/// \brief Fibonacci heap data structure. |
36 | 36 |
/// |
37 | 37 |
/// This class implements the \e Fibonacci \e heap data structure. |
38 | 38 |
/// It fully conforms to the \ref concepts::Heap "heap concept". |
39 | 39 |
/// |
40 | 40 |
/// The methods \ref increase() and \ref erase() are not efficient in a |
41 | 41 |
/// Fibonacci heap. In case of many calls of these operations, it is |
... | ... |
@@ -14,27 +14,27 @@ |
14 | 14 |
* express or implied, and with no claim as to its suitability for any |
15 | 15 |
* purpose. |
16 | 16 |
* |
17 | 17 |
*/ |
18 | 18 |
|
19 | 19 |
#ifndef LEMON_RADIX_HEAP_H |
20 | 20 |
#define LEMON_RADIX_HEAP_H |
21 | 21 |
|
22 |
///\ingroup |
|
22 |
///\ingroup heaps |
|
23 | 23 |
///\file |
24 | 24 |
///\brief Radix heap implementation. |
25 | 25 |
|
26 | 26 |
#include <vector> |
27 | 27 |
#include <lemon/error.h> |
28 | 28 |
|
29 | 29 |
namespace lemon { |
30 | 30 |
|
31 | 31 |
|
32 |
/// \ingroup |
|
32 |
/// \ingroup heaps |
|
33 | 33 |
/// |
34 | 34 |
/// \brief Radix heap data structure. |
35 | 35 |
/// |
36 | 36 |
/// This class implements the \e radix \e heap data structure. |
37 | 37 |
/// It practically conforms to the \ref concepts::Heap "heap concept", |
38 | 38 |
/// but it has some limitations due its special implementation. |
39 | 39 |
/// The type of the priorities must be \c int and the priority of an |
40 | 40 |
/// item cannot be decreased under the priority of the last removed item. |
0 comments (0 inline)