C Container Collection (CCC)
Loading...
Searching...
No Matches
flat_double_ended_queue.h
Go to the documentation of this file.
1
42#ifndef CCC_FLAT_DOUBLE_ENDED_QUEUE_H
43#define CCC_FLAT_DOUBLE_ENDED_QUEUE_H
44
46#include <stddef.h>
49#include "private/private_flat_double_ended_queue.h"
50
51#include "flat_buffer.h" /* IWYU pragma: export */
52#include "types.h" /* IWYU pragma: export */
53
64typedef struct CCC_Flat_double_ended_queue CCC_Flat_double_ended_queue;
65
86#define CCC_flat_double_ended_queue_default(type_name) \
87 CCC_private_flat_double_ended_queue_default(type_name)
88
97#define CCC_flat_double_ended_queue_for( \
98 type_name, capacity, count, data_pointer... \
99) \
100 CCC_private_flat_double_ended_queue_for( \
101 type_name, capacity, count, data_pointer \
102 )
103
154#define CCC_flat_double_ended_queue_from( \
155 allocator, optional_capacity, compound_literal_array... \
156) \
157 CCC_private_flat_double_ended_queue_from( \
158 allocator, optional_capacity, compound_literal_array \
159 )
160
185#define CCC_flat_double_ended_queue_with_capacity( \
186 type_name, allocator, capacity \
187) \
188 CCC_private_flat_double_ended_queue_with_capacity( \
189 type_name, allocator, capacity \
190 )
191
198#define CCC_flat_double_ended_queue_with_storage( \
199 count, compound_literal_array... \
200) \
201 CCC_private_flat_double_ended_queue_with_storage( \
202 count, compound_literal_array \
203 )
204
267CCC_Result CCC_flat_double_ended_queue_copy(
268 CCC_Flat_double_ended_queue *destination,
269 CCC_Flat_double_ended_queue const *source,
270 CCC_Allocator const *allocator
271);
272
282CCC_Result CCC_flat_double_ended_queue_reserve(
283 CCC_Flat_double_ended_queue *queue,
284 size_t to_add,
285 CCC_Allocator const *allocator
286);
287
305#define CCC_flat_double_ended_queue_emplace_back( \
306 flat_double_ended_queue_pointer, allocator_pointer, value... \
307) \
308 CCC_private_flat_double_ended_queue_emplace_back( \
309 flat_double_ended_queue_pointer, allocator_pointer, value \
310 )
311
322#define CCC_flat_double_ended_queue_emplace_front( \
323 flat_double_ended_queue_pointer, allocator_pointer, value... \
324) \
325 CCC_private_flat_double_ended_queue_emplace_front( \
326 flat_double_ended_queue_pointer, allocator_pointer, value \
327 )
328
338[[nodiscard]] void *CCC_flat_double_ended_queue_push_back(
339 CCC_Flat_double_ended_queue *queue,
340 void const *type,
341 CCC_Allocator const *allocator
342);
343
357CCC_Result CCC_flat_double_ended_queue_push_back_range(
358 CCC_Flat_double_ended_queue *queue,
359 CCC_Flat_buffer const *range,
360 CCC_Allocator const *allocator
361);
362
371[[nodiscard]] void *CCC_flat_double_ended_queue_push_front(
372 CCC_Flat_double_ended_queue *queue,
373 void const *type,
374 CCC_Allocator const *allocator
375);
376
390CCC_Result CCC_flat_double_ended_queue_push_front_range(
391 CCC_Flat_double_ended_queue *queue,
392 CCC_Flat_buffer const *range,
393 CCC_Allocator const *allocator
394);
395
436[[nodiscard]] void *CCC_flat_double_ended_queue_insert_range(
437 CCC_Flat_double_ended_queue *queue,
438 void *position,
439 CCC_Flat_buffer const *range,
440 CCC_Allocator const *allocator
441);
442
447CCC_Result
448CCC_flat_double_ended_queue_pop_front(CCC_Flat_double_ended_queue *queue);
449
454CCC_Result
455CCC_flat_double_ended_queue_pop_back(CCC_Flat_double_ended_queue *queue);
456
473CCC_Result CCC_flat_double_ended_queue_clear(
474 CCC_Flat_double_ended_queue *queue, CCC_Destructor const *destructor
475);
476
489CCC_Result CCC_flat_double_ended_queue_clear_and_free(
490 CCC_Flat_double_ended_queue *queue,
491 CCC_Destructor const *destructor,
492 CCC_Allocator const *allocator
493);
494
506[[nodiscard]] void *
507CCC_flat_double_ended_queue_begin(CCC_Flat_double_ended_queue const *queue);
508
514[[nodiscard]] void *CCC_flat_double_ended_queue_reverse_begin(
515 CCC_Flat_double_ended_queue const *queue
516);
517
523[[nodiscard]] void *CCC_flat_double_ended_queue_next(
524 CCC_Flat_double_ended_queue const *queue, void const *iterator_pointer
525);
526
532[[nodiscard]] void *CCC_flat_double_ended_queue_reverse_next(
533 CCC_Flat_double_ended_queue const *queue, void const *iterator_pointer
534);
535
539[[nodiscard]] void *
540CCC_flat_double_ended_queue_end(CCC_Flat_double_ended_queue const *queue);
541
545[[nodiscard]] void *CCC_flat_double_ended_queue_reverse_end(
546 CCC_Flat_double_ended_queue const *queue
547);
548
562[[nodiscard]] void *CCC_flat_double_ended_queue_at(
563 CCC_Flat_double_ended_queue const *queue, size_t i
564);
565
570[[nodiscard]] void *
571CCC_flat_double_ended_queue_front(CCC_Flat_double_ended_queue const *queue);
572
577[[nodiscard]] void *
578CCC_flat_double_ended_queue_back(CCC_Flat_double_ended_queue const *queue);
579
584[[nodiscard]] CCC_Tribool
585CCC_flat_double_ended_queue_is_empty(CCC_Flat_double_ended_queue const *queue);
586
591[[nodiscard]] CCC_Count
592CCC_flat_double_ended_queue_count(CCC_Flat_double_ended_queue const *queue);
593
598[[nodiscard]] CCC_Count
599CCC_flat_double_ended_queue_capacity(CCC_Flat_double_ended_queue const *queue);
600
612[[nodiscard]] void *
613CCC_flat_double_ended_queue_data(CCC_Flat_double_ended_queue const *queue);
614
620[[nodiscard]] CCC_Tribool
621CCC_flat_double_ended_queue_validate(CCC_Flat_double_ended_queue const *queue);
622
628#ifdef FLAT_DOUBLE_ENDED_QUEUE_USING_NAMESPACE_CCC
629/* NOLINTBEGIN(readability-identifier-naming) */
630typedef CCC_Flat_double_ended_queue Flat_double_ended_queue;
631# define flat_double_ended_queue_default(argument) \
632 CCC_flat_double_ended_queue_default(argument)
633# define flat_double_ended_queue_for(arguments...) \
634 CCC_flat_double_ended_queue_for(arguments)
635# define flat_double_ended_queue_from(arguments...) \
636 CCC_flat_double_ended_queue_from(arguments)
637# define flat_double_ended_queue_with_storage(arguments...) \
638 CCC_flat_double_ended_queue_with_storage(arguments)
639# define flat_double_ended_queue_with_capacity(arguments...) \
640 CCC_flat_double_ended_queue_with_capacity(arguments)
641# define flat_double_ended_queue_copy(arguments...) \
642 CCC_flat_double_ended_queue_copy(arguments)
643# define flat_double_ended_queue_reserve(arguments...) \
644 CCC_flat_double_ended_queue_reserve(arguments)
645# define flat_double_ended_queue_emplace(arguments...) \
646 CCC_flat_double_ended_queue_emplace(arguments)
647# define flat_double_ended_queue_push_back(arguments...) \
648 CCC_flat_double_ended_queue_push_back(arguments)
649# define flat_double_ended_queue_emplace_back(arguments...) \
650 CCC_flat_double_ended_queue_emplace_back(arguments)
651# define flat_double_ended_queue_push_back_range(arguments...) \
652 CCC_flat_double_ended_queue_push_back_range(arguments)
653# define flat_double_ended_queue_push_front(arguments...) \
654 CCC_flat_double_ended_queue_push_front(arguments)
655# define flat_double_ended_queue_emplace_front(arguments...) \
656 CCC_flat_double_ended_queue_emplace_front(arguments)
657# define flat_double_ended_queue_push_front_range(arguments...) \
658 CCC_flat_double_ended_queue_push_front_range(arguments)
659# define flat_double_ended_queue_insert_range(arguments...) \
660 CCC_flat_double_ended_queue_insert_range(arguments)
661# define flat_double_ended_queue_pop_front(arguments...) \
662 CCC_flat_double_ended_queue_pop_front(arguments)
663# define flat_double_ended_queue_pop_back(arguments...) \
664 CCC_flat_double_ended_queue_pop_back(arguments)
665# define flat_double_ended_queue_front(arguments...) \
666 CCC_flat_double_ended_queue_front(arguments)
667# define flat_double_ended_queue_back(arguments...) \
668 CCC_flat_double_ended_queue_back(arguments)
669# define flat_double_ended_queue_is_empty(arguments...) \
670 CCC_flat_double_ended_queue_is_empty(arguments)
671# define flat_double_ended_queue_count(arguments...) \
672 CCC_flat_double_ended_queue_count(arguments)
673# define flat_double_ended_queue_capacity(arguments...) \
674 CCC_flat_double_ended_queue_capacity(arguments)
675# define flat_double_ended_queue_clear(arguments...) \
676 CCC_flat_double_ended_queue_clear(arguments)
677# define flat_double_ended_queue_clear_and_free(arguments...) \
678 CCC_flat_double_ended_queue_clear_and_free(arguments)
679# define flat_double_ended_queue_clear_and_free_reserve(arguments...) \
680 CCC_flat_double_ended_queue_clear_and_free_reserve(arguments)
681# define flat_double_ended_queue_at(arguments...) \
682 CCC_flat_double_ended_queue_at(arguments)
683# define flat_double_ended_queue_data(arguments...) \
684 CCC_flat_double_ended_queue_data(arguments)
685# define flat_double_ended_queue_begin(arguments...) \
686 CCC_flat_double_ended_queue_begin(arguments)
687# define flat_double_ended_queue_reverse_begin(arguments...) \
688 CCC_flat_double_ended_queue_reverse_begin(arguments)
689# define flat_double_ended_queue_next(arguments...) \
690 CCC_flat_double_ended_queue_next(arguments)
691# define flat_double_ended_queue_reverse_next(arguments...) \
692 CCC_flat_double_ended_queue_reverse_next(arguments)
693# define flat_double_ended_queue_end(arguments...) \
694 CCC_flat_double_ended_queue_end(arguments)
695# define flat_double_ended_queue_reverse_end(arguments...) \
696 CCC_flat_double_ended_queue_reverse_end(arguments)
697# define flat_double_ended_queue_validate(arguments...) \
698 CCC_flat_double_ended_queue_validate(arguments)
699/* NOLINTEND(readability-identifier-naming) */
700#endif /* FLAT_DOUBLE_ENDED_QUEUE_USING_NAMESPACE_CCC */
701
702#endif /* CCC_FLAT_DOUBLE_ENDED_QUEUE_H */
flat_buffer.h
The Flat_buffer Interface.
CCC_flat_double_ended_queue_clear
CCC_Result CCC_flat_double_ended_queue_clear(CCC_Flat_double_ended_queue *queue, CCC_Destructor const *destructor)
Set size of queue to 0 and call destructor on each element if needed. O(1) if no destructor is provid...
CCC_flat_double_ended_queue_is_empty
CCC_Tribool CCC_flat_double_ended_queue_is_empty(CCC_Flat_double_ended_queue const *queue)
Return true if the size of the queue is 0. O(1).
CCC_flat_double_ended_queue_at
void * CCC_flat_double_ended_queue_at(CCC_Flat_double_ended_queue const *queue, size_t i)
Return a reference to the element at index position i. O(1).
CCC_flat_double_ended_queue_reserve
CCC_Result CCC_flat_double_ended_queue_reserve(CCC_Flat_double_ended_queue *queue, size_t to_add, CCC_Allocator const *allocator)
Reserves space for at least to_add more elements.
CCC_flat_double_ended_queue_pop_back
CCC_Result CCC_flat_double_ended_queue_pop_back(CCC_Flat_double_ended_queue *queue)
Pop an element from the back of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_validate
CCC_Tribool CCC_flat_double_ended_queue_validate(CCC_Flat_double_ended_queue const *queue)
Return true if the internal invariants of the flat_double_ended_queue.
CCC_flat_double_ended_queue_insert_range
void * CCC_flat_double_ended_queue_insert_range(CCC_Flat_double_ended_queue *queue, void *position, CCC_Flat_buffer const *range, CCC_Allocator const *allocator)
Push the range of user types before position of the flat_double_ended_queue. O(N).
CCC_flat_double_ended_queue_push_back
void * CCC_flat_double_ended_queue_push_back(CCC_Flat_double_ended_queue *queue, void const *type, CCC_Allocator const *allocator)
Push the user type to the back of the flat_double_ended_queue. O(1) if no allocation permission amort...
CCC_flat_double_ended_queue_reverse_end
void * CCC_flat_double_ended_queue_reverse_end(CCC_Flat_double_ended_queue const *queue)
Return a pointer to the start element. It may not be accessed. O(1).
CCC_flat_double_ended_queue_push_back_range
CCC_Result CCC_flat_double_ended_queue_push_back_range(CCC_Flat_double_ended_queue *queue, CCC_Flat_buffer const *range, CCC_Allocator const *allocator)
Push the range of user types to the back of the flat_double_ended_queue. O(N).
CCC_flat_double_ended_queue_push_front_range
CCC_Result CCC_flat_double_ended_queue_push_front_range(CCC_Flat_double_ended_queue *queue, CCC_Flat_buffer const *range, CCC_Allocator const *allocator)
Push the range of user types to the front of the flat_double_ended_queue. O(N).
CCC_flat_double_ended_queue_front
void * CCC_flat_double_ended_queue_front(CCC_Flat_double_ended_queue const *queue)
Return a reference to the front of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_next
void * CCC_flat_double_ended_queue_next(CCC_Flat_double_ended_queue const *queue, void const *iterator_pointer)
Return the next element in the queue moving front to back. O(1).
CCC_flat_double_ended_queue_push_front
void * CCC_flat_double_ended_queue_push_front(CCC_Flat_double_ended_queue *queue, void const *type, CCC_Allocator const *allocator)
Push the user type to the front of the flat_double_ended_queue. O(1) if no allocation permission amor...
CCC_flat_double_ended_queue_back
void * CCC_flat_double_ended_queue_back(CCC_Flat_double_ended_queue const *queue)
Return a reference to the back of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_reverse_begin
void * CCC_flat_double_ended_queue_reverse_begin(CCC_Flat_double_ended_queue const *queue)
Return a pointer to the back element of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_pop_front
CCC_Result CCC_flat_double_ended_queue_pop_front(CCC_Flat_double_ended_queue *queue)
Pop an element from the front of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_capacity
CCC_Count CCC_flat_double_ended_queue_capacity(CCC_Flat_double_ended_queue const *queue)
Return the capacity representing total possible slots. O(1).
CCC_flat_double_ended_queue_copy
CCC_Result CCC_flat_double_ended_queue_copy(CCC_Flat_double_ended_queue *destination, CCC_Flat_double_ended_queue const *source, CCC_Allocator const *allocator)
Copy the queue from source to newly initialized destination.
CCC_flat_double_ended_queue_count
CCC_Count CCC_flat_double_ended_queue_count(CCC_Flat_double_ended_queue const *queue)
Return the count of active queue slots. O(1).
CCC_flat_double_ended_queue_clear_and_free
CCC_Result CCC_flat_double_ended_queue_clear_and_free(CCC_Flat_double_ended_queue *queue, CCC_Destructor const *destructor, CCC_Allocator const *allocator)
Set size of queue to 0 and call destructor on each element if needed. Free the underlying Flat_buffer...
CCC_flat_double_ended_queue_begin
void * CCC_flat_double_ended_queue_begin(CCC_Flat_double_ended_queue const *queue)
Return a pointer to the front element of the flat_double_ended_queue. O(1).
CCC_flat_double_ended_queue_data
void * CCC_flat_double_ended_queue_data(CCC_Flat_double_ended_queue const *queue)
Return a reference to the base of backing array. O(1).
CCC_flat_double_ended_queue_end
void * CCC_flat_double_ended_queue_end(CCC_Flat_double_ended_queue const *queue)
Return a pointer to the end element. It may not be accessed. O(1).
CCC_flat_double_ended_queue_reverse_next
void * CCC_flat_double_ended_queue_reverse_next(CCC_Flat_double_ended_queue const *queue, void const *iterator_pointer)
Return the next element in the queue moving back to front. O(1).
private_flat_double_ended_queue.h
The Private Flat Double Ended Queue Types and Interface.
CCC_Allocator
The type passed by reference to any container function that may need to allocate memory....
Definition: types.h:384
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:243
CCC_Destructor
The type passed by reference to any container function that may need to destroy elements....
Definition: types.h:472
CCC_Flat_buffer
Definition: private_flat_buffer.h:40
CCC_Flat_double_ended_queue
Definition: private_flat_double_ended_queue.h:43
types.h
The C Container Collection Fundamental Types.
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:178
CCC_Result
CCC_Result
A result of actions on containers.
Definition: types.h:192