[Lemon-commits] Peter Kovacs: Move the heaps to a separate group...

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/f1fe0ddad6f7
changeset: 763:f1fe0ddad6f7
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Wed Jul 08 17:22:36 2009 +0200
description:
	Move the heaps to a separate group (#299)

diffstat:

 doc/groups.dox        |  39 ++++++++++++++++++++++++++++++---------
 lemon/bin_heap.h      |   4 ++--
 lemon/bucket_heap.h   |   6 +++---
 lemon/concepts/heap.h |   2 +-
 lemon/fib_heap.h      |   4 ++--
 lemon/radix_heap.h    |   4 ++--
 6 files changed, 40 insertions(+), 19 deletions(-)

diffs (161 lines):

diff --git a/doc/groups.dox b/doc/groups.dox
--- a/doc/groups.dox
+++ b/doc/groups.dox
@@ -226,14 +226,6 @@
 */
 
 /**
- at defgroup matrices Matrices
- at 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
 \brief %Path structures implemented in LEMON.
@@ -246,7 +238,36 @@
 efficient to have e.g. the Dijkstra algorithm to store its result in
 any kind of path structure.
 
-\sa lemon::concepts::Path
+\sa \ref concepts::Path "Path concept"
+*/
+
+/**
+ at defgroup heaps Heap Structures
+ at 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"
+*/
+
+/**
+ at defgroup matrices Matrices
+ at ingroup datas
+\brief Two dimensional data storages implemented in LEMON.
+
+This group contains two dimensional data storages implemented in LEMON.
 */
 
 /**
diff --git a/lemon/bin_heap.h b/lemon/bin_heap.h
--- a/lemon/bin_heap.h
+++ b/lemon/bin_heap.h
@@ -19,7 +19,7 @@
 #ifndef LEMON_BIN_HEAP_H
 #define LEMON_BIN_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Binary heap implementation.
 
@@ -29,7 +29,7 @@
 
 namespace lemon {
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Binary heap data structure.
   ///
diff --git a/lemon/bucket_heap.h b/lemon/bucket_heap.h
--- a/lemon/bucket_heap.h
+++ b/lemon/bucket_heap.h
@@ -19,7 +19,7 @@
 #ifndef LEMON_BUCKET_HEAP_H
 #define LEMON_BUCKET_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Bucket heap implementation.
 
@@ -53,7 +53,7 @@
 
   }
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Bucket heap data structure.
   ///
@@ -371,7 +371,7 @@
 
   }; // class BucketHeap
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Simplified bucket heap data structure.
   ///
diff --git a/lemon/concepts/heap.h b/lemon/concepts/heap.h
--- a/lemon/concepts/heap.h
+++ b/lemon/concepts/heap.h
@@ -36,7 +36,7 @@
     /// \brief The heap concept.
     ///
     /// 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
     /// in such a way that finding and removing the item with minimum
diff --git a/lemon/fib_heap.h b/lemon/fib_heap.h
--- a/lemon/fib_heap.h
+++ b/lemon/fib_heap.h
@@ -20,7 +20,7 @@
 #define LEMON_FIB_HEAP_H
 
 ///\file
-///\ingroup auxdat
+///\ingroup heaps
 ///\brief Fibonacci heap implementation.
 
 #include <vector>
@@ -30,7 +30,7 @@
 
 namespace lemon {
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Fibonacci heap data structure.
   ///
diff --git a/lemon/radix_heap.h b/lemon/radix_heap.h
--- a/lemon/radix_heap.h
+++ b/lemon/radix_heap.h
@@ -19,7 +19,7 @@
 #ifndef LEMON_RADIX_HEAP_H
 #define LEMON_RADIX_HEAP_H
 
-///\ingroup auxdat
+///\ingroup heaps
 ///\file
 ///\brief Radix heap implementation.
 
@@ -29,7 +29,7 @@
 namespace lemon {
 
 
-  /// \ingroup auxdat
+  /// \ingroup heaps
   ///
   /// \brief Radix heap data structure.
   ///