COIN-OR::LEMON - Graph Library

Changeset 929:65a0521e744e in lemon for lemon/quad_heap.h


Ignore:
Timestamp:
09/29/09 13:32:01 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Rename heap structures (#301)

File:
1 moved

Legend:

Unmodified
Added
Removed
  • lemon/quad_heap.h

    r753 r929  
    1717 */
    1818
    19 #ifndef LEMON_FOURARY_HEAP_H
    20 #define LEMON_FOURARY_HEAP_H
     19#ifndef LEMON_QUAD_HEAP_H
     20#define LEMON_QUAD_HEAP_H
    2121
    2222///\ingroup heaps
    2323///\file
    24 ///\brief Fourary heap implementation.
     24///\brief Fourary (quaternary) heap implementation.
    2525
    2626#include <vector>
     
    3232  /// \ingroup heaps
    3333  ///
    34   ///\brief Fourary heap data structure.
    35   ///
    36   /// This class implements the \e fourary \e heap data structure.
     34  ///\brief Fourary (quaternary) heap data structure.
     35  ///
     36  /// This class implements the \e Fourary (\e quaternary) \e heap
     37  /// data structure.
    3738  /// It fully conforms to the \ref concepts::Heap "heap concept".
    3839  ///
    39   /// The fourary heap is a specialization of the \ref KaryHeap "K-ary heap"
    40   /// for <tt>K=4</tt>. It is similar to the \ref BinHeap "binary heap",
     40  /// The fourary heap is a specialization of the \ref DHeap "D-ary heap"
     41  /// for <tt>D=4</tt>. It is similar to the \ref BinHeap "binary heap",
    4142  /// but its nodes have at most four children, instead of two.
    4243  ///
     
    4849  ///
    4950  ///\sa BinHeap
    50   ///\sa KaryHeap
     51  ///\sa DHeap
    5152#ifdef DOXYGEN
    5253  template <typename PR, typename IM, typename CMP>
     
    5455  template <typename PR, typename IM, typename CMP = std::less<PR> >
    5556#endif
    56   class FouraryHeap {
     57  class QuadHeap {
    5758  public:
    5859    /// Type of the item-int map.
     
    9394    /// It is used internally to handle the cross references.
    9495    /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
    95     explicit FouraryHeap(ItemIntMap &map) : _iim(map) {}
     96    explicit QuadHeap(ItemIntMap &map) : _iim(map) {}
    9697
    9798    /// \brief Constructor.
     
    102103    /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
    103104    /// \param comp The function object used for comparing the priorities.
    104     FouraryHeap(ItemIntMap &map, const Compare &comp)
     105    QuadHeap(ItemIntMap &map, const Compare &comp)
    105106      : _iim(map), _comp(comp) {}
    106107
     
    336337    }
    337338
    338   }; // class FouraryHeap
     339  }; // class QuadHeap
    339340
    340341} // namespace lemon
Note: See TracChangeset for help on using the changeset viewer.