glucose-syrup/mtl/Heap.h

   1 /******************************************************************************************[Heap.h]
   2 Copyright (c) 2003-2006, Niklas Een, Niklas Sorensson
   3 Copyright (c) 2007-2010, Niklas Sorensson
   4
   5 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
   6 associated documentation files (the "Software"), to deal in the Software without restriction,
   7 including without limitation the rights to use, copy, modify, merge, publish, distribute,
   8 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
   9 furnished to do so, subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all copies or
  12 substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
  15 NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  16 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  17 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
  18 OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 **************************************************************************************************/
  20
  21 #ifndef Glucose_Heap_h
  22 #define Glucose_Heap_h
  23
  24 #include "mtl/Vec.h"
  25
  26 namespace Glucose {
  27
  28 //=================================================================================================
  29 // A heap implementation with support for decrease/increase key.
  30
  31
  32 template<class Comp>
  33 class Heap {
  34     Comp     lt;       // The heap is a minimum-heap with respect to this comparator
  35     vec<int> heap;     // Heap of integers
  36     vec<int> indices;  // Each integers position (index) in the Heap
  37
  38     // Index "traversal" functions
  39     static inline int left  (int i) { return i*2+1; }
  40     static inline int right (int i) { return (i+1)*2; }
  41     static inline int parent(int i) { return (i-1) >> 1; }
  42
  43
  44
  45     void percolateUp(int i)
  46     {
  47         int x  = heap[i];
  48         int p  = parent(i);
  49
  50         while (i != 0 && lt(x, heap[p])){
  51             heap[i]          = heap[p];
  52             indices[heap[p]] = i;
  53             i                = p;
  54             p                = parent(p);
  55         }
  56         heap   [i] = x;
  57         indices[x] = i;
  58     }
  59
  60
  61     void percolateDown(int i)
  62     {
  63         int x = heap[i];
  64         while (left(i) < heap.size()){
  65             int child = right(i) < heap.size() && lt(heap[right(i)], heap[left(i)]) ? right(i) : left(i);
  66             if (!lt(heap[child], x)) break;
  67             heap[i]          = heap[child];
  68             indices[heap[i]] = i;
  69             i                = child;
  70         }
  71         heap   [i] = x;
  72         indices[x] = i;
  73     }
  74
  75
  76   public:
  77     Heap(const Comp& c) : lt(c) { }
  78
  79     int  size      ()          const { return heap.size(); }
  80     bool empty     ()          const { return heap.size() == 0; }
  81     bool inHeap    (int n)     const { return n < indices.size() && indices[n] >= 0; }
  82     int  operator[](int index) const { assert(index < heap.size()); return heap[index]; }
  83
  84
  85     void decrease  (int n) { assert(inHeap(n)); percolateUp  (indices[n]); }
  86     void increase  (int n) { assert(inHeap(n)); percolateDown(indices[n]); }
  87
  88     void copyTo(Heap& copy) const {heap.copyTo(copy.heap);indices.copyTo(copy.indices);}
  89
  90     // Safe variant of insert/decrease/increase:
  91     void update(int n)
  92     {
  93         if (!inHeap(n))
  94             insert(n);
  95         else {
  96             percolateUp(indices[n]);
  97             percolateDown(indices[n]); }
  98     }
  99
 100
 101     void insert(int n)
 102     {
 103         indices.growTo(n+1, -1);
 104         assert(!inHeap(n));
 105
 106         indices[n] = heap.size();
 107         heap.push(n);
 108         percolateUp(indices[n]);
 109     }
 110
 111
 112     int  removeMin()
 113     {
 114         int x            = heap[0];
 115         heap[0]          = heap.last();
 116         indices[heap[0]] = 0;
 117         indices[x]       = -1;
 118         heap.pop();
 119         if (heap.size() > 1) percolateDown(0);
 120         return x;
 121     }
 122
 123
 124     // Rebuild the heap from scratch, using the elements in 'ns':
 125     void build(vec<int>& ns) {
 126         for (int i = 0; i < heap.size(); i++)
 127             indices[heap[i]] = -1;
 128         heap.clear();
 129
 130         for (int i = 0; i < ns.size(); i++){
 131             indices[ns[i]] = i;
 132             heap.push(ns[i]); }
 133
 134         for (int i = heap.size() / 2 - 1; i >= 0; i--)
 135             percolateDown(i);
 136     }
 137
 138     void clear(bool dealloc = false)
 139     {
 140         for (int i = 0; i < heap.size(); i++)
 141             indices[heap[i]] = -1;
 142         heap.clear(dealloc);
 143     }
 144 };
 145
 146
 147 //=================================================================================================
 148 }
 149
 150 #endif