Docs are now divided into modules.
3 /* FIXME: Copyright ...
5 * This implementation is heavily based on STL's heap functions and
6 * the similar class by Alpar Juttner in IKTA...
11 * BinHeap<ItemType, PrioType, ItemIntMap, [PrioCompare]>
13 * Ez az osztaly item-prioritas parok tarolasara alkalmas binaris kupacot
15 * A kupacban legfolul mindig az a par talalhato, amiben a prioritas a
16 * legkisebb. (Gondolj a Dijkstra pont-tavolsag kupacara; igazabol ahhoz
19 * Megjegyzes: a kupacos temakorokben a prioritast kulcsnak szoktak nevezni,
20 * de mivel ez zavaro tud lenni a property-map-es kulcs-ertek szohasznalata
21 * miatt, megprobaltunk valami semleges elnevezeseket kitalalni.
23 * A hasznalatahoz szukseg van egy irhato/olvashato property_map-re, ami
24 * az itemekhez egy int-et tud tarolni (ezzel tudom megkeresni az illeto
25 * elemet a kupacban a csokkentes es hasonlo muveletekhez).
26 * A map-re csak referenciat tarol, ugy hogy a kupac elete folyan a map-nek
27 * is elnie kell. (???)
29 * Ketfele modon hasznalhato:
31 * set(Item, Prio) metodussal pakolunk a kupacba,
32 * aztan o majd eldonti, hogy ez az elem mar benne van-e es ha igen, akkor
33 * csokkentettunk-e rajta, vagy noveltunk.
34 * Ehhez nagyon fontos, hogy az atadott property map inicializalva legyen
35 * minden szobajovo kulcs ertekre, -1 -es ertekkel!
36 * Es ilyen esetben a kulcsokrol lekerdezheto az allapotuk a state metodussal:
37 * (nem jart meg a kupacban PRE_HEAP=-1, epp a kupacban van IN_HEAP=0,
38 * mar kikerult a kupacbol POST_HEAP=-2).
39 * Szoval ebben a modban a kupac nagyjabol hasznalhato property_map-kent, csak
40 * meg meg tudja mondani a "legkisebb" prioritasu elemet. De csak nagyjabol,
41 * hiszen a kupacbol kikerult elemeknek elvesz az ertekuk...
44 * push(Item, Prio) metodussal belerakunk a kupacba (ha az illeto kulcs mar
45 * benn volt, akkor gaz).
46 * increase/decrease(Item i, Prio new_prio) metodusokkal lehet
47 * novelni/csokkenteni az illeto elemhez tartozo prioritast. (Ha nem volt
48 * megbenne a kupacban az illeto elem, vagy nem abba az iranyba valtoztattad
49 * az erteket, amerre mondtad -- gaz).
51 * Termeszetesen a fenti ket modot ertelemszeruen lehet keverni.
52 * Ja es mindig nagyon gaz, ha belepiszkalsz a map-be, amit a kupac
56 * Bocs, most faradt vagyok, majd egyszer leforditom. (Misi)
65 ///\brief Binary Heap implementation.
73 /// A Binary Heap implementation.
74 template <typename Item, typename Prio, typename ItemIntMap,
75 typename Compare = std::less<Prio> >
79 typedef Item ItemType;
80 // FIXME: stl-ben nem ezt hivjak value_type -nak, hanem a kovetkezot...
81 typedef Prio PrioType;
82 typedef std::pair<ItemType,PrioType> PairType;
83 typedef ItemIntMap ItemIntMapType;
84 typedef Compare PrioCompare;
87 * Each Item element have a state associated to it. It may be "in heap",
88 * "pre heap" or "post heap". The later two are indifferent from the
89 * heap's point of view, but may be useful to the user.
91 * The ItemIntMap _should_ be initialized in such way, that it maps
92 * PRE_HEAP (-1) to any element to be put in the heap...
94 ///\todo it is used nowhere
103 std::vector<PairType> data;
105 // FIXME: jo ez igy???
109 BinHeap(ItemIntMap &_iim) : iim(_iim) {}
110 BinHeap(ItemIntMap &_iim, const Compare &_comp) : comp(_comp), iim(_iim) {}
113 int size() const { return data.size(); }
114 bool empty() const { return data.empty(); }
117 static int parent(int i) { return (i-1)/2; }
118 static int second_child(int i) { return 2*i+2; }
119 bool less(const PairType &p1, const PairType &p2) const {
120 return comp(p1.second, p2.second);
123 int bubble_up(int hole, PairType p);
124 int bubble_down(int hole, PairType p, int length);
126 void move(const PairType &p, int i) {
132 int n = data.size()-1;
134 iim.set(data[h].first, POST_HEAP);
136 bubble_down(h, data[n], n);
143 void push(const PairType &p) {
148 void push(const Item &i, const Prio &p) { push(PairType(i,p)); }
151 return data[0].first;
153 /// Returns the prio of the top element of the heap.
155 return data[0].second;
162 void erase(const Item &i) {
166 Prio operator[](const Item &i) const {
168 return data[idx].second;
171 void set(const Item &i, const Prio &p) {
176 else if( comp(p, data[idx].second) ) {
177 bubble_up(idx, PairType(i,p));
180 bubble_down(idx, PairType(i,p), data.size());
184 void decrease(const Item &i, const Prio &p) {
186 bubble_up(idx, PairType(i,p));
188 void increase(const Item &i, const Prio &p) {
190 bubble_down(idx, PairType(i,p), data.size());
193 state_enum state(const Item &i) const {
197 return state_enum(s);
203 template <typename K, typename V, typename M, typename C>
204 int BinHeap<K,V,M,C>::bubble_up(int hole, PairType p) {
205 int par = parent(hole);
206 while( hole>0 && less(p,data[par]) ) {
207 move(data[par],hole);
215 template <typename K, typename V, typename M, typename C>
216 int BinHeap<K,V,M,C>::bubble_down(int hole, PairType p, int length) {
217 int child = second_child(hole);
218 while(child < length) {
219 if( less(data[child-1], data[child]) ) {
222 if( !less(data[child], p) )
224 move(data[child], hole);
226 child = second_child(hole);
229 if( child<length && less(data[child], p) ) {
230 move(data[child], hole);
240 #endif // BIN_HEAP_HH