C Container Collection (CCC)
Loading...
Searching...
No Matches
adaptive_map.h
Go to the documentation of this file.
1
39#ifndef CCC_ADAPTIVE_MAP_H
40#define CCC_ADAPTIVE_MAP_H
41
43#include <stddef.h>
46#include "private/private_adaptive_map.h"
47#include "types.h"
48
59typedef struct CCC_Adaptive_map CCC_Adaptive_map;
60
68typedef struct CCC_Adaptive_map_node CCC_Adaptive_map_node;
69
74typedef struct CCC_Adaptive_map_entry CCC_Adaptive_map_entry;
75
88#define CCC_adaptive_map_default( \
89 struct_name, type_intruder_field_name, type_key_field_name, comparator \
90) \
91 CCC_private_adaptive_map_default( \
92 struct_name, type_intruder_field_name, type_key_field_name, comparator \
93 )
94
101#define CCC_adaptive_map_for( \
102 struct_name, type_intruder_field_name, type_key_field_name, comparator \
103) \
104 CCC_private_adaptive_map_for( \
105 struct_name, type_intruder_field_name, type_key_field_name, comparator \
106 )
107
125#define CCC_adaptive_map_from( \
126 type_intruder_field_name, \
127 type_key_field_name, \
128 comparator, \
129 allocator, \
130 destructor, \
131 compound_literal_array... \
132) \
133 CCC_private_adaptive_map_from( \
134 type_intruder_field_name, \
135 type_key_field_name, \
136 comparator, \
137 allocator, \
138 destructor, \
139 compound_literal_array \
140 )
141
153[[nodiscard]] CCC_Tribool
154CCC_adaptive_map_contains(CCC_Adaptive_map *map, void const *key);
155
160[[nodiscard]] void *
161CCC_adaptive_map_get_key_value(CCC_Adaptive_map *map, void const *key);
162
183[[nodiscard]] CCC_Entry CCC_adaptive_map_swap_entry(
184 CCC_Adaptive_map *map,
185 CCC_Adaptive_map_node *type_intruder,
186 CCC_Adaptive_map_node *temp_intruder,
187 CCC_Allocator const *allocator
188);
189
205#define CCC_adaptive_map_swap_entry_wrap( \
206 map_pointer, \
207 type_intruder_pointer, \
208 temp_intruder_pointer, \
209 allocator_pointer... \
210) \
211 &(struct { CCC_Entry private; }){CCC_adaptive_map_swap_entry( \
212 (map_pointer), \
213 (type_intruder_pointer), \
214 (temp_intruder_pointer), \
215 allocator_pointer \
216 )} \
217 .private
218
227[[nodiscard]] CCC_Entry CCC_adaptive_map_try_insert(
228 CCC_Adaptive_map *map,
229 CCC_Adaptive_map_node *type_intruder,
230 CCC_Allocator const *allocator
231);
232
243#define CCC_adaptive_map_try_insert_wrap( \
244 map_pointer, type_intruder_pointer, allocator_pointer... \
245) \
246 &(struct { CCC_Entry private; }){ \
247 CCC_adaptive_map_try_insert( \
248 (map_pointer), (type_intruder_pointer), allocator_pointer \
249 )} \
250 .private
251
266#define CCC_adaptive_map_try_insert_with( \
267 map_pointer, key, allocator_pointer, compound_literal_type... \
268) \
269 &(struct { CCC_Entry private; }){ \
270 CCC_private_adaptive_map_try_insert_with( \
271 map_pointer, key, allocator_pointer, compound_literal_type \
272 )} \
273 .private
274
284[[nodiscard]] CCC_Entry CCC_adaptive_map_insert_or_assign(
285 CCC_Adaptive_map *map,
286 CCC_Adaptive_map_node *type_intruder,
287 CCC_Allocator const *allocator
288);
289
299#define CCC_adaptive_map_insert_or_assign_wrap( \
300 map_pointer, type_pointer, allocator_pointer... \
301) \
302 &(struct { CCC_Entry private; }){ \
303 CCC_adaptive_map_insert_or_assign( \
304 map_pointer, type_pointer, allocator_pointer \
305 )} \
306 .private
307
322#define CCC_adaptive_map_insert_or_assign_with( \
323 map_pointer, key, allocator_pointer, compound_literal_type... \
324) \
325 &(struct { CCC_Entry private; }){ \
326 CCC_private_adaptive_map_insert_or_assign_with( \
327 map_pointer, key, allocator_pointer, compound_literal_type \
328 )} \
329 .private
330
347[[nodiscard]] CCC_Entry CCC_adaptive_map_remove_key_value(
348 CCC_Adaptive_map *map,
349 CCC_Adaptive_map_node *type_output_intruder,
350 CCC_Allocator const *allocator
351);
352
370#define CCC_adaptive_map_remove_key_value_wrap( \
371 map_pointer, type_output_intruder_pointer, allocator_pointer... \
372) \
373 &(struct { CCC_Entry private; }){ \
374 CCC_adaptive_map_remove_key_value( \
375 (map_pointer), (type_output_intruder_pointer), allocator_pointer \
376 )} \
377 .private
378
393[[nodiscard]] CCC_Adaptive_map_entry
394CCC_adaptive_map_entry(CCC_Adaptive_map *map, void const *key);
395
412#define CCC_adaptive_map_entry_wrap(map_pointer, key_pointer...) \
413 &(struct { CCC_Adaptive_map_entry private; }){ \
414 CCC_adaptive_map_entry((map_pointer), key_pointer)} \
415 .private
416
421[[nodiscard]] CCC_Adaptive_map_entry *CCC_adaptive_map_and_modify(
422 CCC_Adaptive_map_entry *entry, CCC_Modifier const *modifier
423);
424
460#define CCC_adaptive_map_and_modify_with( \
461 adaptive_map_entry_pointer, \
462 closure_parameter, \
463 closure_over_closure_parameter... \
464) \
465 &(struct { CCC_Adaptive_map_entry private; }){ \
466 CCC_private_adaptive_map_and_modify_with( \
467 adaptive_map_entry_pointer, \
468 closure_parameter, \
469 closure_over_closure_parameter \
470 )} \
471 .private
472
487[[nodiscard]] void *CCC_adaptive_map_or_insert(
488 CCC_Adaptive_map_entry const *entry,
489 CCC_Adaptive_map_node *type_intruder,
490 CCC_Allocator const *allocator
491);
492
505#define CCC_adaptive_map_or_insert_with( \
506 adaptive_map_entry_pointer, allocator_pointer, type_compound_literal... \
507) \
508 CCC_private_adaptive_map_or_insert_with( \
509 adaptive_map_entry_pointer, allocator_pointer, type_compound_literal \
510 )
511
520[[nodiscard]] void *CCC_adaptive_map_insert_entry(
521 CCC_Adaptive_map_entry const *entry,
522 CCC_Adaptive_map_node *type_intruder,
523 CCC_Allocator const *allocator
524);
525
533#define CCC_adaptive_map_insert_entry_with( \
534 adaptive_map_entry_pointer, allocator_pointer, type_compound_literal... \
535) \
536 CCC_private_adaptive_map_insert_entry_with( \
537 adaptive_map_entry_pointer, allocator_pointer, type_compound_literal \
538 )
539
551[[nodiscard]] CCC_Entry CCC_adaptive_map_remove_entry(
552 CCC_Adaptive_map_entry *entry, CCC_Allocator const *allocator
553);
554
566#define CCC_adaptive_map_remove_entry_wrap( \
567 adaptive_map_entry_pointer, allocator_pointer... \
568) \
569 &(struct { CCC_Entry private; }){ \
570 CCC_adaptive_map_remove_entry( \
571 (adaptive_map_entry_pointer), allocator_pointer \
572 )} \
573 .private
574
578[[nodiscard]] void *
579CCC_adaptive_map_unwrap(CCC_Adaptive_map_entry const *entry);
580
584[[nodiscard]] CCC_Tribool
585CCC_adaptive_map_occupied(CCC_Adaptive_map_entry const *entry);
586
592[[nodiscard]] CCC_Tribool
593CCC_adaptive_map_insert_error(CCC_Adaptive_map_entry const *entry);
594
604[[nodiscard]] CCC_Entry_status
605CCC_adaptive_map_entry_status(CCC_Adaptive_map_entry const *entry);
606
633[[nodiscard]] CCC_Range CCC_adaptive_map_equal_range(
634 CCC_Adaptive_map *map, void const *begin_key, void const *end_key
635);
636
644#define CCC_adaptive_map_equal_range_wrap( \
645 map_pointer, begin_and_end_key_pointers... \
646) \
647 &(struct { CCC_Range private; }){ \
648 CCC_adaptive_map_equal_range(map_pointer, begin_and_end_key_pointers)} \
649 .private
650
674[[nodiscard]] CCC_Range_reverse CCC_adaptive_map_equal_range_reverse(
675 CCC_Adaptive_map *map,
676 void const *reverse_begin_key,
677 void const *reverse_end_key
678);
679
687#define CCC_adaptive_map_equal_range_reverse_wrap( \
688 map_pointer, reverse_begin_and_reverse_end_key_pointers... \
689) \
690 &(struct { CCC_Range_reverse private; }){ \
691 CCC_adaptive_map_equal_range_reverse( \
692 map_pointer, reverse_begin_and_reverse_end_key_pointers \
693 )} \
694 .private
695
700[[nodiscard]] void *CCC_adaptive_map_begin(CCC_Adaptive_map const *map);
701
706[[nodiscard]] void *CCC_adaptive_map_reverse_begin(CCC_Adaptive_map const *map);
707
713[[nodiscard]] void *CCC_adaptive_map_next(
714 CCC_Adaptive_map const *map, CCC_Adaptive_map_node const *iterator_intruder
715);
716
724[[nodiscard]] void *CCC_adaptive_map_reverse_next(
725 CCC_Adaptive_map const *map, CCC_Adaptive_map_node const *iterator_intruder
726);
727
731[[nodiscard]] void *CCC_adaptive_map_end(CCC_Adaptive_map const *map);
732
737[[nodiscard]] void *CCC_adaptive_map_reverse_end(CCC_Adaptive_map const *map);
738
756CCC_Result CCC_adaptive_map_clear(
757 CCC_Adaptive_map *map,
758 CCC_Destructor const *destructor,
759 CCC_Allocator const *allocator
760);
761
771[[nodiscard]] CCC_Tribool
772CCC_adaptive_map_is_empty(CCC_Adaptive_map const *map);
773
777[[nodiscard]] CCC_Count CCC_adaptive_map_count(CCC_Adaptive_map const *map);
778
783[[nodiscard]] CCC_Tribool
784CCC_adaptive_map_validate(CCC_Adaptive_map const *map);
785
790#ifdef ADAPTIVE_MAP_USING_NAMESPACE_CCC
791/* NOLINTBEGIN(readability-identifier-naming) */
792typedef CCC_Adaptive_map_node Adaptive_map_node;
793typedef CCC_Adaptive_map Adaptive_map;
794typedef CCC_Adaptive_map_entry Adaptive_map_entry;
795# define adaptive_map_default(arguments...) \
796 CCC_adaptive_map_default(arguments)
797# define adaptive_map_for(arguments...) CCC_adaptive_map_for(arguments)
798# define adaptive_map_from(arguments...) CCC_adaptive_map_from(arguments)
799# define adaptive_map_and_modify_with(arguments...) \
800 CCC_adaptive_map_and_modify_with(arguments)
801# define adaptive_map_or_insert_with(arguments...) \
802 CCC_adaptive_map_or_insert_with(arguments)
803# define adaptive_map_insert_entry_with(arguments...) \
804 CCC_adaptive_map_insert_entry_with(arguments)
805# define adaptive_map_try_insert_wrap(arguments...) \
806 CCC_adaptive_map_try_insert_wrap(arguments)
807# define adaptive_map_try_insert_with(arguments...) \
808 CCC_adaptive_map_try_insert_with(arguments)
809# define adaptive_map_insert_or_assign(arguments...) \
810 CCC_adaptive_map_insert_or_assign(arguments)
811# define adaptive_map_insert_or_assign_wrap(arguments...) \
812 CCC_adaptive_map_insert_or_assign_wrap(arguments)
813# define adaptive_map_insert_or_assign_with(arguments...) \
814 CCC_adaptive_map_insert_or_assign_with(arguments)
815# define adaptive_map_swap_entry_wrap(arguments...) \
816 CCC_adaptive_map_swap_entry_wrap(arguments)
817# define adaptive_map_remove_key_value_wrap(arguments...) \
818 CCC_adaptive_map_remove_key_value_wrap(arguments)
819# define adaptive_map_remove_entry_wrap(arguments...) \
820 CCC_adaptive_map_remove_entry_wrap(arguments)
821# define adaptive_map_entry_wrap(arguments...) \
822 CCC_adaptive_map_entry_wrap(arguments)
823# define adaptive_map_and_modify(arguments...) \
824 CCC_adaptive_map_and_modify(arguments)
825# define adaptive_map_and_modify_wrap(arguments...) \
826 CCC_adaptive_map_and_modify_wrap(arguments)
827# define adaptive_map_contains(arguments...) \
828 CCC_adaptive_map_contains(arguments)
829# define adaptive_map_get_key_value(arguments...) \
830 CCC_adaptive_map_get_key_value(arguments)
831# define adaptive_map_get_mut(arguments...) \
832 CCC_adaptive_map_get_mut(arguments)
833# define adaptive_map_swap_entry(arguments...) \
834 CCC_adaptive_map_swap_entry(arguments)
835# define adaptive_map_remove_key_value(arguments...) \
836 CCC_adaptive_map_remove_key_value(arguments)
837# define adaptive_map_entry(arguments...) CCC_adaptive_map_entry(arguments)
838# define adaptive_map_remove_entry(arguments...) \
839 CCC_adaptive_map_remove_entry(arguments)
840# define adaptive_map_or_insert(arguments...) \
841 CCC_adaptive_map_or_insert(arguments)
842# define adaptive_map_insert_entry(arguments...) \
843 CCC_adaptive_map_insert_entry(arguments)
844# define adaptive_map_unwrap(arguments...) CCC_adaptive_map_unwrap(arguments)
845# define adaptive_map_unwrap_mut(arguments...) \
846 CCC_adaptive_map_unwrap_mut(arguments)
847# define adaptive_map_begin(arguments...) CCC_adaptive_map_begin(arguments)
848# define adaptive_map_next(arguments...) CCC_adaptive_map_next(arguments)
849# define adaptive_map_reverse_begin(arguments...) \
850 CCC_adaptive_map_reverse_begin(arguments)
851# define adaptive_map_reverse_next(arguments...) \
852 CCC_adaptive_map_reverse_next(arguments)
853# define adaptive_map_equal_range(arguments...) \
854 CCC_adaptive_map_equal_range(arguments)
855# define adaptive_map_equal_range_wrap(arguments...) \
856 CCC_adaptive_map_equal_range_wrap(arguments)
857# define adaptive_map_equal_range_reverse(arguments...) \
858 CCC_adaptive_map_equal_range_reverse(arguments)
859# define adaptive_map_equal_range_reverse_wrap(arguments...) \
860 CCC_adaptive_map_equal_range_reverse_wrap(arguments)
861# define adaptive_map_end(arguments...) CCC_adaptive_map_end(arguments)
862# define adaptive_map_reverse_end(arguments...) \
863 CCC_adaptive_map_reverse_end(arguments)
864# define adaptive_map_count(arguments...) CCC_adaptive_map_count(arguments)
865# define adaptive_map_is_empty(arguments...) \
866 CCC_adaptive_map_is_empty(arguments)
867# define adaptive_map_clear(arguments...) CCC_adaptive_map_clear(arguments)
868# define adaptive_map_validate(arguments...) \
869 CCC_adaptive_map_validate(arguments)
870# define adaptive_map_entry_status(arguments...) \
871 CCC_adaptive_map_entry_status(arguments)
872/* NOLINTEND(readability-identifier-naming) */
873#endif
874
875#endif /* CCC_ADAPTIVE_MAP_H */
CCC_adaptive_map_equal_range
CCC_Range CCC_adaptive_map_equal_range(CCC_Adaptive_map *map, void const *begin_key, void const *end_key)
Return an iterable range of values from [begin_key, end_key). Amortized O(lg N).
CCC_adaptive_map_reverse_end
void * CCC_adaptive_map_reverse_end(CCC_Adaptive_map const *map)
Return the reverse_end of a reverse inorder traversal of the map. O(1).
CCC_adaptive_map_validate
CCC_Tribool CCC_adaptive_map_validate(CCC_Adaptive_map const *map)
Validation of invariants for the map.
CCC_adaptive_map_entry_status
CCC_Entry_status CCC_adaptive_map_entry_status(CCC_Adaptive_map_entry const *entry)
Obtain the entry status from a container entry.
CCC_adaptive_map_next
void * CCC_adaptive_map_next(CCC_Adaptive_map const *map, CCC_Adaptive_map_node const *iterator_intruder)
Return the next element in an inorder traversal of the map. O(1).
CCC_adaptive_map_and_modify
CCC_Adaptive_map_entry * CCC_adaptive_map_and_modify(CCC_Adaptive_map_entry *entry, CCC_Modifier const *modifier)
Modifies the provided entry if it is Occupied.
CCC_adaptive_map_remove_key_value
CCC_Entry CCC_adaptive_map_remove_key_value(CCC_Adaptive_map *map, CCC_Adaptive_map_node *type_output_intruder, CCC_Allocator const *allocator)
Removes the key value in the map storing the old value, if present, in the struct containing type_out...
CCC_adaptive_map_contains
CCC_Tribool CCC_adaptive_map_contains(CCC_Adaptive_map *map, void const *key)
Searches the map for the presence of key.
CCC_adaptive_map_remove_entry
CCC_Entry CCC_adaptive_map_remove_entry(CCC_Adaptive_map_entry *entry, CCC_Allocator const *allocator)
Remove the entry from the map if Occupied.
CCC_adaptive_map_swap_entry
CCC_Entry CCC_adaptive_map_swap_entry(CCC_Adaptive_map *map, CCC_Adaptive_map_node *type_intruder, CCC_Adaptive_map_node *temp_intruder, CCC_Allocator const *allocator)
Invariantly inserts the key value wrapping type_intruder.
CCC_adaptive_map_insert_entry
void * CCC_adaptive_map_insert_entry(CCC_Adaptive_map_entry const *entry, CCC_Adaptive_map_node *type_intruder, CCC_Allocator const *allocator)
Inserts the provided entry invariantly.
CCC_adaptive_map_insert_error
CCC_Tribool CCC_adaptive_map_insert_error(CCC_Adaptive_map_entry const *entry)
Provides the status of the entry should an insertion follow.
CCC_adaptive_map_reverse_next
void * CCC_adaptive_map_reverse_next(CCC_Adaptive_map const *map, CCC_Adaptive_map_node const *iterator_intruder)
Return the reverse_next element in a reverse inorder traversal of the map. O(1).
CCC_adaptive_map_clear
CCC_Result CCC_adaptive_map_clear(CCC_Adaptive_map *map, CCC_Destructor const *destructor, CCC_Allocator const *allocator)
Pops every element from the map calling destructor if destructor is non-NULL. O(N).
CCC_adaptive_map_entry
CCC_Adaptive_map_entry CCC_adaptive_map_entry(CCC_Adaptive_map *map, void const *key)
Obtains an entry for the provided key in the map for future use.
CCC_adaptive_map_try_insert
CCC_Entry CCC_adaptive_map_try_insert(CCC_Adaptive_map *map, CCC_Adaptive_map_node *type_intruder, CCC_Allocator const *allocator)
Attempts to insert the key value wrapping type_intruder.
CCC_adaptive_map_is_empty
CCC_Tribool CCC_adaptive_map_is_empty(CCC_Adaptive_map const *map)
Returns the size status of the map.
CCC_adaptive_map_insert_or_assign
CCC_Entry CCC_adaptive_map_insert_or_assign(CCC_Adaptive_map *map, CCC_Adaptive_map_node *type_intruder, CCC_Allocator const *allocator)
Invariantly inserts or overwrites a user struct into the map.
CCC_adaptive_map_end
void * CCC_adaptive_map_end(CCC_Adaptive_map const *map)
Return the end of an inorder traversal of the map. O(1).
CCC_adaptive_map_begin
void * CCC_adaptive_map_begin(CCC_Adaptive_map const *map)
Return the start of an inorder traversal of the map. Amortized O(lg N).
CCC_adaptive_map_get_key_value
void * CCC_adaptive_map_get_key_value(CCC_Adaptive_map *map, void const *key)
Returns a reference into the map at entry key.
CCC_adaptive_map_reverse_begin
void * CCC_adaptive_map_reverse_begin(CCC_Adaptive_map const *map)
Return the start of a reverse inorder traversal of the map. Amortized O(lg N).
CCC_adaptive_map_or_insert
void * CCC_adaptive_map_or_insert(CCC_Adaptive_map_entry const *entry, CCC_Adaptive_map_node *type_intruder, CCC_Allocator const *allocator)
Inserts the struct with handle type_intruder if the entry is Vacant.
CCC_adaptive_map_occupied
CCC_Tribool CCC_adaptive_map_occupied(CCC_Adaptive_map_entry const *entry)
Returns the Vacant or Occupied status of the entry.
CCC_adaptive_map_unwrap
void * CCC_adaptive_map_unwrap(CCC_Adaptive_map_entry const *entry)
Unwraps the provided entry to obtain a view into the map element.
CCC_adaptive_map_equal_range_reverse
CCC_Range_reverse CCC_adaptive_map_equal_range_reverse(CCC_Adaptive_map *map, void const *reverse_begin_key, void const *reverse_end_key)
Return an iterable range_reverse of values from [begin_key, end_key). Amortized O(lg N).
CCC_adaptive_map_count
CCC_Count CCC_adaptive_map_count(CCC_Adaptive_map const *map)
Returns the count of occupied map nodes.
private_adaptive_map.h
The Adaptive Map Private Interface.
CCC_Adaptive_map_entry
Definition: private_adaptive_map.h:85
CCC_Adaptive_map_entry::entry
CCC_Entry entry
Definition: private_adaptive_map.h:89
CCC_Adaptive_map_entry::map
struct CCC_Adaptive_map * map
Definition: private_adaptive_map.h:87
CCC_Adaptive_map_node
Definition: private_adaptive_map.h:42
CCC_Adaptive_map
Definition: private_adaptive_map.h:56
CCC_Allocator
The type passed by reference to any container function that may need to allocate memory....
Definition: types.h:376
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_Entry
An Occupied or Vacant position in a searchable container.
Definition: types.h:135
CCC_Modifier
The type passed by reference to any container function that may need to modify elements....
Definition: types.h:436
CCC_Range_reverse
The result of a range_reverse query on iterable containers.
Definition: types.h:55
CCC_Range
The result of a range query on iterable containers.
Definition: types.h:42
types.h
The C Container Collection Fundamental Types.
CCC_Entry_status
CCC_Entry_status
The status monitoring and entry state once it is obtained.
Definition: types.h:112
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