Minisat::Heap< K, Comp, MkIndex > Class Template Reference

#include <Heap.h>

Collaboration diagram for Minisat::Heap< K, Comp, MkIndex >:

Public Member Functions
	Heap (const Comp &c, MkIndex _index=MkIndex())
int	size () const
bool	empty () const
bool	inHeap (K k) const
int	operator[] (int index) const
void	decrease (K k)
void	increase (K k)
void	update (K k)
void	insert (K k)
void	remove (K k)
K	removeMin ()
void	build (const vec< K > &ns)
void	clear (bool dispose=false)

Private Member Functions
void	percolateUp (int i)
void	percolateDown (int i)

Static Private Member Functions
static int	left (int i)
static int	right (int i)
static int	parent (int i)

Private Attributes
vec< K >	heap
IntMap< K, int, MkIndex >	indices
Comp	lt

Detailed Description

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>
class Minisat::Heap< K, Comp, MkIndex >

Definition at line 34 of file Heap.h.

Constructor & Destructor Documentation

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

Minisat::Heap< K, Comp, MkIndex >::Heap ( const Comp &  c, MkIndex  _index = MkIndex()  )

inline

Definition at line 77 of file Heap.h.

: indices(_index), lt(c) {}

Member Function Documentation

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::build ( const vec< K > &  ns )

inline

Definition at line 140 of file Heap.h.

                                 {
        for (int i = 0; i < heap.size(); i++)
            indices[heap[i]] = -1;
        heap.clear();

        for (int i = 0; i < ns.size(); i++){
            // TODO: this should probably call reserve instead of relying on it being reserved already.
            assert(indices.has(ns[i]));
            indices[ns[i]] = i;
            heap.push(ns[i]); }

        for (int i = heap.size() / 2 - 1; i >= 0; i--)
            percolateDown(i);
    }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::clear ( bool  dispose = false )

inline

Definition at line 155 of file Heap.h.

    { 
        // TODO: shouldn't the 'indices' map also be dispose-cleared?
        for (int i = 0; i < heap.size(); i++)
            indices[heap[i]] = -1;
        heap.clear(dispose); 
    }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::decrease ( K  k )

inline

Definition at line 84 of file Heap.h.

{ assert(inHeap(k)); percolateUp  (indices[k]); }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

bool Minisat::Heap< K, Comp, MkIndex >::empty ( ) const

inline

Definition at line 80 of file Heap.h.

{ return heap.size() == 0; }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::increase ( K  k )

inline

Definition at line 85 of file Heap.h.

{ assert(inHeap(k)); percolateDown(indices[k]); }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

bool Minisat::Heap< K, Comp, MkIndex >::inHeap ( K  k ) const

inline

Definition at line 81 of file Heap.h.

{ return indices.has(k) && indices[k] >= 0; }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::insert ( K  k )

inline

Definition at line 99 of file Heap.h.

    {
        indices.reserve(k, -1);
        assert(!inHeap(k));

        indices[k] = heap.size();
        heap.push(k);
        percolateUp(indices[k]);
    }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

static int Minisat::Heap< K, Comp, MkIndex >::left ( int  i )

inlinestaticprivate

Definition at line 40 of file Heap.h.

{ return i*2+1; }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

int Minisat::Heap< K, Comp, MkIndex >::operator[] ( int  index ) const

inline

Definition at line 82 of file Heap.h.

{ assert(index < heap.size()); return heap[index]; }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

static int Minisat::Heap< K, Comp, MkIndex >::parent ( int  i )

inlinestaticprivate

Definition at line 42 of file Heap.h.

{ return (i-1) >> 1; }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::percolateDown ( int  i )

inlineprivate

Definition at line 61 of file Heap.h.

    {
        K x = heap[i];
        while (left(i) < heap.size()){
            int child = right(i) < heap.size() && lt(heap[right(i)], heap[left(i)]) ? right(i) : left(i);
            if (!lt(heap[child], x)) break;
            heap[i]          = heap[child];
            indices[heap[i]] = i;
            i                = child;
        }
        heap   [i] = x;
        indices[x] = i;
    }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::percolateUp ( int  i )

inlineprivate

Definition at line 45 of file Heap.h.

    {
        K   x  = heap[i];
        int p  = parent(i);
        
        while (i != 0 && lt(x, heap[p])){
            heap[i]          = heap[p];
            indices[heap[p]] = i;
            i                = p;
            p                = parent(p);
        }
        heap   [i] = x;
        indices[x] = i;
    }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::remove ( K  k )

inline

Definition at line 110 of file Heap.h.

    {
        assert(inHeap(k));

        int k_pos  = indices[k];
        indices[k] = -1;

        if (k_pos < heap.size()-1){
            heap[k_pos]          = heap.last();
            indices[heap[k_pos]] = k_pos;
            heap.pop();
            percolateDown(k_pos);
        }else
            heap.pop();
    }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

K Minisat::Heap< K, Comp, MkIndex >::removeMin ( )

inline

Definition at line 127 of file Heap.h.

    {
        K x              = heap[0];
        heap[0]          = heap.last();
        indices[heap[0]] = 0;
        indices[x]       = -1;
        heap.pop();
        if (heap.size() > 1) percolateDown(0);
        return x; 
    }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

static int Minisat::Heap< K, Comp, MkIndex >::right ( int  i )

inlinestaticprivate

Definition at line 41 of file Heap.h.

{ return (i+1)*2; }

Here is the caller graph for this function:

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

int Minisat::Heap< K, Comp, MkIndex >::size ( ) const

inline

Definition at line 79 of file Heap.h.

{ return heap.size(); }

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

void Minisat::Heap< K, Comp, MkIndex >::update ( K  k )

inline

Definition at line 89 of file Heap.h.

    {
        if (!inHeap(k))
            insert(k);
        else {
            percolateUp(indices[k]);
            percolateDown(indices[k]); }
    }

Field Documentation

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

vec<K> Minisat::Heap< K, Comp, MkIndex >::heap

private

Definition at line 35 of file Heap.h.

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

IntMap<K,int,MkIndex> Minisat::Heap< K, Comp, MkIndex >::indices

private

Definition at line 36 of file Heap.h.

template<class K, class Comp, class MkIndex = MkIndexDefault<K>>

Comp Minisat::Heap< K, Comp, MkIndex >::lt

private

Definition at line 37 of file Heap.h.

---

The documentation for this class was generated from the following file:

• Heap.h