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

Timestamp:

09/29/09 13:32:01 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Rename heap structures (#301)

• KaryHeap? --> DHeap
• FouraryHeap? --> QuadHeap?
• BinomHeap? --> BinomialHeap?

File:

• lemon/quad_heap.h (moved) (moved from lemon/fourary_heap.h) (7 diffs)

lemon/quad_heap.h

@@ -17 +17 @@
  */
 
-#ifndef LEMON_FOURARY_HEAP_H
-#define LEMON_FOURARY_HEAP_H
+#ifndef LEMON_QUAD_HEAP_H
+#define LEMON_QUAD_HEAP_H
 
 ///\ingroup heaps
 ///\file
-///\brief Fourary heap implementation.
+///\brief Fourary (quaternary) heap implementation.
 
 #include <vector>
@@ -32 +32 @@
   /// \ingroup heaps
   ///
-  ///\brief Fourary heap data structure.
-  ///
-  /// This class implements the \e fourary \e heap data structure.
+  ///\brief Fourary (quaternary) heap data structure.
+  ///
+  /// This class implements the \e Fourary (\e quaternary) \e heap
+  /// data structure.
   /// It fully conforms to the \ref concepts::Heap "heap concept".
   ///
-  /// The fourary heap is a specialization of the \ref KaryHeap "K-ary heap"
-  /// for <tt>K=4</tt>. It is similar to the \ref BinHeap "binary heap",
+  /// The fourary heap is a specialization of the \ref DHeap "D-ary heap"
+  /// for <tt>D=4</tt>. It is similar to the \ref BinHeap "binary heap",
   /// but its nodes have at most four children, instead of two.
   ///
@@ -48 +49 @@
   ///
   ///\sa BinHeap
-  ///\sa KaryHeap
+  ///\sa DHeap
 #ifdef DOXYGEN
   template <typename PR, typename IM, typename CMP>
@@ -54 +55 @@
   template <typename PR, typename IM, typename CMP = std::less<PR> >
 #endif
-  class FouraryHeap {
+  class QuadHeap {
   public:
     /// Type of the item-int map.
@@ -93 +94 @@
     /// It is used internally to handle the cross references.
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
-    explicit FouraryHeap(ItemIntMap &map) : _iim(map) {}
+    explicit QuadHeap(ItemIntMap &map) : _iim(map) {}
 
     /// \brief Constructor.
@@ -102 +103 @@
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
     /// \param comp The function object used for comparing the priorities.
-    FouraryHeap(ItemIntMap &map, const Compare &comp)
+    QuadHeap(ItemIntMap &map, const Compare &comp)
       : _iim(map), _comp(comp) {}
 
@@ -336 +337 @@
     }
 
-  }; // class FouraryHeap
+  }; // class QuadHeap
 
 } // namespace lemon