COIN-OR::LEMON - Graph Library

Changeset 710:f1fe0ddad6f7 in lemon-1.2


Ignore:
Timestamp:
07/08/09 17:22:36 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Move the heaps to a separate group (#299)

Files:
6 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r663 r710  
    227227
    228228/**
    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 /**
    237229@defgroup paths Path Structures
    238230@ingroup datas
     
    247239any kind of path structure.
    248240
    249 \sa lemon::concepts::Path
     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
     249This group contains the heap structures implemented in LEMON.
     250
     251LEMON provides several heap classes. They are efficient implementations
     252of the abstract data type \e priority \e queue. They store items with
     253specified values called \e priorities in such a way that finding and
     254removing the item with minimum priority are efficient.
     255The basic operations are adding and erasing items, changing the priority
     256of an item, etc.
     257
     258Heaps are crucial in several algorithms, such as Dijkstra and Prim.
     259The heap implementations have the same interface, thus any of them can be
     260used 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
     270This group contains two dimensional data storages implemented in LEMON.
    250271*/
    251272
  • lemon/bin_heap.h

    r709 r710  
    2020#define LEMON_BIN_HEAP_H
    2121
    22 ///\ingroup auxdat
     22///\ingroup heaps
    2323///\file
    2424///\brief Binary heap implementation.
     
    3030namespace lemon {
    3131
    32   /// \ingroup auxdat
     32  /// \ingroup heaps
    3333  ///
    3434  /// \brief Binary heap data structure.
  • lemon/bucket_heap.h

    r709 r710  
    2020#define LEMON_BUCKET_HEAP_H
    2121
    22 ///\ingroup auxdat
     22///\ingroup heaps
    2323///\file
    2424///\brief Bucket heap implementation.
     
    5454  }
    5555
    56   /// \ingroup auxdat
     56  /// \ingroup heaps
    5757  ///
    5858  /// \brief Bucket heap data structure.
     
    372372  }; // class BucketHeap
    373373
    374   /// \ingroup auxdat
     374  /// \ingroup heaps
    375375  ///
    376376  /// \brief Simplified bucket heap data structure.
  • lemon/concepts/heap.h

    r709 r710  
    3737    ///
    3838    /// 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
    4040    /// implementations of the abstract data type \e priority \e queue.
    4141    /// They store items with specified values called \e priorities
  • lemon/fib_heap.h

    r709 r710  
    2121
    2222///\file
    23 ///\ingroup auxdat
     23///\ingroup heaps
    2424///\brief Fibonacci heap implementation.
    2525
     
    3131namespace lemon {
    3232
    33   /// \ingroup auxdat
     33  /// \ingroup heaps
    3434  ///
    3535  /// \brief Fibonacci heap data structure.
  • lemon/radix_heap.h

    r709 r710  
    2020#define LEMON_RADIX_HEAP_H
    2121
    22 ///\ingroup auxdat
     22///\ingroup heaps
    2323///\file
    2424///\brief Radix heap implementation.
     
    3030
    3131
    32   /// \ingroup auxdat
     32  /// \ingroup heaps
    3333  ///
    3434  /// \brief Radix heap data structure.
Note: See TracChangeset for help on using the changeset viewer.