Changeset 855:65a0521e744e in lemon-main

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?

Files:

• lemon/Makefile.am (modified) (5 diffs)
• lemon/binomial_heap.h (moved) (moved from lemon/binom_heap.h) (6 diffs)
• lemon/dheap.h (moved) (moved from lemon/kary_heap.h) (8 diffs)
• lemon/quad_heap.h (moved) (moved from lemon/fourary_heap.h) (7 diffs)
• test/heap_test.cc (modified) (3 diffs)

lemon/Makefile.am

@@ -61 +61 @@
         lemon/bfs.h \
         lemon/bin_heap.h \
-        lemon/binom_heap.h \
+        lemon/binomial_heap.h \
         lemon/bucket_heap.h \
         lemon/cbc.h \
@@ -73 +73 @@
         lemon/cplex.h \
         lemon/dfs.h \
+        lemon/dheap.h \
         lemon/dijkstra.h \
         lemon/dim2.h \
@@ -81 +82 @@
         lemon/euler.h \
         lemon/fib_heap.h \
-        lemon/fourary_heap.h \
         lemon/full_graph.h \
         lemon/glpk.h \
@@ -88 +88 @@
         lemon/grid_graph.h \
         lemon/hypercube_graph.h \
-        lemon/kary_heap.h \
         lemon/kruskal.h \
         lemon/hao_orlin.h \
@@ -106 +105 @@
         lemon/path.h \
         lemon/preflow.h \
+        lemon/quad_heap.h \
         lemon/radix_heap.h \
         lemon/radix_sort.h \

lemon/binomial_heap.h

@@ -17 +17 @@
  */
 
-#ifndef LEMON_BINOM_HEAP_H
-#define LEMON_BINOM_HEAP_H
+#ifndef LEMON_BINOMIAL_HEAP_H
+#define LEMON_BINOMIAL_HEAP_H
 
 ///\file
@@ -54 +54 @@
   template <typename PR, typename IM, typename CMP = std::less<PR> >
 #endif
-  class BinomHeap {
+  class BinomialHeap {
   public:
     /// Type of the item-int map.
@@ -95 +95 @@
     /// It is used internally to handle the cross references.
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
-    explicit BinomHeap(ItemIntMap &map)
+    explicit BinomialHeap(ItemIntMap &map)
       : _min(0), _head(-1), _iim(map), _num_items(0) {}
 
@@ -105 +105 @@
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
     /// \param comp The function object used for comparing the priorities.
-    BinomHeap(ItemIntMap &map, const Compare &comp)
+    BinomialHeap(ItemIntMap &map, const Compare &comp)
       : _min(0), _head(-1), _iim(map), _comp(comp), _num_items(0) {}
 
@@ -425 +425 @@
 
     class Store {
-      friend class BinomHeap;
+      friend class BinomialHeap;
 
       Item name;
@@ -442 +442 @@
 } //namespace lemon
 
-#endif //LEMON_BINOM_HEAP_H
-
+#endif //LEMON_BINOMIAL_HEAP_H
+

lemon/dheap.h

@@ -17 +17 @@
  */
 
-#ifndef LEMON_KARY_HEAP_H
-#define LEMON_KARY_HEAP_H
+#ifndef LEMON_DHEAP_H
+#define LEMON_DHEAP_H
 
 ///\ingroup heaps
 ///\file
-///\brief Fourary heap implementation.
+///\brief D-ary heap implementation.
 
 #include <vector>
@@ -32 +32 @@
   /// \ingroup heaps
   ///
-  ///\brief K-ary heap data structure.
-  ///
-  /// This class implements the \e K-ary \e heap data structure.
+  ///\brief D-ary heap data structure.
+  ///
+  /// This class implements the \e D-ary \e heap data structure.
   /// It fully conforms to the \ref concepts::Heap "heap concept".
   ///
-  /// The \ref KaryHeap "K-ary heap" is a generalization of the
+  /// The \ref DHeap "D-ary heap" is a generalization of the
   /// \ref BinHeap "binary heap" structure, its nodes have at most
-  /// \c K children, instead of two.
-  /// \ref BinHeap and \ref FouraryHeap are specialized implementations
-  /// of this structure for <tt>K=2</tt> and <tt>K=4</tt>, respectively.
+  /// \c D children, instead of two.
+  /// \ref BinHeap and \ref QuadHeap are specialized implementations
+  /// of this structure for <tt>D=2</tt> and <tt>D=4</tt>, respectively.
   ///
   /// \tparam PR Type of the priorities of the items.
   /// \tparam IM A read-writable item map with \c int values, used
   /// internally to handle the cross references.
-  /// \tparam K The degree of the heap, each node have at most \e K
+  /// \tparam D The degree of the heap, each node have at most \e D
   /// children. The default is 16. Powers of two are suggested to use
   /// so that the multiplications and divisions needed to traverse the
@@ -56 +56 @@
   ///\sa FouraryHeap
 #ifdef DOXYGEN
-  template <typename PR, typename IM, int K, typename CMP>
+  template <typename PR, typename IM, int D, typename CMP>
 #else
-  template <typename PR, typename IM, int K = 16,
+  template <typename PR, typename IM, int D = 16,
             typename CMP = std::less<PR> >
 #endif
-  class KaryHeap {
+  class DHeap {
   public:
     /// Type of the item-int map.
@@ -100 +100 @@
     /// It is used internally to handle the cross references.
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
-    explicit KaryHeap(ItemIntMap &map) : _iim(map) {}
+    explicit DHeap(ItemIntMap &map) : _iim(map) {}
 
     /// \brief Constructor.
@@ -109 +109 @@
     /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
     /// \param comp The function object used for comparing the priorities.
-    KaryHeap(ItemIntMap &map, const Compare &comp)
+    DHeap(ItemIntMap &map, const Compare &comp)
       : _iim(map), _comp(comp) {}
 
@@ -132 +132 @@
 
   private:
-    int parent(int i) { return (i-1)/K; }
-    int firstChild(int i) { return K*i+1; }
+    int parent(int i) { return (i-1)/D; }
+    int firstChild(int i) { return D*i+1; }
 
     bool less(const Pair &p1, const Pair &p2) const {
@@ -152 +152 @@
       if( length>1 ) {
         int child = firstChild(hole);
-        while( child+K<=length ) {
+        while( child+D<=length ) {
           int min=child;
-          for (int i=1; i<K; ++i) {
+          for (int i=1; i<D; ++i) {
             if( less(_data[child+i], _data[min]) )
               min=child+i;
@@ -346 +346 @@
     }
 
-  }; // class KaryHeap
+  }; // class DHeap
 
 } // namespace lemon
 
-#endif // LEMON_KARY_HEAP_H
+#endif // LEMON_DHEAP_H

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

test/heap_test.cc

@@ -31 +31 @@
 
 #include <lemon/bin_heap.h>
-#include <lemon/fourary_heap.h>
-#include <lemon/kary_heap.h>
+#include <lemon/quad_heap.h>
+#include <lemon/dheap.h>
 #include <lemon/fib_heap.h>
 #include <lemon/pairing_heap.h>
 #include <lemon/radix_heap.h>
-#include <lemon/binom_heap.h>
+#include <lemon/binomial_heap.h>
 #include <lemon/bucket_heap.h>
 
@@ -186 +186 @@
   }
 
-  // FouraryHeap
-  {
-    typedef FouraryHeap<Prio, ItemIntMap> IntHeap;
-    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
-    heapSortTest<IntHeap>();
-    heapIncreaseTest<IntHeap>();
-
-    typedef FouraryHeap<Prio, IntNodeMap > NodeHeap;
-    checkConcept<Heap<Prio, IntNodeMap >, NodeHeap>();
-    dijkstraHeapTest<NodeHeap>(digraph, length, source);
-  }
-
-  // KaryHeap
-  {
-    typedef KaryHeap<Prio, ItemIntMap> IntHeap;
-    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
-    heapSortTest<IntHeap>();
-    heapIncreaseTest<IntHeap>();
-
-    typedef KaryHeap<Prio, IntNodeMap > NodeHeap;
+  // QuadHeap
+  {
+    typedef QuadHeap<Prio, ItemIntMap> IntHeap;
+    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
+    heapSortTest<IntHeap>();
+    heapIncreaseTest<IntHeap>();
+
+    typedef QuadHeap<Prio, IntNodeMap > NodeHeap;
+    checkConcept<Heap<Prio, IntNodeMap >, NodeHeap>();
+    dijkstraHeapTest<NodeHeap>(digraph, length, source);
+  }
+
+  // DHeap
+  {
+    typedef DHeap<Prio, ItemIntMap> IntHeap;
+    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
+    heapSortTest<IntHeap>();
+    heapIncreaseTest<IntHeap>();
+
+    typedef DHeap<Prio, IntNodeMap > NodeHeap;
     checkConcept<Heap<Prio, IntNodeMap >, NodeHeap>();
     dijkstraHeapTest<NodeHeap>(digraph, length, source);
@@ -246 +246 @@
   }
 
-  // BinomHeap
-  {
-    typedef BinomHeap<Prio, ItemIntMap> IntHeap;
-    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
-    heapSortTest<IntHeap>();
-    heapIncreaseTest<IntHeap>();
-
-    typedef BinomHeap<Prio, IntNodeMap > NodeHeap;
+  // BinomialHeap
+  {
+    typedef BinomialHeap<Prio, ItemIntMap> IntHeap;
+    checkConcept<Heap<Prio, ItemIntMap>, IntHeap>();
+    heapSortTest<IntHeap>();
+    heapIncreaseTest<IntHeap>();
+
+    typedef BinomialHeap<Prio, IntNodeMap > NodeHeap;
     checkConcept<Heap<Prio, IntNodeMap >, NodeHeap>();
     dijkstraHeapTest<NodeHeap>(digraph, length, source);