C Container Collection (CCC)
Loading...
Searching...
No Matches
priority_queue.h
Go to the documentation of this file.
1
33#ifndef CCC_PRIORITY_QUEUE_H
34#define CCC_PRIORITY_QUEUE_H
35
37#include <stddef.h>
40#include "private/private_priority_queue.h"
41#include "types.h"
42
53typedef struct CCC_Priority_queue CCC_Priority_queue;
54
64typedef struct CCC_Priority_queue_node CCC_Priority_queue_node;
65
85#define CCC_priority_queue_initialize(struct_name, type_intruder_field, order, \
86 compare, allocate, context_data) \
87 CCC_private_priority_queue_initialize(struct_name, type_intruder_field, \
88 order, compare, allocate, \
89 context_data)
90
103#define CCC_priority_queue_with_allocator(struct_name, type_intruder_field, \
104 order, compare, allocate) \
105 CCC_private_priority_queue_with_allocator( \
106 struct_name, type_intruder_field, order, compare, allocate)
107
122#define CCC_priority_queue_with_context_allocator( \
123 struct_name, type_intruder_field, order, compare, allocate, context) \
124 CCC_private_priority_queue_with_context_allocator( \
125 struct_name, type_intruder_field, order, compare, allocate, context)
126
140#define CCC_priority_queue_from(type_intruder_field, order, compare, allocate, \
141 destroy, context_data, \
142 compound_literal_array...) \
143 CCC_private_priority_queue_from(type_intruder_field, order, compare, \
144 allocate, destroy, context_data, \
145 compound_literal_array)
146
164[[nodiscard]] void *
165CCC_priority_queue_push(CCC_Priority_queue *priority_queue,
166 CCC_Priority_queue_node *type_intruder);
167
178#define CCC_priority_queue_emplace(Priority_queue_pointer, \
179 type_compound_literal...) \
180 CCC_private_priority_queue_emplace(Priority_queue_pointer, \
181 type_compound_literal)
182
187CCC_Result CCC_priority_queue_pop(CCC_Priority_queue *priority_queue);
188
196[[nodiscard]] void *
197CCC_priority_queue_extract(CCC_Priority_queue *priority_queue,
198 CCC_Priority_queue_node *type_intruder);
199
207CCC_Result CCC_priority_queue_erase(CCC_Priority_queue *priority_queue,
208 CCC_Priority_queue_node *type_intruder);
209
222void *CCC_priority_queue_update(CCC_Priority_queue *priority_queue,
223 CCC_Priority_queue_node *type_intruder,
224 CCC_Type_modifier *modify, void *context);
225
256#define CCC_priority_queue_update_with(priority_queue_pointer, type_pointer, \
257 update_closure_over_T...) \
258 CCC_private_priority_queue_update_with( \
259 priority_queue_pointer, type_pointer, update_closure_over_T)
260
279void *CCC_priority_queue_increase(CCC_Priority_queue *priority_queue,
280 CCC_Priority_queue_node *type_intruder,
281 CCC_Type_modifier *modify, void *context);
282
319#define CCC_priority_queue_increase_with(priority_queue_pointer, type_pointer, \
320 increase_closure_over_T...) \
321 CCC_private_priority_queue_increase_with( \
322 priority_queue_pointer, type_pointer, increase_closure_over_T)
323
340void *CCC_priority_queue_decrease(CCC_Priority_queue *priority_queue,
341 CCC_Priority_queue_node *type_intruder,
342 CCC_Type_modifier *modify, void *context);
343
380#define CCC_priority_queue_decrease_with(priority_queue_pointer, type_pointer, \
381 decrease_closure_over_T...) \
382 CCC_private_priority_queue_decrease_with( \
383 priority_queue_pointer, type_pointer, decrease_closure_over_T)
384
404CCC_Result CCC_priority_queue_clear(CCC_Priority_queue *priority_queue,
405 CCC_Type_destructor *destroy);
406
416[[nodiscard]] void *
417CCC_priority_queue_front(CCC_Priority_queue const *priority_queue);
418
423[[nodiscard]] CCC_Tribool
424CCC_priority_queue_is_empty(CCC_Priority_queue const *priority_queue);
425
430[[nodiscard]] CCC_Count
431CCC_priority_queue_count(CCC_Priority_queue const *priority_queue);
432
437[[nodiscard]] CCC_Tribool
438CCC_priority_queue_validate(CCC_Priority_queue const *priority_queue);
439
443[[nodiscard]] CCC_Order
444CCC_priority_queue_order(CCC_Priority_queue const *priority_queue);
445
450#ifdef PRIORITY_QUEUE_USING_NAMESPACE_CCC
451typedef CCC_Priority_queue_node priority_queue_node;
452typedef CCC_Priority_queue Priority_queue;
453# define priority_queue_initialize(arguments...) \
454 CCC_priority_queue_initialize(arguments)
455# define priority_queue_from(arguments...) CCC_priority_queue_from(arguments)
456# define priority_queue_front(arguments...) \
457 CCC_priority_queue_front(arguments)
458# define priority_queue_push(arguments...) CCC_priority_queue_push(arguments)
459# define priority_queue_emplace(arguments...) \
460 CCC_priority_queue_emplace(arguments)
461# define priority_queue_pop(arguments...) CCC_priority_queue_pop(arguments)
462# define priority_queue_extract(arguments...) \
463 CCC_priority_queue_extract(arguments)
464# define priority_queue_is_empty(arguments...) \
465 CCC_priority_queue_is_empty(arguments)
466# define priority_queue_count(arguments...) \
467 CCC_priority_queue_count(arguments)
468# define priority_queue_update(arguments...) \
469 CCC_priority_queue_update(arguments)
470# define priority_queue_increase(arguments...) \
471 CCC_priority_queue_increase(arguments)
472# define priority_queue_decrease(arguments...) \
473 CCC_priority_queue_decrease(arguments)
474# define priority_queue_update_with(arguments...) \
475 CCC_priority_queue_update_with(arguments)
476# define priority_queue_increase_with(arguments...) \
477 CCC_priority_queue_increase_with(arguments)
478# define priority_queue_decrease_with(arguments...) \
479 CCC_priority_queue_decrease_with(arguments)
480# define priority_queue_order(arguments...) \
481 CCC_priority_queue_order(arguments)
482# define priority_queue_clear(arguments...) \
483 CCC_priority_queue_clear(arguments)
484# define priority_queue_validate(arguments...) \
485 CCC_priority_queue_validate(arguments)
486#endif /* PRIORITY_QUEUE_USING_NAMESPACE_CCC */
487
488#endif /* CCC_PRIORITY_QUEUE_H */
CCC_priority_queue_count
CCC_Count CCC_priority_queue_count(CCC_Priority_queue const *priority_queue)
Returns the count of priority queue occupied nodes.
CCC_priority_queue_validate
CCC_Tribool CCC_priority_queue_validate(CCC_Priority_queue const *priority_queue)
Verifies the internal invariants of the priority_queue hold.
CCC_priority_queue_erase
CCC_Result CCC_priority_queue_erase(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder)
Erase type_intruder from the priority_queue. Amortized O(lgN).
CCC_priority_queue_clear
CCC_Result CCC_priority_queue_clear(CCC_Priority_queue *priority_queue, CCC_Type_destructor *destroy)
Removes all elements from the priority_queue, freeing if needed.
CCC_priority_queue_front
void * CCC_priority_queue_front(CCC_Priority_queue const *priority_queue)
Obtain a reference to the front of the priority queue. O(1).
CCC_priority_queue_increase
void * CCC_priority_queue_increase(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder, CCC_Type_modifier *modify, void *context)
Increases the priority of the type_intruder wrapping elem. O(1) or O(lgN)
CCC_priority_queue_push
void * CCC_priority_queue_push(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder)
Adds an element to the priority queue in correct total order. O(1).
CCC_priority_queue_extract
void * CCC_priority_queue_extract(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder)
CCC_priority_queue_update
void * CCC_priority_queue_update(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder, CCC_Type_modifier *modify, void *context)
Update the priority in the user type_intruder wrapping elem.
CCC_priority_queue_pop
CCC_Result CCC_priority_queue_pop(CCC_Priority_queue *priority_queue)
Pops the front element from the priority queue. Amortized O(lgN).
CCC_priority_queue_decrease
void * CCC_priority_queue_decrease(CCC_Priority_queue *priority_queue, CCC_Priority_queue_node *type_intruder, CCC_Type_modifier *modify, void *context)
Decreases the value of the type_intruder wrapping elem. O(1) or O(lgN)
CCC_priority_queue_is_empty
CCC_Tribool CCC_priority_queue_is_empty(CCC_Priority_queue const *priority_queue)
Returns true if the priority queue is empty false if not. O(1).
CCC_priority_queue_order
CCC_Order CCC_priority_queue_order(CCC_Priority_queue const *priority_queue)
Return the order used to initialize the priority_queue.
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:202
CCC_Priority_queue_node
Definition: private_priority_queue.h:34
CCC_Priority_queue
Definition: private_priority_queue.h:87
types.h
The C Container Collection Fundamental Types.
CCC_Order
CCC_Order
A three-way comparison for comparison functions.
Definition: types.h:171
CCC_Tribool
CCC_Tribool
A three state boolean to allow for an error state. Error is -1, False is 0, and True is 1.
Definition: types.h:133
CCC_Type_destructor
void CCC_Type_destructor(CCC_Type_context)
A callback function for destroying an element in the container.
Definition: types.h:376
CCC_Result
CCC_Result
A result of actions on containers.
Definition: types.h:148
CCC_Type_modifier
void CCC_Type_modifier(CCC_Type_context)
A callback function for modifying an element in the container.
Definition: types.h:358