nsz Git - libfirm/blob - include/libfirm/adt/pqueue.h

   1 /*
   2  * Copyright (C) 1995-2011 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  * @date    18.04.2007
  23  * @author  Christian Wuerdig
  24  * @brief   Implementation of a priority queue. This is the ported version of
  25             the original Java implementation by Matthias Braun.
  26  */
  27 #ifndef FIRM_ADT_PQUEUE_H
  28 #define FIRM_ADT_PQUEUE_H
  29
  30 #include "../begin.h"
  31
  32 /**
  33  * @ingroup adt
  34  * @defgroup pqueue  Priority Queue
  35  * A priority queue.
  36  * Implementation based on a heap datastructure
  37  * @{
  38  */
  39
  40 /** priority queue */
  41 typedef struct pqueue_t pqueue_t;
  42
  43 /**
  44  * Creates a new priority queue.
  45  * @return A priority queue of initial length 0.
  46  */
  47 FIRM_API pqueue_t *new_pqueue(void);
  48
  49 /**
  50  * Frees all memory allocated by the priority queue.
  51  * @param q   The priority queue to destroy.
  52  */
  53 FIRM_API void del_pqueue(pqueue_t *q);
  54
  55 /**
  56  * Inserts a new element into a priority queue.
  57  * @param q         The priority queue the element should be inserted to.
  58  * @param data      The actual data which should be stored in the queue.
  59  * @param priority  The priority for the data.
  60  */
  61 FIRM_API void pqueue_put(pqueue_t *q, void *data, int priority);
  62
  63 /**
  64  * Returns and removes the first element, ie. that one with the highest priority, from the queue.
  65  * @param q   The priority queue.
  66  * @return The first element of the queue. Asserts if queue is empty.
  67  */
  68 FIRM_API void *pqueue_pop_front(pqueue_t *q);
  69
  70 /**
  71  * Get the length of the priority queue.
  72  * @param q   The priority queue.
  73  * @return The length of the queue.
  74  */
  75 FIRM_API size_t pqueue_length(const pqueue_t *q);
  76
  77 /**
  78  * Returns true if queue is empty.
  79  * @param q   The priority queue.
  80  * @return 1 if the queue is empty, 0 otherwise.
  81  */
  82 FIRM_API int pqueue_empty(const pqueue_t *q);
  83
  84 /** @} */
  85
  86 #include "../end.h"
  87
  88 #endif