priority_queue.h

Go to the documentation of this file.

/*
Copyright (C) 2024 The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
 
#ifndef PRIORITY_QUEUE_H
#define PRIORITY_QUEUE_H

 

struct priority_queue *priority_queue_create(int init_capacity);

int priority_queue_size(struct priority_queue *pq);

int priority_queue_push(struct priority_queue *pq, void *data, double priority);

void *priority_queue_pop(struct priority_queue *pq);

void *priority_queue_peek_top(struct priority_queue *pq);

void *priority_queue_peek_at(struct priority_queue *pq, int index);

double priority_queue_get_priority_at(struct priority_queue *pq, int index);

double priority_queue_get_top_priority(struct priority_queue *pq);

int priority_queue_update_priority(struct priority_queue *pq, void *data, double new_priority);

int priority_queue_find_idx(struct priority_queue *pq, void *data);

int priority_queue_static_next(struct priority_queue *pq);

void priority_queue_base_reset(struct priority_queue *pq);

int priority_queue_base_next(struct priority_queue *pq);

void priority_queue_rotate_reset(struct priority_queue *pq);

int priority_queue_rotate_next(struct priority_queue *pq);

int priority_queue_remove(struct priority_queue *pq, int idx);

void priority_queue_delete(struct priority_queue *pq);

 
/* Iterate from begining to the end every time starts. */
#define PRIORITY_QUEUE_BASE_ITERATE( pq, idx, data, iter_count, iter_depth ) \
    iter_count = 0; \
    priority_queue_base_reset(pq); \
    while ((iter_count < iter_depth) && ((idx = priority_queue_base_next(pq)) >= 0) && (data = priority_queue_peek_at(pq, idx)) && (iter_count += 1))
 
/* Iterate from last position, never reset. */
#define PRIORITY_QUEUE_STATIC_ITERATE( pq, idx, data, iter_count, iter_depth ) \
    iter_count = 0; \
    while ((iter_count < iter_depth) && ((idx = priority_queue_static_next(pq)) >= 0) && (data = priority_queue_peek_at(pq, idx)) && (iter_count += 1))
 
/* Iterate from last position, reset to the begining when needed. */
#define PRIORITY_QUEUE_ROTATE_ITERATE( pq, idx, data, iter_count, iter_depth ) \
    iter_count = 0; \
    while ((iter_count < iter_depth) && ((idx = priority_queue_rotate_next(pq)) >= 0) && (data = priority_queue_peek_at(pq, idx)) && (iter_count += 1))
 
#endif