/* FIXME: Copyright ... 

  *

  * This implementation is heavily based on STL's heap functions and

  * the similar class by Alpar Juttner in IKTA...

  */

 /******

  *

  * BinHeap<KeyType, ValueType, KeyIntMap, [ValueCompare]>

  *

  * Ez az osztaly kulcs-ertek parok tarolasara alkalmas binaris kupacot

  * valosit meg.

  * A kupacban legfolul mindig az a par talalhato, amiben az _ertek_ a

  * legkisebb. (Gondolj a Dijkstra pont-tavolsag kupacara; igazabol ahhoz

  * lett keszitve...)

  *

  * Megjegyzes: egy kicsit gyanus nekem, hogy a kupacos temakorben nem

  * azt hivjak kulcsnak, amit most en annak nevezek. :) En olyan 

  * property_map -os ertelemben hasznalom.

  *

  * A hasznalatahoz szukseg van egy irhato/olvashato property_map-re, ami

  * a kulcsokhoz egy int-et tud tarolni (ezzel tudom megkeresni az illeto

  * elemet a kupacban a csokkentes es hasonlo muveletekhez).

  * A map-re csak referenciat tarol, ugy hogy a kupac elete folyan a map-nek

  * is elnie kell. (???)

  *

  * Ketfele modon hasznalhato:

  * Lusta mod:

  * put(Key, Value) metodussal pakolunk a kupacba,

  * aztan o majd eldonti, hogy ez az elem mar benne van-e es ha igen, akkor

  * csokkentettunk-e rajta, vagy noveltunk.

  * Ehhez nagyon fontos, hogy az atadott property map inicializalva legyen

  * minden szobajovo kulcs ertekre, -1 -es ertekkel!

  * Es ilyen esetben a kulcsokrol lekerdezheto az allapotuk a state metodussal:

  * (nem jart meg a kupacban PRE_HEAP=-1, epp a kupacban van IN_HEAP=0,

  *  mar kikerult a kupacbol POST_HEAP=-2).

  * Szoval ebben a modban a kupac nagyjabol hasznalhato property_map-kent, csak

  * meg meg tudja mondani a "legkisebb" erteku elemet. De csak nagyjabol,

  * hiszen a kupacbol kikerult elemeknek elvesz az ertekuk...

  *

  * Kozvetlen mod:

  * push(Key, Value) metodussal belerakunk a kupacba (ha az illeto kulcs mar

  * benn volt, akkor gaz).

  * increase/decrease(Key k, Value new_value) metodusokkal lehet

  * novelni/csokkenteni az illeto kulcshoz tartozo erteket. (Ha nem volt meg

  * benne a kupacban az illeto kulcs, vagy nem abba az iranyba valtoztattad

  * az erteket, amerre mondtad -- gaz).

  *

  * Termeszetesen a fenti ket modot ertelemszeruen lehet keverni.

  * Ja es mindig nagyon gaz, ha belepiszkalsz a map-be, amit a kupac

  * hasznal. :-))

  *

  *

  * Bocs, most faradt vagyok, majd egyszer leforditom. (Misi)

  *

  */

 #ifndef BIN_HEAP_HH

 #define BIN_HEAP_HH

 ///\file

 ///\brief Binary Heap implementation.

 #include <vector>

 #include <utility>

 #include <functional>

 namespace hugo {

   /// A Binary Heap implementation.

   template <typename Key, typename Val, typename KeyIntMap,

 	    typename Compare = std::less<Val> >

   class BinHeap {

   public:

     typedef Key	             KeyType;

     // FIXME: stl-ben nem ezt hivjak value_type -nak, hanem a kovetkezot...

     typedef Val              ValueType;

     typedef std::pair<KeyType,ValueType>     PairType;

     typedef KeyIntMap        KeyIntMapType;

     typedef Compare          ValueCompare;

     /**

      * Each Key element have a state associated to it. It may be "in heap",

      * "pre heap" or "post heap". The later two are indifferent from the

      * heap's point of view, but may be useful to the user.

      *

      * The KeyIntMap _should_ be initialized in such way, that it maps

      * PRE_HEAP (-1) to any element to be put in the heap...

      */

     ///\todo it is used nowhere

     ///

     enum state_enum {

       IN_HEAP = 0,

       PRE_HEAP = -1,

       POST_HEAP = -2

     };

   private:

     std::vector<PairType> data;

     Compare comp;

     // FIXME: jo ez igy???

     KeyIntMap &kim;

   public:

     BinHeap(KeyIntMap &_kim) : kim(_kim) {}

     BinHeap(KeyIntMap &_kim, const Compare &_comp) : comp(_comp), kim(_kim) {}

     int size() const { return data.size(); }

     bool empty() const { return data.empty(); }

   private:

     static int parent(int i) { return (i-1)/2; }

     static int second_child(int i) { return 2*i+2; }

     bool less(const PairType &p1, const PairType &p2) {

       return comp(p1.second, p2.second);

     }

     int bubble_up(int hole, PairType p);

     int bubble_down(int hole, PairType p, int length);

     void move(const PairType &p, int i) {

       data[i] = p;

       kim.set(p.first, i);

     }

     void rmidx(int h) {

       int n = data.size()-1;

       if( h>=0 && h<=n ) {

 	kim.set(data[h].first, POST_HEAP);

 	if ( h<n ) {

 	  bubble_down(h, data[n], n);

 	}

 	data.pop_back();

       }

     }

   public:

     void push(const PairType &p) {

       int n = data.size();

       data.resize(n+1);

       bubble_up(n, p);

     }

     void push(const Key &k, const Val &v) { push(PairType(k,v)); }

     Key top() const {

       // FIXME: test size>0 ?

       return data[0].first;

     }

     Val topValue() const {

       // FIXME: test size>0 ?

       return data[0].second;

     }

     void pop() {

       rmidx(0);

     }

     void erase(const Key &k) {

       rmidx(kim[k]);

     }

     Val operator[](const Key &k) const {

       int idx = kim[k];

       return data[idx].second;

     }

     void put(const Key &k, const Val &v) {

       int idx = kim[k];

       if( idx < 0 ) {

 	push(k,v);

       }

       else if( comp(v, data[idx].second) ) {

 	bubble_up(idx, PairType(k,v));

       }

       else {

 	bubble_down(idx, PairType(k,v), data.size());

       }

     }

     void decrease(const Key &k, const Val &v) {

       int idx = kim[k];

       bubble_up(idx, PairType(k,v));

     }

     void increase(const Key &k, const Val &v) {

       int idx = kim[k];

       bubble_down(idx, PairType(k,v), data.size());

     }

     state_enum state(const Key &k) const {

       int s = kim[k];

       if( s>=0 )

 	s=0;

       return state_enum(s);

     }

   }; // class BinHeap

   template <typename K, typename V, typename M, typename C>

   int BinHeap<K,V,M,C>::bubble_up(int hole, PairType p) {

     int par = parent(hole);

     while( hole>0 && less(p,data[par]) ) {

       move(data[par],hole);

       hole = par;

       par = parent(hole);

     }

     move(p, hole);

     return hole;

   }

   template <typename K, typename V, typename M, typename C>

   int BinHeap<K,V,M,C>::bubble_down(int hole, PairType p, int length) {

     int child = second_child(hole);

     while(child < length) {

       if( less(data[child-1], data[child]) ) {

 	--child;

       }

       if( !less(data[child], p) )

 	goto ok;

       move(data[child], hole);

       hole = child;

       child = second_child(hole);

     }

     child--;

     if( child<length && less(data[child], p) ) {

       move(data[child], hole);

       hole=child;

     }

   ok:

     move(p, hole);

     return hole;

   }

 } // namespace hugo

 #endif // BIN_HEAP_HH