src/work/alpar/dijkstra/fib_heap.h
author alpar
Sun, 21 Mar 2004 14:59:51 +0000
changeset 224 5bc1c83257f8
parent 222 0c6bd3a98edf
child 242 b255f25ad394
permissions -rw-r--r--
Some doc added
alpar@222
     1
// -*- C++ -*-
alpar@222
     2
/*
alpar@222
     3
 *template <typename Item, 
alpar@222
     4
 *          typename Prio, 
alpar@222
     5
 *          typename ItemIntMap, 
alpar@222
     6
 *          typename Compare = std::less<Prio> >
alpar@222
     7
 * 
alpar@222
     8
 *constructors:
alpar@222
     9
 *
alpar@222
    10
 *FibHeap(ItemIntMap),   FibHeap(ItemIntMap, Compare)
alpar@222
    11
 *
alpar@222
    12
 *Member functions:
alpar@222
    13
 *
alpar@222
    14
 *int size() : returns the number of elements in the heap
alpar@222
    15
 *
alpar@222
    16
 *bool empty() : true iff size()=0
alpar@222
    17
 *
alpar@222
    18
 *void set(Item, Prio) : calls push(Item, Prio) if Item is not
alpar@222
    19
 *     in the heap, and calls decrease/increase(Item, Prio) otherwise
alpar@222
    20
 *
alpar@222
    21
 *void push(Item, Prio) : pushes Item to the heap with priority Prio. Item
alpar@222
    22
 *     mustn't be in the heap.
alpar@222
    23
 *
alpar@222
    24
 *Item top() : returns the Item with least Prio. 
alpar@222
    25
 *     Must be called only if heap is nonempty.
alpar@222
    26
 *
alpar@222
    27
 *Prio prio() : returns the least Prio
alpar@222
    28
 *     Must be called only if heap is nonempty.
alpar@222
    29
 *
alpar@222
    30
 *Prio get(Item) : returns Prio of Item
alpar@222
    31
 *     Must be called only if Item is in heap.
alpar@222
    32
 *
alpar@222
    33
 *void pop() : deletes the Item with least Prio
alpar@222
    34
 *
alpar@222
    35
 *void erase(Item) : deletes Item from the heap if it was already there
alpar@222
    36
 *
alpar@222
    37
 *void decrease(Item, P) : decreases prio of Item to P. 
alpar@222
    38
 *     Item must be in the heap with prio at least P.
alpar@222
    39
 *
alpar@222
    40
 *void increase(Item, P) : sets prio of Item to P. 
alpar@222
    41
 *
alpar@222
    42
 *state_enum state(Item) : returns PRE_HEAP if Item has not been in the 
alpar@222
    43
 *     heap until now, IN_HEAP if it is in the heap at the moment, and 
alpar@222
    44
 *     POST_HEAP otherwise. In the latter case it is possible that Item
alpar@222
    45
 *     will get back to the heap again. 
alpar@222
    46
 *
alpar@222
    47
 *In Fibonacci heaps, increase and erase are not efficient, in case of
alpar@222
    48
 *many calls to these operations, it is better to use bin_heap.
alpar@222
    49
 */
alpar@222
    50
alpar@222
    51
#ifndef FIB_HEAP_H
alpar@222
    52
#define FIB_HEAP_H
alpar@222
    53
alpar@222
    54
#include <vector>
alpar@222
    55
#include <functional>
alpar@222
    56
#include <math.h>
alpar@222
    57
alpar@222
    58
namespace hugo {
alpar@222
    59
  
alpar@224
    60
  /// A Fibonacci Heap implementation.
alpar@222
    61
  template <typename Item, typename Prio, typename ItemIntMap, 
alpar@224
    62
	    typename Compare = std::less<Prio> >
alpar@222
    63
  class FibHeap {
alpar@224
    64
    
alpar@222
    65
    typedef Prio PrioType;
alpar@222
    66
    
alpar@222
    67
    class store;
alpar@222
    68
    
alpar@222
    69
    std::vector<store> container;
alpar@222
    70
    int minimum;
alpar@222
    71
    ItemIntMap &iimap;
alpar@222
    72
    Compare comp;
alpar@222
    73
    int num_items;
alpar@222
    74
alpar@222
    75
    ///\todo It is use nowhere
alpar@222
    76
    ///\todo It doesn't conforms to the naming conventions.
alpar@222
    77
  public:
alpar@222
    78
    enum state_enum {
alpar@222
    79
      IN_HEAP = 0,
alpar@222
    80
      PRE_HEAP = -1,
alpar@222
    81
      POST_HEAP = -2
alpar@222
    82
    };
alpar@222
    83
    
alpar@222
    84
  public :
alpar@222
    85
    
alpar@222
    86
    FibHeap(ItemIntMap &_iimap) : minimum(), iimap(_iimap), num_items() {} 
alpar@222
    87
    FibHeap(ItemIntMap &_iimap, const Compare &_comp) : minimum(), 
alpar@222
    88
      iimap(_iimap), comp(_comp), num_items() {}
alpar@222
    89
    
alpar@222
    90
    
alpar@222
    91
    int size() const {
alpar@222
    92
      return num_items; 
alpar@222
    93
    }
alpar@222
    94
alpar@222
    95
alpar@222
    96
    bool empty() const { return num_items==0; }
alpar@222
    97
alpar@222
    98
alpar@222
    99
    void set (Item const it, PrioType const value) {
alpar@222
   100
      int i=iimap[it];
alpar@222
   101
      if ( i >= 0 && container[i].in ) {
alpar@222
   102
	if ( comp(value, container[i].prio) ) decrease(it, value); 
alpar@222
   103
	if ( comp(container[i].prio, value) ) increase(it, value); 
alpar@222
   104
      } else push(it, value);
alpar@222
   105
    }
alpar@222
   106
    
alpar@222
   107
alpar@222
   108
    void push (Item const it, PrioType const value) {
alpar@222
   109
      int i=iimap[it];      
alpar@222
   110
      if ( i < 0 ) {
alpar@222
   111
	int s=container.size();
alpar@222
   112
	iimap.set( it, s );	
alpar@222
   113
	store st;
alpar@222
   114
	st.name=it;
alpar@222
   115
	container.push_back(st);
alpar@222
   116
	i=s;
alpar@222
   117
      } else {
alpar@222
   118
	container[i].parent=container[i].child=-1;
alpar@222
   119
	container[i].degree=0;
alpar@222
   120
	container[i].in=true;
alpar@222
   121
	container[i].marked=false;
alpar@222
   122
      }
alpar@222
   123
alpar@222
   124
      if ( num_items ) {
alpar@222
   125
	container[container[minimum].right_neighbor].left_neighbor=i;
alpar@222
   126
	container[i].right_neighbor=container[minimum].right_neighbor;
alpar@222
   127
	container[minimum].right_neighbor=i;
alpar@222
   128
	container[i].left_neighbor=minimum;
alpar@222
   129
	if ( comp( value, container[minimum].prio) ) minimum=i; 
alpar@222
   130
      } else {
alpar@222
   131
	container[i].right_neighbor=container[i].left_neighbor=i;
alpar@222
   132
	minimum=i;	
alpar@222
   133
      }
alpar@222
   134
      container[i].prio=value;
alpar@222
   135
      ++num_items;
alpar@222
   136
    }
alpar@222
   137
    
alpar@222
   138
alpar@222
   139
    Item top() const {
alpar@222
   140
      return container[minimum].name;
alpar@222
   141
    }
alpar@222
   142
    
alpar@222
   143
    
alpar@222
   144
    PrioType prio() const {
alpar@222
   145
      return container[minimum].prio;
alpar@222
   146
    }
alpar@222
   147
    
alpar@222
   148
alpar@222
   149
alpar@222
   150
alpar@222
   151
    PrioType& operator[](const Item& it) {
alpar@222
   152
      return container[iimap[it]].prio;
alpar@222
   153
    }
alpar@222
   154
    
alpar@222
   155
    const PrioType& operator[](const Item& it) const {
alpar@222
   156
      return container[iimap[it]].prio;
alpar@222
   157
    }
alpar@222
   158
alpar@222
   159
//     const PrioType get(const Item& it) const {
alpar@222
   160
//       return container[iimap[it]].prio;
alpar@222
   161
//     }
alpar@222
   162
alpar@222
   163
    void pop() {
alpar@222
   164
      /*The first case is that there are only one root.*/
alpar@222
   165
      if ( container[minimum].left_neighbor==minimum ) {
alpar@222
   166
	container[minimum].in=false;
alpar@222
   167
	if ( container[minimum].degree!=0 ) { 
alpar@222
   168
	  makeroot(container[minimum].child);
alpar@222
   169
	  minimum=container[minimum].child;
alpar@222
   170
	  balance();
alpar@222
   171
	}
alpar@222
   172
      } else {
alpar@222
   173
	int right=container[minimum].right_neighbor;
alpar@222
   174
	unlace(minimum);
alpar@222
   175
	container[minimum].in=false;
alpar@222
   176
	if ( container[minimum].degree > 0 ) {
alpar@222
   177
	  int left=container[minimum].left_neighbor;
alpar@222
   178
	  int child=container[minimum].child;
alpar@222
   179
	  int last_child=container[child].left_neighbor;
alpar@222
   180
	
alpar@222
   181
	  makeroot(child);
alpar@222
   182
	  
alpar@222
   183
	  container[left].right_neighbor=child;
alpar@222
   184
	  container[child].left_neighbor=left;
alpar@222
   185
	  container[right].left_neighbor=last_child;
alpar@222
   186
	  container[last_child].right_neighbor=right;
alpar@222
   187
	}
alpar@222
   188
	minimum=right;
alpar@222
   189
	balance();
alpar@222
   190
      } // the case where there are more roots
alpar@222
   191
      --num_items;   
alpar@222
   192
    }
alpar@222
   193
alpar@222
   194
    
alpar@222
   195
    void erase (const Item& it) {
alpar@222
   196
      int i=iimap[it];
alpar@222
   197
      
alpar@222
   198
      if ( i >= 0 && container[i].in ) { 	
alpar@222
   199
	if ( container[i].parent!=-1 ) {
alpar@222
   200
	  int p=container[i].parent;
alpar@222
   201
	  cut(i,p);	    
alpar@222
   202
	  cascade(p);
alpar@222
   203
	}
alpar@222
   204
	minimum=i;     //As if its prio would be -infinity
alpar@222
   205
	pop();
alpar@222
   206
      }
alpar@222
   207
    }
alpar@222
   208
    
alpar@222
   209
alpar@222
   210
    void decrease (Item it, PrioType const value) {
alpar@222
   211
      int i=iimap[it];
alpar@222
   212
      container[i].prio=value;
alpar@222
   213
      int p=container[i].parent;
alpar@222
   214
      
alpar@222
   215
      if ( p!=-1 && comp(value, container[p].prio) ) {
alpar@222
   216
	cut(i,p);	    
alpar@222
   217
	cascade(p);
alpar@222
   218
      }      
alpar@222
   219
      if ( comp(value, container[minimum].prio) ) minimum=i; 
alpar@222
   220
    }
alpar@222
   221
   
alpar@222
   222
alpar@222
   223
    void increase (Item it, PrioType const value) {
alpar@222
   224
      erase(it);
alpar@222
   225
      push(it, value);
alpar@222
   226
    }
alpar@222
   227
alpar@222
   228
alpar@222
   229
    state_enum state(const Item &it) const {
alpar@222
   230
      int i=iimap[it];
alpar@222
   231
      if( i>=0 ) {
alpar@222
   232
	if ( container[i].in ) i=0;
alpar@222
   233
	else i=-2; 
alpar@222
   234
      }
alpar@222
   235
      return state_enum(i);
alpar@222
   236
    }
alpar@222
   237
alpar@222
   238
alpar@222
   239
  private:
alpar@222
   240
    
alpar@222
   241
    void balance() {      
alpar@222
   242
alpar@222
   243
    int maxdeg=int( floor( 2.08*log(double(container.size()))))+1;
alpar@222
   244
  
alpar@222
   245
    std::vector<int> A(maxdeg,-1); 
alpar@222
   246
    
alpar@222
   247
    /*
alpar@222
   248
     *Recall that now minimum does not point to the minimum prio element.
alpar@222
   249
     *We set minimum to this during balance().
alpar@222
   250
     */
alpar@222
   251
    int anchor=container[minimum].left_neighbor; 
alpar@222
   252
    int next=minimum; 
alpar@222
   253
    bool end=false; 
alpar@222
   254
    	
alpar@222
   255
       do {
alpar@222
   256
	int active=next;
alpar@222
   257
	if ( anchor==active ) end=true;
alpar@222
   258
	int d=container[active].degree;
alpar@222
   259
	next=container[active].right_neighbor;
alpar@222
   260
alpar@222
   261
	while (A[d]!=-1) {	  
alpar@222
   262
	  if( comp(container[active].prio, container[A[d]].prio) ) {
alpar@222
   263
	    fuse(active,A[d]); 
alpar@222
   264
	  } else { 
alpar@222
   265
	    fuse(A[d],active);
alpar@222
   266
	    active=A[d];
alpar@222
   267
	  } 
alpar@222
   268
	  A[d]=-1;
alpar@222
   269
	  ++d;
alpar@222
   270
	}	
alpar@222
   271
	A[d]=active;
alpar@222
   272
       } while ( !end );
alpar@222
   273
alpar@222
   274
alpar@222
   275
       while ( container[minimum].parent >=0 ) minimum=container[minimum].parent;
alpar@222
   276
       int s=minimum;
alpar@222
   277
       int m=minimum;
alpar@222
   278
       do {  
alpar@222
   279
	 if ( comp(container[s].prio, container[minimum].prio) ) minimum=s;
alpar@222
   280
	 s=container[s].right_neighbor;
alpar@222
   281
       } while ( s != m );
alpar@222
   282
    }
alpar@222
   283
alpar@222
   284
alpar@222
   285
    void makeroot (int c) {
alpar@222
   286
      int s=c;
alpar@222
   287
      do {  
alpar@222
   288
	container[s].parent=-1;
alpar@222
   289
	s=container[s].right_neighbor;
alpar@222
   290
      } while ( s != c );
alpar@222
   291
    }
alpar@222
   292
    
alpar@222
   293
alpar@222
   294
    void cut (int a, int b) {    
alpar@222
   295
      /*
alpar@222
   296
       *Replacing a from the children of b.
alpar@222
   297
       */
alpar@222
   298
      --container[b].degree;
alpar@222
   299
      
alpar@222
   300
      if ( container[b].degree !=0 ) {
alpar@222
   301
	int child=container[b].child;
alpar@222
   302
	if ( child==a ) 
alpar@222
   303
	  container[b].child=container[child].right_neighbor;
alpar@222
   304
	unlace(a);
alpar@222
   305
      }
alpar@222
   306
      
alpar@222
   307
      
alpar@222
   308
      /*Lacing a to the roots.*/
alpar@222
   309
      int right=container[minimum].right_neighbor;
alpar@222
   310
      container[minimum].right_neighbor=a;
alpar@222
   311
      container[a].left_neighbor=minimum;
alpar@222
   312
      container[a].right_neighbor=right;
alpar@222
   313
      container[right].left_neighbor=a;
alpar@222
   314
alpar@222
   315
      container[a].parent=-1;
alpar@222
   316
      container[a].marked=false;
alpar@222
   317
    }
alpar@222
   318
alpar@222
   319
alpar@222
   320
    void cascade (int a) 
alpar@222
   321
    {
alpar@222
   322
      if ( container[a].parent!=-1 ) {
alpar@222
   323
	int p=container[a].parent;
alpar@222
   324
	
alpar@222
   325
	if ( container[a].marked==false ) container[a].marked=true;
alpar@222
   326
	else {
alpar@222
   327
	  cut(a,p);
alpar@222
   328
	  cascade(p);
alpar@222
   329
	}
alpar@222
   330
      }
alpar@222
   331
    }
alpar@222
   332
alpar@222
   333
alpar@222
   334
    void fuse (int a, int b) {
alpar@222
   335
      unlace(b);
alpar@222
   336
      
alpar@222
   337
      /*Lacing b under a.*/
alpar@222
   338
      container[b].parent=a;
alpar@222
   339
alpar@222
   340
      if (container[a].degree==0) {
alpar@222
   341
	container[b].left_neighbor=b;
alpar@222
   342
	container[b].right_neighbor=b;
alpar@222
   343
	container[a].child=b;	
alpar@222
   344
      } else {
alpar@222
   345
	int child=container[a].child;
alpar@222
   346
	int last_child=container[child].left_neighbor;
alpar@222
   347
	container[child].left_neighbor=b;
alpar@222
   348
	container[b].right_neighbor=child;
alpar@222
   349
	container[last_child].right_neighbor=b;
alpar@222
   350
	container[b].left_neighbor=last_child;
alpar@222
   351
      }
alpar@222
   352
alpar@222
   353
      ++container[a].degree;
alpar@222
   354
      
alpar@222
   355
      container[b].marked=false;
alpar@222
   356
    }
alpar@222
   357
alpar@222
   358
alpar@222
   359
    /*
alpar@222
   360
     *It is invoked only if a has siblings.
alpar@222
   361
     */
alpar@222
   362
    void unlace (int a) {      
alpar@222
   363
      int leftn=container[a].left_neighbor;
alpar@222
   364
      int rightn=container[a].right_neighbor;
alpar@222
   365
      container[leftn].right_neighbor=rightn;
alpar@222
   366
      container[rightn].left_neighbor=leftn;
alpar@222
   367
    }
alpar@222
   368
alpar@222
   369
alpar@222
   370
    class store {
alpar@222
   371
      friend class FibHeap;
alpar@222
   372
      
alpar@222
   373
      Item name;
alpar@222
   374
      int parent;
alpar@222
   375
      int left_neighbor;
alpar@222
   376
      int right_neighbor;
alpar@222
   377
      int child;
alpar@222
   378
      int degree;  
alpar@222
   379
      bool marked;
alpar@222
   380
      bool in;
alpar@222
   381
      PrioType prio;
alpar@222
   382
alpar@222
   383
      store() : parent(-1), child(-1), degree(), marked(false), in(true) {} 
alpar@222
   384
    };
alpar@222
   385
    
alpar@222
   386
  };
alpar@222
   387
  
alpar@222
   388
} //namespace hugo
alpar@222
   389
#endif