Changeset 710:f1fe0ddad6f7 in lemon-main

Timestamp:

07/08/09 17:22:36 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Move the heaps to a separate group (#299)

Files:

• doc/groups.dox (modified) (2 diffs)
• lemon/bin_heap.h (modified) (2 diffs)
• lemon/bucket_heap.h (modified) (3 diffs)
• lemon/concepts/heap.h (modified) (1 diff)
• lemon/fib_heap.h (modified) (2 diffs)
• lemon/radix_heap.h (modified) (2 diffs)

doc/groups.dox

@@ -227 +227 @@
 
 /**
-@defgroup matrices Matrices
-@ingroup datas
-\brief Two dimensional data storages implemented in LEMON.
-
-This group contains two dimensional data storages implemented in LEMON.
-*/
-
-/**
 @defgroup paths Path Structures
 @ingroup datas
@@ -247 +239 @@
 any kind of path structure.
 
-\sa lemon::concepts::Path
+\sa \ref concepts::Path "Path concept"
+*/
+
+/**
+@defgroup heaps Heap Structures
+@ingroup datas
+\brief %Heap structures implemented in LEMON.
+
+This group contains the heap structures implemented in LEMON.
+
+LEMON provides several heap classes. They are efficient implementations
+of the abstract data type \e priority \e queue. They store items with
+specified values called \e priorities in such a way that finding and
+removing the item with minimum priority are efficient.
+The basic operations are adding and erasing items, changing the priority
+of an item, etc.
+
+Heaps are crucial in several algorithms, such as Dijkstra and Prim.
+The heap implementations have the same interface, thus any of them can be
+used easily in such algorithms.
+
+\sa \ref concepts::Heap "Heap concept"
+*/
+
+/**
+@defgroup matrices Matrices
+@ingroup datas
+\brief Two dimensional data storages implemented in LEMON.
+
+This group contains two dimensional data storages implemented in LEMON.
 */
 

lemon/bin_heap.h

@@ -20 +20 @@
 #define LEMON_BIN_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Binary heap implementation.
@@ -30 +30 @@
 namespace lemon {
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Binary heap data structure.

lemon/bucket_heap.h

@@ -20 +20 @@
 #define LEMON_BUCKET_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Bucket heap implementation.
@@ -54 +54 @@
   }
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Bucket heap data structure.
@@ -372 +372 @@
   }; // class BucketHeap
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Simplified bucket heap data structure.

lemon/concepts/heap.h

@@ -37 +37 @@
     ///
     /// This concept class describes the main interface of heaps.
-    /// The various heap structures are efficient
+    /// The various \ref heaps "heap structures" are efficient
     /// implementations of the abstract data type \e priority \e queue.
     /// They store items with specified values called \e priorities

lemon/fib_heap.h

@@ -21 +21 @@
 
 ///\file
-///\ingroup auxdat
+///\ingroup heaps
 ///\brief Fibonacci heap implementation.
 
@@ -31 +31 @@
 namespace lemon {
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Fibonacci heap data structure.

lemon/radix_heap.h

@@ -20 +20 @@
 #define LEMON_RADIX_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Radix heap implementation.
@@ -30 +30 @@
 
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Radix heap data structure.