# HG changeset patch # User Peter Kovacs # Date 1247066556 -7200 # Node ID f1fe0ddad6f7ab57dec5c6990fb13c76bd7e9f48 # Parent 0747f332c4782fd4fd5e73d83f34fc6ee201b323 Move the heaps to a separate group (#299) diff -r 0747f332c478 -r f1fe0ddad6f7 doc/groups.dox --- a/doc/groups.dox Wed Jul 08 17:21:30 2009 +0200 +++ b/doc/groups.dox Wed Jul 08 17:22:36 2009 +0200 @@ -226,14 +226,6 @@ */ /** -@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 \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" +*/ + +/** +@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. */ /** diff -r 0747f332c478 -r f1fe0ddad6f7 lemon/bin_heap.h --- a/lemon/bin_heap.h Wed Jul 08 17:21:30 2009 +0200 +++ b/lemon/bin_heap.h Wed Jul 08 17:22:36 2009 +0200 @@ -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 -r 0747f332c478 -r f1fe0ddad6f7 lemon/bucket_heap.h --- a/lemon/bucket_heap.h Wed Jul 08 17:21:30 2009 +0200 +++ b/lemon/bucket_heap.h Wed Jul 08 17:22:36 2009 +0200 @@ -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 -r 0747f332c478 -r f1fe0ddad6f7 lemon/concepts/heap.h --- a/lemon/concepts/heap.h Wed Jul 08 17:21:30 2009 +0200 +++ b/lemon/concepts/heap.h Wed Jul 08 17:22:36 2009 +0200 @@ -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 -r 0747f332c478 -r f1fe0ddad6f7 lemon/fib_heap.h --- a/lemon/fib_heap.h Wed Jul 08 17:21:30 2009 +0200 +++ b/lemon/fib_heap.h Wed Jul 08 17:22:36 2009 +0200 @@ -20,7 +20,7 @@ #define LEMON_FIB_HEAP_H ///\file -///\ingroup auxdat +///\ingroup heaps ///\brief Fibonacci heap implementation. #include @@ -30,7 +30,7 @@ namespace lemon { - /// \ingroup auxdat + /// \ingroup heaps /// /// \brief Fibonacci heap data structure. /// diff -r 0747f332c478 -r f1fe0ddad6f7 lemon/radix_heap.h --- a/lemon/radix_heap.h Wed Jul 08 17:21:30 2009 +0200 +++ b/lemon/radix_heap.h Wed Jul 08 17:22:36 2009 +0200 @@ -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. ///