nsz Git - libfirm/blob - ir/adt/pqueue.c

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @author  Christian Wuerdig, Matthias Braun
  23  * @brief   Priority Queue implementation based on the heap datastructure
  24  * @version $Id$
  25  */
  26 #include "config.h"
  27
  28 #include "array.h"
  29 #include "pqueue.h"
  30 #include "error.h"
  31
  32 /*
  33  * Implements a heap.
  34  *
  35  * Implementation note: It might seem strange that we start indexing at 0
  36  * but use 2*i and 2*i+1 to find the left and right sucessor of an index.
  37  * The trick is that for index 0 the left successor is 0 again, and the
  38  * right successor is 1 in this scheme. For the right successor 1 everything
  39  * works like usual. We simply took care in the algorithms that they still
  40  * work with the left child of 0 being 0 again. This was possible without
  41  * any extra ifs or arithmetic.
  42  * Thus we can save the wastage of 1 array position you can see in other
  43  * implementations or the ugly (i+1)*2 - 1 and (i+1)*2 for calculating the
  44  * left and right child. (At the expense that stuff easily breaks when you make
  45  * changes and don't think that the left child of 0 is 0 :-/)
  46  *
  47  */
  48
  49 typedef struct _pqueue_el_t {
  50         void *data;
  51         int  priority;
  52 } pqueue_el_t;
  53
  54 struct _pqueue_t {
  55         pqueue_el_t *elems;
  56 };
  57
  58 /**
  59  * Enforces the heap characteristics if the queue
  60  * starting from element at position @p pos.
  61  */
  62 static void pqueue_heapify(pqueue_t *q, unsigned pos)
  63 {
  64         unsigned len = ARR_LEN(q->elems);
  65
  66         while (pos * 2 < len) {
  67                 pqueue_el_t tmp;
  68                 unsigned    exchange = pos;
  69
  70                 if (q->elems[exchange].priority < q->elems[pos * 2].priority) {
  71                         exchange = pos * 2;
  72                 }
  73
  74                 if ((pos * 2 + 1) < len
  75                                 && q->elems[exchange].priority < q->elems[pos * 2 + 1].priority) {
  76                         exchange = pos * 2 + 1;
  77                 }
  78
  79                 if (exchange == pos)
  80                         break;
  81
  82                 tmp                = q->elems[pos];
  83                 q->elems[pos]      = q->elems[exchange];
  84                 q->elems[exchange] = tmp;
  85
  86                 pos = exchange;
  87         }
  88 }
  89
  90 /**
  91  * Sifts up a newly inserted element at position @p pos.
  92  */
  93 static void pqueue_sift_up(pqueue_t *q, unsigned pos)
  94 {
  95         while (q->elems[pos].priority > q->elems[pos / 2].priority) {
  96                 pqueue_el_t tmp;
  97
  98                 tmp               = q->elems[pos];
  99                 q->elems[pos]     = q->elems[pos / 2];
 100                 q->elems[pos / 2] = tmp;
 101
 102                 pos /= 2;
 103         }
 104 }
 105
 106 pqueue_t *new_pqueue(void)
 107 {
 108         pqueue_t *res = XMALLOC(pqueue_t);
 109         res->elems = NEW_ARR_F(pqueue_el_t, 0);
 110         return res;
 111 }
 112
 113 void del_pqueue(pqueue_t *q)
 114 {
 115         DEL_ARR_F(q->elems);
 116         free(q);
 117 }
 118
 119 void pqueue_put(pqueue_t *q, void *data, int priority)
 120 {
 121         pqueue_el_t el;
 122
 123         el.data     = data;
 124         el.priority = priority;
 125
 126         ARR_APP1(pqueue_el_t, q->elems, el);
 127
 128         pqueue_sift_up(q, ARR_LEN(q->elems) - 1);
 129 }
 130
 131 void *pqueue_pop_front(pqueue_t *q)
 132 {
 133         switch (ARR_LEN(q->elems)) {
 134                 case 0:
 135                         panic("Attempt to retrieve element from empty priority queue.");
 136                 case 1:
 137                         ARR_SHRINKLEN(q->elems, 0);
 138                         return q->elems[0].data;
 139                 default: {
 140                         void *data = q->elems[0].data;
 141                         int  len   = ARR_LEN(q->elems) - 1;
 142
 143                         q->elems[0] = q->elems[len];
 144                         ARR_SHRINKLEN(q->elems, len);
 145                         pqueue_heapify(q, 0);
 146
 147                         return data;
 148                 }
 149         }
 150 }
 151
 152 int pqueue_length(const pqueue_t *q)
 153 {
 154         return ARR_LEN(q->elems);
 155 }
 156
 157 int pqueue_empty(const pqueue_t *q)
 158 {
 159         return ARR_LEN(q->elems) == 0;
 160 }