Move the heaps to a separate group (#299)
authorPeter Kovacs <kpeter@inf.elte.hu>
Wed, 08 Jul 2009 17:22:36 +0200
changeset 710f1fe0ddad6f7
parent 709 0747f332c478
child 711 28cfac049a6a
Move the heaps to a separate group (#299)
doc/groups.dox
lemon/bin_heap.h
lemon/bucket_heap.h
lemon/concepts/heap.h
lemon/fib_heap.h
lemon/radix_heap.h
     1.1 --- a/doc/groups.dox	Wed Jul 08 17:21:30 2009 +0200
     1.2 +++ b/doc/groups.dox	Wed Jul 08 17:22:36 2009 +0200
     1.3 @@ -226,14 +226,6 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 -@defgroup matrices Matrices
     1.8 -@ingroup datas
     1.9 -\brief Two dimensional data storages implemented in LEMON.
    1.10 -
    1.11 -This group contains two dimensional data storages implemented in LEMON.
    1.12 -*/
    1.13 -
    1.14 -/**
    1.15  @defgroup paths Path Structures
    1.16  @ingroup datas
    1.17  \brief %Path structures implemented in LEMON.
    1.18 @@ -246,7 +238,36 @@
    1.19  efficient to have e.g. the Dijkstra algorithm to store its result in
    1.20  any kind of path structure.
    1.21  
    1.22 -\sa lemon::concepts::Path
    1.23 +\sa \ref concepts::Path "Path concept"
    1.24 +*/
    1.25 +
    1.26 +/**
    1.27 +@defgroup heaps Heap Structures
    1.28 +@ingroup datas
    1.29 +\brief %Heap structures implemented in LEMON.
    1.30 +
    1.31 +This group contains the heap structures implemented in LEMON.
    1.32 +
    1.33 +LEMON provides several heap classes. They are efficient implementations
    1.34 +of the abstract data type \e priority \e queue. They store items with
    1.35 +specified values called \e priorities in such a way that finding and
    1.36 +removing the item with minimum priority are efficient.
    1.37 +The basic operations are adding and erasing items, changing the priority
    1.38 +of an item, etc.
    1.39 +
    1.40 +Heaps are crucial in several algorithms, such as Dijkstra and Prim.
    1.41 +The heap implementations have the same interface, thus any of them can be
    1.42 +used easily in such algorithms.
    1.43 +
    1.44 +\sa \ref concepts::Heap "Heap concept"
    1.45 +*/
    1.46 +
    1.47 +/**
    1.48 +@defgroup matrices Matrices
    1.49 +@ingroup datas
    1.50 +\brief Two dimensional data storages implemented in LEMON.
    1.51 +
    1.52 +This group contains two dimensional data storages implemented in LEMON.
    1.53  */
    1.54  
    1.55  /**
     2.1 --- a/lemon/bin_heap.h	Wed Jul 08 17:21:30 2009 +0200
     2.2 +++ b/lemon/bin_heap.h	Wed Jul 08 17:22:36 2009 +0200
     2.3 @@ -19,7 +19,7 @@
     2.4  #ifndef LEMON_BIN_HEAP_H
     2.5  #define LEMON_BIN_HEAP_H
     2.6  
     2.7 -///\ingroup auxdat
     2.8 +///\ingroup heaps
     2.9  ///\file
    2.10  ///\brief Binary heap implementation.
    2.11  
    2.12 @@ -29,7 +29,7 @@
    2.13  
    2.14  namespace lemon {
    2.15  
    2.16 -  /// \ingroup auxdat
    2.17 +  /// \ingroup heaps
    2.18    ///
    2.19    /// \brief Binary heap data structure.
    2.20    ///
     3.1 --- a/lemon/bucket_heap.h	Wed Jul 08 17:21:30 2009 +0200
     3.2 +++ b/lemon/bucket_heap.h	Wed Jul 08 17:22:36 2009 +0200
     3.3 @@ -19,7 +19,7 @@
     3.4  #ifndef LEMON_BUCKET_HEAP_H
     3.5  #define LEMON_BUCKET_HEAP_H
     3.6  
     3.7 -///\ingroup auxdat
     3.8 +///\ingroup heaps
     3.9  ///\file
    3.10  ///\brief Bucket heap implementation.
    3.11  
    3.12 @@ -53,7 +53,7 @@
    3.13  
    3.14    }
    3.15  
    3.16 -  /// \ingroup auxdat
    3.17 +  /// \ingroup heaps
    3.18    ///
    3.19    /// \brief Bucket heap data structure.
    3.20    ///
    3.21 @@ -371,7 +371,7 @@
    3.22  
    3.23    }; // class BucketHeap
    3.24  
    3.25 -  /// \ingroup auxdat
    3.26 +  /// \ingroup heaps
    3.27    ///
    3.28    /// \brief Simplified bucket heap data structure.
    3.29    ///
     4.1 --- a/lemon/concepts/heap.h	Wed Jul 08 17:21:30 2009 +0200
     4.2 +++ b/lemon/concepts/heap.h	Wed Jul 08 17:22:36 2009 +0200
     4.3 @@ -36,7 +36,7 @@
     4.4      /// \brief The heap concept.
     4.5      ///
     4.6      /// This concept class describes the main interface of heaps.
     4.7 -    /// The various heap structures are efficient
     4.8 +    /// The various \ref heaps "heap structures" are efficient
     4.9      /// implementations of the abstract data type \e priority \e queue.
    4.10      /// They store items with specified values called \e priorities
    4.11      /// in such a way that finding and removing the item with minimum
     5.1 --- a/lemon/fib_heap.h	Wed Jul 08 17:21:30 2009 +0200
     5.2 +++ b/lemon/fib_heap.h	Wed Jul 08 17:22:36 2009 +0200
     5.3 @@ -20,7 +20,7 @@
     5.4  #define LEMON_FIB_HEAP_H
     5.5  
     5.6  ///\file
     5.7 -///\ingroup auxdat
     5.8 +///\ingroup heaps
     5.9  ///\brief Fibonacci heap implementation.
    5.10  
    5.11  #include <vector>
    5.12 @@ -30,7 +30,7 @@
    5.13  
    5.14  namespace lemon {
    5.15  
    5.16 -  /// \ingroup auxdat
    5.17 +  /// \ingroup heaps
    5.18    ///
    5.19    /// \brief Fibonacci heap data structure.
    5.20    ///
     6.1 --- a/lemon/radix_heap.h	Wed Jul 08 17:21:30 2009 +0200
     6.2 +++ b/lemon/radix_heap.h	Wed Jul 08 17:22:36 2009 +0200
     6.3 @@ -19,7 +19,7 @@
     6.4  #ifndef LEMON_RADIX_HEAP_H
     6.5  #define LEMON_RADIX_HEAP_H
     6.6  
     6.7 -///\ingroup auxdat
     6.8 +///\ingroup heaps
     6.9  ///\file
    6.10  ///\brief Radix heap implementation.
    6.11  
    6.12 @@ -29,7 +29,7 @@
    6.13  namespace lemon {
    6.14  
    6.15  
    6.16 -  /// \ingroup auxdat
    6.17 +  /// \ingroup heaps
    6.18    ///
    6.19    /// \brief Radix heap data structure.
    6.20    ///