556d98f84cca64391b740110c203b5ace4fa1305
[charm.git] / examples / charm++ / state_space_searchengine / 3SAT / minisat / mtl / .svn / text-base / BasicHeap.h.svn-base
1 /******************************************************************************************[Heap.h]
2 MiniSat -- Copyright (c) 2003-2006, Niklas Een, Niklas Sorensson
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
5 associated documentation files (the "Software"), to deal in the Software without restriction,
6 including without limitation the rights to use, copy, modify, merge, publish, distribute,
7 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
8 furnished to do so, subject to the following conditions:
9
10 The above copyright notice and this permission notice shall be included in all copies or
11 substantial portions of the Software.
12
13 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
14 NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
16 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
17 OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18 **************************************************************************************************/
19
20 #ifndef BasicHeap_h
21 #define BasicHeap_h
22
23 #include "Vec.h"
24
25 //=================================================================================================
26 // A heap implementation with support for decrease/increase key.
27
28
29 template<class Comp>
30 class BasicHeap {
31     Comp     lt;
32     vec<int> heap;     // heap of ints
33
34     // Index "traversal" functions
35     static inline int left  (int i) { return i*2+1; }
36     static inline int right (int i) { return (i+1)*2; }
37     static inline int parent(int i) { return (i-1) >> 1; }
38
39     inline void percolateUp(int i)
40     {
41         int x = heap[i];
42         while (i != 0 && lt(x, heap[parent(i)])){
43             heap[i]          = heap[parent(i)];
44             i                = parent(i);
45         }
46         heap   [i] = x;
47     }
48
49
50     inline void percolateDown(int i)
51     {
52         int x = heap[i];
53         while (left(i) < heap.size()){
54             int child = right(i) < heap.size() && lt(heap[right(i)], heap[left(i)]) ? right(i) : left(i);
55             if (!lt(heap[child], x)) break;
56             heap[i]          = heap[child];
57             i                = child;
58         }
59         heap[i] = x;
60     }
61
62
63     bool heapProperty(int i) {
64         return i >= heap.size()
65             || ((i == 0 || !lt(heap[i], heap[parent(i)])) && heapProperty(left(i)) && heapProperty(right(i))); }
66
67
68   public:
69     BasicHeap(const C& c) : comp(c) { }
70
71     int  size      ()                     const { return heap.size(); }
72     bool empty     ()                     const { return heap.size() == 0; }
73     int  operator[](int index)            const { return heap[index+1]; }
74     void clear     (bool dealloc = false)       { heap.clear(dealloc); }
75     void insert    (int n)                      { heap.push(n); percolateUp(heap.size()-1); }
76
77
78     int  removeMin() {
79         int r   = heap[0];
80         heap[0] = heap.last();
81         heap.pop();
82         if (heap.size() > 1) percolateDown(0);
83         return r; 
84     }
85
86
87     // DEBUG: consistency checking
88     bool heapProperty() {
89         return heapProperty(1); }
90
91
92     // COMPAT: should be removed
93     int  getmin    ()      { return removeMin(); }
94 };
95
96
97 //=================================================================================================
98 #endif