C Container Collection (CCC)
Loading...
Searching...
No Matches
singly_linked_list.h
Go to the documentation of this file.
1
45#ifndef CCC_SINGLY_LINKED_LIST_H
46#define CCC_SINGLY_LINKED_LIST_H
47
49#include <stddef.h>
52#include "private/private_singly_linked_list.h"
53#include "types.h"
54
64typedef struct CCC_Singly_linked_list CCC_Singly_linked_list;
65
74typedef struct CCC_Singly_linked_list_node CCC_Singly_linked_list_node;
75
88#define CCC_singly_linked_list_default(type_name, type_intruder_field) \
89 CCC_private_singly_linked_list_for(type_name, type_intruder_field)
90
98#define CCC_singly_linked_list_for(type_name, type_intruder_field) \
99 CCC_private_singly_linked_list_for(type_name, type_intruder_field)
100
113#define CCC_singly_linked_list_from( \
114 type_intruder_field, allocator, destructor, compound_literal_array... \
115) \
116 CCC_private_singly_linked_list_from( \
117 type_intruder_field, allocator, destructor, compound_literal_array \
118 )
119
137[[nodiscard]] void *CCC_singly_linked_list_push_front(
138 CCC_Singly_linked_list *list,
139 CCC_Singly_linked_list_node *type_intruder,
140 CCC_Allocator const *allocator
141);
142
156#define CCC_singly_linked_list_emplace_front( \
157 list_pointer, allocator_pointer, type_compound_literal... \
158) \
159 CCC_private_singly_linked_list_emplace_front( \
160 list_pointer, allocator_pointer, type_compound_literal \
161 )
162
168CCC_Result CCC_singly_linked_list_pop_front(
169 CCC_Singly_linked_list *list, CCC_Allocator const *allocator
170);
171
184CCC_Result CCC_singly_linked_list_splice(
185 CCC_Singly_linked_list *position_list,
186 CCC_Singly_linked_list_node *type_intruder_position,
187 CCC_Singly_linked_list *splice_list,
188 CCC_Singly_linked_list_node *type_intruder_splice
189);
190
207CCC_Result CCC_singly_linked_list_splice_range(
208 CCC_Singly_linked_list *position_list,
209 CCC_Singly_linked_list_node *type_intruder_position,
210 CCC_Singly_linked_list *to_cut_list,
211 CCC_Singly_linked_list_node *type_intruder_to_cut_begin,
212 CCC_Singly_linked_list_node *type_intruder_to_cut_exclusive_end
213);
214
228void *CCC_singly_linked_list_erase(
229 CCC_Singly_linked_list *list,
230 CCC_Singly_linked_list_node *type_intruder,
231 CCC_Allocator const *allocator
232);
233
246void *CCC_singly_linked_list_erase_range(
247 CCC_Singly_linked_list *list,
248 CCC_Singly_linked_list_node *type_intruder_begin,
249 CCC_Singly_linked_list_node *type_intruder_end,
250 CCC_Allocator const *allocator
251);
252
261void *CCC_singly_linked_list_extract(
262 CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder
263);
264
275void *CCC_singly_linked_list_extract_range(
276 CCC_Singly_linked_list *list,
277 CCC_Singly_linked_list_node *type_intruder_begin,
278 CCC_Singly_linked_list_node *type_intruder_end
279);
280
308void *CCC_singly_linked_list_insert_sorted(
309 CCC_Singly_linked_list *singly_linked_list,
310 CCC_Singly_linked_list_node *type_intruder,
311 CCC_Order order,
312 CCC_Comparator const *comparator,
313 CCC_Allocator const *allocator
314);
315
329CCC_Tribool CCC_singly_linked_list_is_sorted(
330 CCC_Singly_linked_list const *singly_linked_list,
331 CCC_Order order,
332 CCC_Comparator const *comparator
333);
334
353CCC_Result CCC_singly_linked_list_clear(
354 CCC_Singly_linked_list *list,
355 CCC_Destructor const *destructor,
356 CCC_Allocator const *allocator
357);
358
369[[nodiscard]] void *
370CCC_singly_linked_list_begin(CCC_Singly_linked_list const *list);
371
376[[nodiscard]] CCC_Singly_linked_list_node *
377CCC_singly_linked_list_node_begin(CCC_Singly_linked_list const *list);
378
383[[nodiscard]] CCC_Singly_linked_list_node *
384CCC_singly_linked_list_node_before_begin(CCC_Singly_linked_list const *list);
385
391[[nodiscard]] void *
392CCC_singly_linked_list_end(CCC_Singly_linked_list const *list);
393
400[[nodiscard]] void *CCC_singly_linked_list_next(
401 CCC_Singly_linked_list const *list,
402 CCC_Singly_linked_list_node const *type_intruder
403);
404
415[[nodiscard]] void *
416CCC_singly_linked_list_front(CCC_Singly_linked_list const *list);
417
421[[nodiscard]] CCC_Count
422CCC_singly_linked_list_count(CCC_Singly_linked_list const *list);
423
428[[nodiscard]] CCC_Tribool
429CCC_singly_linked_list_is_empty(CCC_Singly_linked_list const *list);
430
435[[nodiscard]] CCC_Tribool
436CCC_singly_linked_list_validate(CCC_Singly_linked_list const *list);
437
442#ifdef SINGLY_LINKED_LIST_USING_NAMESPACE_CCC
443/* NOLINTBEGIN(readability-identifier-naming) */
444typedef CCC_Singly_linked_list_node Singly_linked_list_node;
445typedef CCC_Singly_linked_list Singly_linked_list;
446# define singly_linked_list_default(arguments...) \
447 CCC_singly_linked_list_default(arguments)
448# define singly_linked_list_for(arguments...) \
449 CCC_singly_linked_list_for(arguments)
450# define singly_linked_list_from(arguments...) \
451 CCC_singly_linked_list_from(arguments)
452# define singly_linked_list_emplace_front(arguments...) \
453 CCC_singly_linked_list_emplace_front(arguments)
454# define singly_linked_list_push_front(arguments...) \
455 CCC_singly_linked_list_push_front(arguments)
456# define singly_linked_list_front(arguments...) \
457 CCC_singly_linked_list_front(arguments)
458# define singly_linked_list_pop_front(arguments...) \
459 CCC_singly_linked_list_pop_front(arguments)
460# define singly_linked_list_splice(arguments...) \
461 CCC_singly_linked_list_splice(arguments)
462# define singly_linked_list_splice_range(arguments...) \
463 CCC_singly_linked_list_splice_range(arguments)
464# define singly_linked_list_extract(arguments...) \
465 CCC_singly_linked_list_extract(arguments)
466# define singly_linked_list_extract_range(arguments...) \
467 CCC_singly_linked_list_extract_range(arguments)
468# define singly_linked_list_erase(arguments...) \
469 CCC_singly_linked_list_erase(arguments)
470# define singly_linked_list_erase_range(arguments...) \
471 CCC_singly_linked_list_erase_range(arguments)
472# define singly_linked_list_sort(arguments...) \
473 CCC_singly_linked_list_sort(arguments)
474# define singly_linked_list_insert_sorted(arguments...) \
475 CCC_singly_linked_list_insert_sorted(arguments)
476# define singly_linked_list_is_sorted(arguments...) \
477 CCC_singly_linked_list_is_sorted(arguments)
478# define singly_linked_list_begin(arguments...) \
479 CCC_singly_linked_list_begin(arguments)
480# define singly_linked_list_node_begin(arguments...) \
481 CCC_singly_linked_list_node_begin(arguments)
482# define singly_linked_list_node_before_begin(arguments...) \
483 CCC_singly_linked_list_node_before_begin(arguments)
484# define singly_linked_list_end(arguments...) \
485 CCC_singly_linked_list_end(arguments)
486# define singly_linked_list_next(arguments...) \
487 CCC_singly_linked_list_next(arguments)
488# define singly_linked_list_count(arguments...) \
489 CCC_singly_linked_list_count(arguments)
490# define singly_linked_list_is_empty(arguments...) \
491 CCC_singly_linked_list_is_empty(arguments)
492# define singly_linked_list_validate(arguments...) \
493 CCC_singly_linked_list_validate(arguments)
494# define singly_linked_list_clear(arguments...) \
495 CCC_singly_linked_list_clear(arguments)
496/* NOLINTEND(readability-identifier-naming) */
497#endif /* SINGLY_LINKED_LIST_USING_NAMESPACE_CCC */
498
499#endif /* CCC_FORWARD_LIST_H */
CCC_singly_linked_list_next
void * CCC_singly_linked_list_next(CCC_Singly_linked_list const *list, CCC_Singly_linked_list_node const *type_intruder)
Return the user type following type_intruder in the list. O(1).
CCC_singly_linked_list_extract
void * CCC_singly_linked_list_extract(CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder)
Extracts an element from the list without freeing it. O(N).
CCC_singly_linked_list_push_front
void * CCC_singly_linked_list_push_front(CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder, CCC_Allocator const *allocator)
Push the type wrapping type_intruder to the front of the list. O(1).
CCC_singly_linked_list_is_empty
CCC_Tribool CCC_singly_linked_list_is_empty(CCC_Singly_linked_list const *list)
Return true if the list is empty. O(1).
CCC_singly_linked_list_begin
void * CCC_singly_linked_list_begin(CCC_Singly_linked_list const *list)
Return the user type at the front of the list. O(1).
CCC_singly_linked_list_count
CCC_Count CCC_singly_linked_list_count(CCC_Singly_linked_list const *list)
Return the count of nodes in the list. O(N).
CCC_singly_linked_list_extract_range
void * CCC_singly_linked_list_extract_range(CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder_begin, CCC_Singly_linked_list_node *type_intruder_end)
Extracts a range of elements from the list without freeing them. O(N).
CCC_singly_linked_list_front
void * CCC_singly_linked_list_front(CCC_Singly_linked_list const *list)
Return a pointer to the element at the front of the list. O(1).
CCC_singly_linked_list_insert_sorted
void * CCC_singly_linked_list_insert_sorted(CCC_Singly_linked_list *singly_linked_list, CCC_Singly_linked_list_node *type_intruder, CCC_Order order, CCC_Comparator const *comparator, CCC_Allocator const *allocator)
Inserts type_intruder in sorted position according to the non-decreasing order of the list determined...
CCC_singly_linked_list_node_before_begin
CCC_Singly_linked_list_node * CCC_singly_linked_list_node_before_begin(CCC_Singly_linked_list const *list)
Return the list node type before the starting node. O(1).
CCC_singly_linked_list_splice_range
CCC_Result CCC_singly_linked_list_splice_range(CCC_Singly_linked_list *position_list, CCC_Singly_linked_list_node *type_intruder_position, CCC_Singly_linked_list *to_cut_list, CCC_Singly_linked_list_node *type_intruder_to_cut_begin, CCC_Singly_linked_list_node *type_intruder_to_cut_exclusive_end)
Inserts the [begin, end) of spliced elements after the provided position. O(N).
CCC_singly_linked_list_pop_front
CCC_Result CCC_singly_linked_list_pop_front(CCC_Singly_linked_list *list, CCC_Allocator const *allocator)
Pop the front element from the list. O(1).
CCC_singly_linked_list_clear
CCC_Result CCC_singly_linked_list_clear(CCC_Singly_linked_list *list, CCC_Destructor const *destructor, CCC_Allocator const *allocator)
Clears the list freeing memory if needed. O(N).
CCC_singly_linked_list_erase_range
void * CCC_singly_linked_list_erase_range(CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder_begin, CCC_Singly_linked_list_node *type_intruder_end, CCC_Allocator const *allocator)
Erases a range from the list returning the element after end. O(N).
CCC_singly_linked_list_end
void * CCC_singly_linked_list_end(CCC_Singly_linked_list const *list)
Return the sentinel at the end of the list. Do not access sentinel. O(1).
CCC_singly_linked_list_splice
CCC_Result CCC_singly_linked_list_splice(CCC_Singly_linked_list *position_list, CCC_Singly_linked_list_node *type_intruder_position, CCC_Singly_linked_list *splice_list, CCC_Singly_linked_list_node *type_intruder_splice)
Inserts splice element after the provided position. O(N).
CCC_singly_linked_list_node_begin
CCC_Singly_linked_list_node * CCC_singly_linked_list_node_begin(CCC_Singly_linked_list const *list)
Return the list node type at the front of the list. O(1).
CCC_singly_linked_list_erase
void * CCC_singly_linked_list_erase(CCC_Singly_linked_list *list, CCC_Singly_linked_list_node *type_intruder, CCC_Allocator const *allocator)
Erases type_intruder from the list returning the following element. O(N).
CCC_singly_linked_list_is_sorted
CCC_Tribool CCC_singly_linked_list_is_sorted(CCC_Singly_linked_list const *singly_linked_list, CCC_Order order, CCC_Comparator const *comparator)
Returns true if the list is sorted in non-decreasing order according to the user provided comparison ...
CCC_singly_linked_list_validate
CCC_Tribool CCC_singly_linked_list_validate(CCC_Singly_linked_list const *list)
Returns true if the invariants of the list hold.
CCC_Allocator
The type passed by reference to any container function that may need to allocate memory....
Definition: types.h:376
CCC_Comparator
The type passed by reference to any container function that may need to compare elements....
Definition: types.h:416
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:244
CCC_Destructor
The type passed by reference to any container function that may need to destroy elements....
Definition: types.h:464
CCC_Singly_linked_list_node
Definition: private_singly_linked_list.h:31
CCC_Singly_linked_list
Definition: private_singly_linked_list.h:63
types.h
The C Container Collection Fundamental Types.
CCC_Order
CCC_Order
A three-way comparison for comparison functions.
Definition: types.h:214
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