9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef PRIORITYQ_H
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define PRIORITYQ_H
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Priority queue implementation using heap. The items you add to the queue
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen must begin with a struct priorityq_item. This is necessary for
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen priorityq_remove() to work fast. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenstruct priorityq_item {
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen /* Current index in the queue array, updated automatically. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen unsigned int idx;
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen /* [your own data] */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen};
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Returns <0, 0 or >0 */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainentypedef int priorityq_cmp_callback_t(const void *p1, const void *p2);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Create a new priority queue. Callback is used to compare added items. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenstruct priorityq *
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenpriorityq_init(priorityq_cmp_callback_t *cmp_callback, unsigned int init_size);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenvoid priorityq_deinit(struct priorityq **pq);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Return number of items in the queue. */
68a4946b12583b88fa802e52ebee45cd96056772Timo Sirainenunsigned int priorityq_count(const struct priorityq *pq) ATTR_PURE;
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Add a new item to the queue. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenvoid priorityq_add(struct priorityq *pq, struct priorityq_item *item);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Remove the specified item from the queue. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenvoid priorityq_remove(struct priorityq *pq, struct priorityq_item *item);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Return the item with the highest priority. Returns NULL if queue is empty. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenstruct priorityq_item *priorityq_peek(struct priorityq *pq);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Like priorityq_peek(), but also remove the returned item from the queue. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainenstruct priorityq_item *priorityq_pop(struct priorityq *pq);
2a51b74d417285de5885460c659d92417f64b127Timo Sirainen/* Returns array containing all the priorityq_items. Only the first item is
2a51b74d417285de5885460c659d92417f64b127Timo Sirainen guaranteed to be the highest priority item, the rest can't be assumed to
2a51b74d417285de5885460c659d92417f64b127Timo Sirainen be in any order. */
2a51b74d417285de5885460c659d92417f64b127Timo Sirainenstruct priorityq_item *const *priorityq_items(struct priorityq *pq);
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif