PriorityQueue.h File Reference

#include <stdbool.h>
#include "Task.h"

Include dependency graph for PriorityQueue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PQNode
struct	PriorityQueue

Macros
#define	MAX_SENSORS   10

Functions
void	PQInit (PriorityQueue *pq)
	Initializes the priority queue. More...
bool	PQPush (PriorityQueue *pq, Task task, int priority)
	Pushes a task with a given priority onto the priority queue. More...
bool	PQPop (PriorityQueue *pq, Task *task)
	Pops the highest priority task from the priority queue. More...
bool	PQPeek (PriorityQueue *pq, Task *task)
	Peeks at the highest priority task in the priority queue without removing it. More...
bool	PQIsEmpty (PriorityQueue *pq)
	Checks if the priority queue is empty. More...
bool	PQIsFull (PriorityQueue *pq)
	Checks if the priority queue is full. More...

Macro Definition Documentation

MAX_SENSORS

#define MAX_SENSORS   10

Definition at line 8 of file PriorityQueue.h.

Function Documentation

PQInit()

void PQInit

(

PriorityQueue *

pq

)

Initializes the priority queue.

Parameters

pq	Pointer to the PriorityQueue structure to initialize.

Definition at line 3 of file PriorityQueue.c.

                               {
    pq->size = 0;
}

Here is the caller graph for this function:

PQIsEmpty()

bool PQIsEmpty

(

PriorityQueue *

pq

)

Checks if the priority queue is empty.

Parameters

pq	Pointer to the PriorityQueue structure.

Returns

True if the queue is empty, false otherwise.

Definition at line 62 of file PriorityQueue.c.

                                  {
    return pq->size == 0;
}

Here is the caller graph for this function:

PQIsFull()

bool PQIsFull

(

PriorityQueue *

pq

)

Checks if the priority queue is full.

Parameters

pq	Pointer to the PriorityQueue structure.

Returns

True if the queue is full, false otherwise.

Definition at line 66 of file PriorityQueue.c.

                                 {
    return pq->size == MAX_SENSORS;
}

Here is the caller graph for this function:

PQPeek()

bool PQPeek	(	PriorityQueue *	pq,
		Task *	task
	)

Peeks at the highest priority task in the priority queue without removing it.

Parameters

pq	Pointer to the PriorityQueue structure.
task	Pointer to the Task structure to store the peeked task.

Returns

True if a task was successfully peeked, false if the queue is empty.

Definition at line 56 of file PriorityQueue.c.

                                           {
    if (PQIsEmpty(pq)) return false;
    *task = pq->nodes[1].task;
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PQPop()

bool PQPop	(	PriorityQueue *	pq,
		Task *	task
	)

Pops the highest priority task from the priority queue.

Parameters

pq	Pointer to the PriorityQueue structure.
task	Pointer to the Task structure to store the popped task.

Returns

True if a task was successfully popped, false if the queue is empty.

Definition at line 48 of file PriorityQueue.c.

                                          {
    if (PQIsEmpty(pq)) return false;
    *task = pq->nodes[1].task;
    pq->nodes[1] = pq->nodes[pq->size--];
    heapifyDown(pq, 1);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PQPush()

bool PQPush	(	PriorityQueue *	pq,
		Task	task,
		int	priority
	)

Pushes a task with a given priority onto the priority queue.

Parameters

pq	Pointer to the PriorityQueue structure.
task	The task to push onto the queue.
priority	The priority of the task.

Returns

True if the task was successfully pushed, false if the queue is full.

Definition at line 41 of file PriorityQueue.c.

                                                        {
    if (PQIsFull(pq)) return false;
    pq->nodes[++pq->size] = (PQNode){priority, task};
    heapifyUp(pq, pq->size);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function: