Minisat::Heap< Comp > Class Template Reference

#include <Heap.h>

Public Member Functions
	Heap (const Comp &c)
int	size () const
bool	empty () const
bool	inHeap (int n) const
int	operator[] (int index) const
void	decrease (int n)
void	increase (int n)
void	update (int n)
void	insert (int n)
int	removeMin ()
void	build (vec< int > &ns)
void	clear (bool dealloc=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
Comp	lt
vec< int >	heap
vec< int >	indices

Detailed Description

template<class Comp>
class Minisat::Heap< Comp >

Definition at line 33 of file Heap.h.

Constructor & Destructor Documentation

template<class Comp>

Minisat::Heap< Comp >::Heap ( const Comp &  c )

inline

Definition at line 76 of file Heap.h.

: lt(c) { }

Member Function Documentation

template<class Comp>

void Minisat::Heap< Comp >::build ( vec< int > &  ns )

inline

Definition at line 123 of file Heap.h.

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

        for (i = 0; i < ns.size(); i++){
            indices[ns[i]] = i;
            heap.push(ns[i]); }

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

template<class Comp>

void Minisat::Heap< Comp >::clear ( bool  dealloc = false )

inline

Definition at line 137 of file Heap.h.

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

template<class Comp>

void Minisat::Heap< Comp >::decrease ( int  n )

inline

Definition at line 84 of file Heap.h.

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

template<class Comp>

bool Minisat::Heap< Comp >::empty ( ) const

inline

Definition at line 79 of file Heap.h.

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

template<class Comp>

void Minisat::Heap< Comp >::increase ( int  n )

inline

Definition at line 85 of file Heap.h.

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

template<class Comp>

bool Minisat::Heap< Comp >::inHeap ( int  n ) const

inline

Definition at line 80 of file Heap.h.

{ return n < indices.size() && indices[n] >= 0; }

template<class Comp>

void Minisat::Heap< Comp >::insert ( int  n )

inline

Definition at line 99 of file Heap.h.

    {
        indices.growTo(n+1, -1);
        assert(!inHeap(n));

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

template<class Comp>

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

inlinestaticprivate

Definition at line 39 of file Heap.h.

{ return i*2+1; }

template<class Comp>

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

inline

Definition at line 81 of file Heap.h.

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

template<class Comp>

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

inlinestaticprivate

Definition at line 41 of file Heap.h.

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

template<class Comp>

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

inlineprivate

Definition at line 60 of file Heap.h.

    {
        int 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;
    }

template<class Comp>

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

inlineprivate

Definition at line 44 of file Heap.h.

    {
        int 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;
    }

template<class Comp>

int Minisat::Heap< Comp >::removeMin ( )

inline

Definition at line 110 of file Heap.h.

    {
        int 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 Comp>

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

inlinestaticprivate

Definition at line 40 of file Heap.h.

{ return (i+1)*2; }

template<class Comp>

int Minisat::Heap< Comp >::size ( ) const

inline

Definition at line 78 of file Heap.h.

{ return heap.size(); }

template<class Comp>

void Minisat::Heap< Comp >::update ( int  n )

inline

Definition at line 89 of file Heap.h.

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

Field Documentation

template<class Comp>

vec<int> Minisat::Heap< Comp >::heap

private

Definition at line 35 of file Heap.h.

template<class Comp>

vec<int> Minisat::Heap< Comp >::indices

private

Definition at line 36 of file Heap.h.

template<class Comp>

Comp Minisat::Heap< Comp >::lt

private

Definition at line 34 of file Heap.h.

---

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

• Heap.h