reactor-c
C Runtime for Lingua Franca
Loading...
Searching...
No Matches
pqueue_base.h File Reference
#include <stddef.h>

Go to the source code of this file.

Data Structures

struct  pqueue_t
 

Typedefs

typedef unsigned long long pqueue_pri_t
 
typedef pqueue_pri_t(* pqueue_get_pri_f) (void *a)
 
typedef int(* pqueue_cmp_pri_f) (pqueue_pri_t next, pqueue_pri_t curr)
 
typedef int(* pqueue_eq_elem_f) (void *next, void *curr)
 
typedef size_t(* pqueue_get_pos_f) (void *a)
 
typedef void(* pqueue_set_pos_f) (void *a, size_t pos)
 
typedef void(* pqueue_print_entry_f) (void *a)
 
typedef struct pqueue_t pqueue_t
 

Functions

pqueue_tpqueue_init (size_t n, pqueue_cmp_pri_f cmppri, pqueue_get_pri_f getpri, pqueue_get_pos_f getpos, pqueue_set_pos_f setpos, pqueue_eq_elem_f eqelem, pqueue_print_entry_f prt)
 Allocate and initialize a priority queue.
 
void pqueue_free (pqueue_t *q)
 
size_t pqueue_size (pqueue_t *q)
 
int pqueue_insert (pqueue_t *q, void *d)
 
void pqueue_change_priority (pqueue_t *q, pqueue_pri_t new_pri, void *d)
 
voidpqueue_pop (pqueue_t *q)
 
void pqueue_empty_into (pqueue_t **dest, pqueue_t **src)
 Empty 'src' into 'dest'.
 
voidpqueue_find_equal_same_priority (pqueue_t *q, void *e)
 
voidpqueue_find_equal (pqueue_t *q, void *e, pqueue_pri_t max_priority)
 
int pqueue_remove (pqueue_t *q, void *e)
 
voidpqueue_peek (pqueue_t *q)
 
void pqueue_print (pqueue_t *q, pqueue_print_entry_f print)
 
void pqueue_dump (pqueue_t *q, pqueue_print_entry_f print)
 
int pqueue_is_valid (pqueue_t *q)
 

Typedef Documentation

◆ pqueue_cmp_pri_f

typedef int(* pqueue_cmp_pri_f) (pqueue_pri_t next, pqueue_pri_t curr)

Callback to compare two priorities.

◆ pqueue_eq_elem_f

typedef int(* pqueue_eq_elem_f) (void *next, void *curr)

Callback to determine whether two elements are equivalent.

◆ pqueue_get_pos_f

typedef size_t(* pqueue_get_pos_f) (void *a)

Callback functions to get the position of an element.

◆ pqueue_get_pri_f

typedef pqueue_pri_t(* pqueue_get_pri_f) (void *a)

Callback to get the priority of an element.

◆ pqueue_pri_t

Priority data type.

◆ pqueue_print_entry_f

typedef void(* pqueue_print_entry_f) (void *a)

Debug callback function to print a entry.

◆ pqueue_set_pos_f

typedef void(* pqueue_set_pos_f) (void *a, size_t pos)

Callback functions to set the position of an element.

◆ pqueue_t

typedef struct pqueue_t pqueue_t

The priority queue handle.

Function Documentation

◆ pqueue_change_priority()

void pqueue_change_priority ( pqueue_t * q,
pqueue_pri_t new_pri,
void * d )

Move an existing entry to a different priority.

Parameters
qthe queue
new_prithe new priority
dthe entry

◆ pqueue_dump()

void pqueue_dump ( pqueue_t * q,
pqueue_print_entry_f print )

Dump the queue and it's internal structure.

◆ pqueue_empty_into()

void pqueue_empty_into ( pqueue_t ** dest,
pqueue_t ** src )

Empty 'src' into 'dest'.

As an optimization, this function might swap 'src' and 'dest'.

Parameters
destThe queue to fill up
srcThe queue to empty

◆ pqueue_find_equal()

void * pqueue_find_equal ( pqueue_t * q,
void * e,
pqueue_pri_t max_priority )

Find the highest-ranking item with priority up to and including the given maximum priority that matches the supplied entry.

Parameters
qthe queue
ethe entry to compare against
max_prioritythe maximum priority to consider
Returns
NULL if no matching event has been found, otherwise the entry

◆ pqueue_find_equal_same_priority()

void * pqueue_find_equal_same_priority ( pqueue_t * q,
void * e )

Find the highest-ranking item with the same priority that matches the supplied entry.

Parameters
qthe queue
ethe entry to compare against
Returns
NULL if no matching event has been found, otherwise the entry

◆ pqueue_free()

void pqueue_free ( pqueue_t * q)

free all memory used by the queue

Parameters
qthe queue

◆ pqueue_init()

Allocate and initialize a priority queue.

Parameters
nthe initial estimate of the number of queue items for which memory should be preallocated
cmppriThe callback function to run to compare two elements This callback should return 0 for 'lower' and non-zero for 'higher', or vice versa if reverse priority is desired
getprithe callback function to run to set a score to an element
getposthe callback function to get the current element's position
setposthe callback function to set the current element's position
eqelemthe callback function to check equivalence of entries
prtthe callback function to print an element
Returns
The handle or NULL for insufficent memory.

◆ pqueue_insert()

int pqueue_insert ( pqueue_t * q,
void * d )

Insert an element into the queue.

Parameters
qthe queue
ethe element
Returns
0 on success

◆ pqueue_is_valid()

int pqueue_is_valid ( pqueue_t * q)

Check that the all entries are in the right order, etc.

◆ pqueue_peek()

void * pqueue_peek ( pqueue_t * q)

Access highest-ranking item without removing it.

Parameters
qthe queue
Returns
NULL on error, otherwise the entry

◆ pqueue_pop()

void * pqueue_pop ( pqueue_t * q)

Pop the highest-ranking item from the queue.

Parameters
qthe queue
Returns
NULL on error, otherwise the entry

◆ pqueue_print()

void pqueue_print ( pqueue_t * q,
pqueue_print_entry_f print )

Print the contents of the queue.

Parameters
qThe queue.
printThe callback function to print the entry or NULL to use the default.

◆ pqueue_remove()

int pqueue_remove ( pqueue_t * q,
void * e )

Remove an item from the queue.

Parameters
qthe queue
ethe entry
Returns
0 on success

◆ pqueue_size()

size_t pqueue_size ( pqueue_t * q)

return the size of the queue.

Parameters
qthe queue