Defines circular queues, fast and efficient FIFO data structures. More...
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
| struct | uel_cqueue_t |
| Defines a circular queue of void pointers. More... | |
Functions | |
| void | uel_cqueue_init (uel_cqueue_t *queue, void **buffer, uintptr_t size_log2n) |
| Initialised a circular queue object. More... | |
| void | uel_cqueue_clear (uel_cqueue_t *queue, bool clear_buffer) |
| Empties a queue by resetting its tail and count values. More... | |
| bool | uel_cqueue_push (uel_cqueue_t *queue, void *element) |
| Pushes an element into the queue. More... | |
| void * | uel_cqueue_pop (uel_cqueue_t *queue) |
| Pops an element from the queue. More... | |
| void * | uel_cqueue_peek_tail (uel_cqueue_t *queue) |
| Peeks the tail of the queue, where the oldest element is enqueued. This is the element that will be returned on the next pop operation. More... | |
| void * | uel_cqueue_peek_head (uel_cqueue_t *queue) |
| Peeks the head of the queue, where the newest element is enqueued. This is the element that was enqueued on the last push operation. More... | |
| bool | uel_cqueue_is_full (uel_cqueue_t *queue) |
| Checks if the queue is full. More... | |
| bool | uel_cqueue_is_empty (uel_cqueue_t *queue) |
| Checks if the queue is empty. Use this before popping from the queue. More... | |
| uintptr_t | uel_cqueue_count (uel_cqueue_t *queue) |
| Counts the number o elements in the queue. More... | |
Detailed Description
Defines circular queues, fast and efficient FIFO data structures.
Function Documentation
◆ uel_cqueue_clear()
| void uel_cqueue_clear | ( | uel_cqueue_t * | queue, |
| bool | clear_buffer | ||
| ) |
Empties a queue by resetting its tail and count values.
- Parameters
-
queue The queue to be cleared. clear_buffer If this is set, completely de-initialises the queue.
◆ uel_cqueue_count()
| uintptr_t uel_cqueue_count | ( | uel_cqueue_t * | queue | ) |
Counts the number o elements in the queue.
- Parameters
-
queue The queue whoese elements should be counted
- Returns
- The number of enqueued elements
◆ uel_cqueue_init()
| void uel_cqueue_init | ( | uel_cqueue_t * | queue, |
| void ** | buffer, | ||
| uintptr_t | size_log2n | ||
| ) |
Initialised a circular queue object.
- Parameters
-
queue The queue object to be intialised buffer An array of void pointers that will be used to store the enqueued values. size_log2n The size of the queue in its log2 form.
◆ uel_cqueue_is_empty()
| bool uel_cqueue_is_empty | ( | uel_cqueue_t * | queue | ) |
Checks if the queue is empty. Use this before popping from the queue.
- Parameters
-
queue The queue to check
- Returns
- Whether the queue is empty or not
◆ uel_cqueue_is_full()
| bool uel_cqueue_is_full | ( | uel_cqueue_t * | queue | ) |
Checks if the queue is full.
- Parameters
-
queue The queue to check
- Returns
- Whether the queue is full or not
◆ uel_cqueue_peek_head()
| void* uel_cqueue_peek_head | ( | uel_cqueue_t * | queue | ) |
Peeks the head of the queue, where the newest element is enqueued. This is the element that was enqueued on the last push operation.
- Parameters
-
queue The queue to peek
- Returns
- The newest element in the queue if it exists. Otherwise, NULL.
◆ uel_cqueue_peek_tail()
| void* uel_cqueue_peek_tail | ( | uel_cqueue_t * | queue | ) |
Peeks the tail of the queue, where the oldest element is enqueued. This is the element that will be returned on the next pop operation.
- Parameters
-
queue The queue to peek
- Returns
- The oldest element in the queue if it exists. Otherwise, NULL.
◆ uel_cqueue_pop()
| void* uel_cqueue_pop | ( | uel_cqueue_t * | queue | ) |
Pops an element from the queue.
- Parameters
-
queue The queue from where to pop
- Returns
- The oldest element in the queue, if it exists. Otherwise, NULL.
◆ uel_cqueue_push()
| bool uel_cqueue_push | ( | uel_cqueue_t * | queue, |
| void * | element | ||
| ) |
Pushes an element into the queue.
- Parameters
-
queue The queue into which to push the element element The element to be pushed into the queue
- Returns
- Whether the push operation was successfull
