C Container Collection (CCC)
Loading...
Searching...
No Matches
array_tree_map.h
Go to the documentation of this file.
1
55#ifndef CCC_ARRAY_TREE_MAP_H
56#define CCC_ARRAY_TREE_MAP_H
57
59#include <stddef.h>
62#include "private/private_array_tree_map.h"
63#include "types.h"
64
75typedef struct CCC_Array_tree_map CCC_Array_tree_map;
76
85typedef union CCC_Array_tree_map_handle_wrap CCC_Array_tree_map_handle;
86
160#define CCC_array_tree_map_declare_fixed(fixed_map_type_name, type_name, \
161 capacity) \
162 CCC_private_array_tree_map_declare_fixed(fixed_map_type_name, type_name, \
163 capacity)
164
168#define CCC_array_tree_map_fixed_capacity(fixed_map_type_name) \
169 CCC_private_array_tree_map_fixed_capacity(fixed_map_type_name)
170
184#define CCC_array_tree_map_initialize(memory_pointer, type_name, \
185 type_key_field, compare, allocate, \
186 context_data, capacity) \
187 CCC_private_array_tree_map_initialize(memory_pointer, type_name, \
188 type_key_field, compare, allocate, \
189 context_data, capacity)
190
247#define CCC_array_tree_map_from(type_key_field, compare, allocate, \
248 context_data, optional_capacity, \
249 type_compound_literal_array...) \
250 CCC_private_array_tree_map_from(type_key_field, compare, allocate, \
251 context_data, optional_capacity, \
252 type_compound_literal_array)
253
299#define CCC_array_tree_map_with_capacity(type_name, type_key_field, compare, \
300 allocate, context_data, capacity) \
301 CCC_private_array_tree_map_with_capacity( \
302 type_name, type_key_field, compare, allocate, context_data, capacity)
303
331#define CCC_array_tree_map_with_compound_literal(type_key_field, compare, \
332 compound_literal) \
333 CCC_private_array_tree_map_with_compound_literal(type_key_field, compare, \
334 compound_literal)
335
365#define CCC_array_tree_map_with_context_compound_literal( \
366 type_key_field, compare, context, compound_literal) \
367 CCC_private_array_tree_map_with_context_compound_literal( \
368 type_key_field, compare, context, compound_literal)
369
496CCC_Result CCC_array_tree_map_copy(CCC_Array_tree_map *destination,
497 CCC_Array_tree_map const *source,
498 CCC_Allocator *allocate);
499
519CCC_Result CCC_array_tree_map_reserve(CCC_Array_tree_map *map, size_t to_add,
520 CCC_Allocator *allocate);
521
538[[nodiscard]] void *CCC_array_tree_map_at(CCC_Array_tree_map const *handle,
539 CCC_Handle_index index);
540
547#define CCC_array_tree_map_as(array_tree_map_pointer, type_name, \
548 array_index...) \
549 CCC_private_array_tree_map_as(array_tree_map_pointer, type_name, \
550 array_index)
551
557[[nodiscard]] CCC_Tribool
558CCC_array_tree_map_contains(CCC_Array_tree_map const *map, void const *key);
559
564[[nodiscard]] CCC_Handle_index
565CCC_array_tree_map_get_key_value(CCC_Array_tree_map const *map,
566 void const *key);
567
584[[nodiscard]] CCC_Handle CCC_array_tree_map_swap_handle(CCC_Array_tree_map *map,
585 void *type_output);
586
597#define CCC_array_tree_map_swap_handle_wrap(array_tree_map_pointer, \
598 type_output_pointer) \
599 &(CCC_Handle) \
600 { \
601 CCC_array_tree_map_swap_handle((array_tree_map_pointer), \
602 (type_output_pointer)) \
603 .private \
604 }
605
613[[nodiscard]] CCC_Handle CCC_array_tree_map_try_insert(CCC_Array_tree_map *map,
614 void const *type);
615
623#define CCC_array_tree_map_try_insert_wrap(array_tree_map_pointer, \
624 type_pointer) \
625 &(CCC_Handle) \
626 { \
627 CCC_array_tree_map_try_insert((array_tree_map_pointer), \
628 (type_pointer)) \
629 .private \
630 }
631
645#define CCC_array_tree_map_try_insert_with(array_tree_map_pointer, key, \
646 type_compound_literal...) \
647 &(CCC_Handle) \
648 { \
649 CCC_private_array_tree_map_try_insert_with(array_tree_map_pointer, \
650 key, type_compound_literal) \
651 }
652
661[[nodiscard]] CCC_Handle
662CCC_array_tree_map_insert_or_assign(CCC_Array_tree_map *map, void const *type);
663
677#define CCC_array_tree_map_insert_or_assign_with(array_tree_map_pointer, key, \
678 type_compound_literal...) \
679 &(CCC_Handle) \
680 { \
681 CCC_private_array_tree_map_insert_or_assign_with( \
682 array_tree_map_pointer, key, type_compound_literal) \
683 }
684
694[[nodiscard]] CCC_Handle
695CCC_array_tree_map_remove_key_value(CCC_Array_tree_map *map, void *type_output);
696
707#define CCC_array_tree_map_remove_key_value_wrap(array_tree_map_pointer, \
708 type_output_pointer) \
709 &(CCC_Handle) \
710 { \
711 CCC_array_tree_map_remove_key_value((array_tree_map_pointer), \
712 (type_output_pointer)) \
713 .private \
714 }
715
731[[nodiscard]] CCC_Array_tree_map_handle
732CCC_array_tree_map_handle(CCC_Array_tree_map const *map, void const *key);
733
750#define CCC_array_tree_map_handle_wrap(array_tree_map_pointer, key_pointer) \
751 &(CCC_Array_tree_map_handle) \
752 { \
753 CCC_array_tree_map_handle((array_tree_map_pointer), (key_pointer)) \
754 .private \
755 }
756
766[[nodiscard]] CCC_Array_tree_map_handle *
767CCC_array_tree_map_and_modify(CCC_Array_tree_map_handle *handle,
768 CCC_Type_modifier *modify);
769
778[[nodiscard]] CCC_Array_tree_map_handle *
779CCC_array_tree_map_and_modify_context(CCC_Array_tree_map_handle *handle,
780 CCC_Type_modifier *modify, void *context);
781
819#define CCC_array_tree_map_and_modify_with(map_array_pointer, type_name, \
820 closure_over_T...) \
821 &(CCC_Array_tree_map_handle) \
822 { \
823 CCC_private_array_tree_map_and_modify_with(map_array_pointer, \
824 type_name, closure_over_T) \
825 }
826
838[[nodiscard]] CCC_Handle_index
839CCC_array_tree_map_or_insert(CCC_Array_tree_map_handle const *handle,
840 void const *type);
841
854#define CCC_array_tree_map_or_insert_with(map_array_pointer, \
855 type_compound_literal...) \
856 CCC_private_array_tree_map_or_insert_with(map_array_pointer, \
857 type_compound_literal)
858
866[[nodiscard]] CCC_Handle_index
867CCC_array_tree_map_insert_handle(CCC_Array_tree_map_handle const *handle,
868 void const *type);
869
877#define CCC_array_tree_map_insert_array_with(map_array_pointer, \
878 type_compound_literal...) \
879 CCC_private_array_tree_map_insert_array_with(map_array_pointer, \
880 type_compound_literal)
881
889CCC_Handle
890CCC_array_tree_map_remove_handle(CCC_Array_tree_map_handle const *handle);
891
900#define CCC_array_tree_map_remove_handle_wrap(map_array_pointer) \
901 &(CCC_Handle) \
902 { \
903 CCC_array_tree_map_remove_handle((map_array_pointer)).private \
904 }
905
909[[nodiscard]] CCC_Handle_index
910CCC_array_tree_map_unwrap(CCC_Array_tree_map_handle const *handle);
911
916[[nodiscard]] CCC_Tribool
917CCC_array_tree_map_occupied(CCC_Array_tree_map_handle const *handle);
918
924[[nodiscard]] CCC_Tribool
925CCC_array_tree_map_insert_error(CCC_Array_tree_map_handle const *handle);
926
936[[nodiscard]] CCC_Handle_status
937CCC_array_tree_map_handle_status(CCC_Array_tree_map_handle const *handle);
938
952CCC_Result CCC_array_tree_map_clear(CCC_Array_tree_map *map,
953 CCC_Type_destructor *destroy);
954
965CCC_Result CCC_array_tree_map_clear_and_free(CCC_Array_tree_map *map,
966 CCC_Type_destructor *destroy);
967
1001CCC_Result
1002CCC_array_tree_map_clear_and_free_reserve(CCC_Array_tree_map *map,
1003 CCC_Type_destructor *destroy,
1004 CCC_Allocator *allocate);
1005
1031[[nodiscard]] CCC_Handle_range
1032CCC_array_tree_map_equal_range(CCC_Array_tree_map const *map,
1033 void const *begin_key, void const *end_key);
1034
1041#define CCC_array_tree_map_equal_range_wrap(array_tree_map_pointer, \
1042 begin_and_end_key_pointers...) \
1043 &(CCC_Handle_range) \
1044 { \
1045 CCC_array_tree_map_equal_range((array_tree_map_pointer), \
1046 (begin_and_end_key_pointers)) \
1047 .private \
1048 }
1049
1073[[nodiscard]] CCC_Handle_range_reverse
1074CCC_array_tree_map_equal_range_reverse(CCC_Array_tree_map const *map,
1075 void const *reverse_begin_key,
1076 void const *reverse_end_key);
1077
1085#define CCC_array_tree_map_equal_range_reverse_wrap( \
1086 array_tree_map_pointer, reverse_begin_and_reverse_end_key_pointers...) \
1087 &(CCC_Handle_range_reverse) \
1088 { \
1089 CCC_array_tree_map_equal_range_reverse( \
1090 (array_tree_map_pointer), \
1091 (reverse_begin_and_reverse_end_key_pointers)) \
1092 .private \
1093 }
1094
1098[[nodiscard]] CCC_Handle_index
1099CCC_array_tree_map_begin(CCC_Array_tree_map const *map);
1100
1104[[nodiscard]] CCC_Handle_index
1105CCC_array_tree_map_reverse_begin(CCC_Array_tree_map const *map);
1106
1113[[nodiscard]] CCC_Handle_index
1114CCC_array_tree_map_next(CCC_Array_tree_map const *map,
1115 CCC_Handle_index iterator);
1116
1124[[nodiscard]] CCC_Handle_index
1125CCC_array_tree_map_reverse_next(CCC_Array_tree_map const *map,
1126 CCC_Handle_index iterator);
1127
1131[[nodiscard]] CCC_Handle_index
1132CCC_array_tree_map_end(CCC_Array_tree_map const *map);
1133
1138[[nodiscard]] CCC_Handle_index
1139CCC_array_tree_map_reverse_end(CCC_Array_tree_map const *map);
1140
1151[[nodiscard]] CCC_Tribool
1152CCC_array_tree_map_is_empty(CCC_Array_tree_map const *map);
1153
1158[[nodiscard]] CCC_Count CCC_array_tree_map_count(CCC_Array_tree_map const *map);
1159
1164[[nodiscard]] CCC_Count
1165CCC_array_tree_map_capacity(CCC_Array_tree_map const *map);
1166
1171[[nodiscard]] CCC_Tribool
1172CCC_array_tree_map_validate(CCC_Array_tree_map const *map);
1173
1178#ifdef ARRAY_TREE_MAP_USING_NAMESPACE_CCC
1179typedef CCC_Array_tree_map Array_tree_map;
1180typedef CCC_Array_tree_map_handle Array_tree_map_handle;
1181# define array_tree_map_declare_fixed(args...) \
1182 CCC_array_tree_map_declare_fixed(args)
1183# define array_tree_map_initialize(args...) \
1184 CCC_array_tree_map_initialize(args)
1185# define array_tree_map_from(args...) CCC_array_tree_map_from(args)
1186# define array_tree_map_with_capacity(args...) \
1187 CCC_array_tree_map_with_capacity(args)
1188# define array_tree_map_with_compound_literal(args...) \
1189 CCC_array_tree_map_with_compound_literal(args)
1190# define array_tree_map_with_context_compound_literal(args...) \
1191 CCC_array_tree_map_with_context_compound_literal(args)
1192# define array_tree_map_fixed_capacity(args...) \
1193 CCC_array_tree_map_fixed_capacity(args)
1194# define array_tree_map_copy(args...) CCC_array_tree_map_copy(args)
1195# define array_tree_map_reserve(args...) CCC_array_tree_map_reserve(args)
1196# define array_tree_map_at(args...) CCC_array_tree_map_at(args)
1197# define array_tree_map_as(args...) CCC_array_tree_map_as(args)
1198# define array_tree_map_and_modify_with(args...) \
1199 CCC_array_tree_map_and_modify_with(args)
1200# define array_tree_map_or_insert_with(args...) \
1201 CCC_array_tree_map_or_insert_with(args)
1202# define array_tree_map_insert_array_with(args...) \
1203 CCC_array_tree_map_insert_array_with(args)
1204# define array_tree_map_try_insert_with(args...) \
1205 CCC_array_tree_map_try_insert_with(args)
1206# define array_tree_map_insert_or_assign_with(args...) \
1207 CCC_array_tree_map_insert_or_assign_with(args)
1208# define array_tree_map_contains(args...) CCC_array_tree_map_contains(args)
1209# define array_tree_map_get_key_value(args...) \
1210 CCC_array_tree_map_get_key_value(args)
1211# define array_tree_map_swap_handle(args...) \
1212 CCC_array_tree_map_swap_handle(args)
1213# define array_tree_map_swap_handle_wrap(args...) \
1214 CCC_array_tree_map_swap_handle_wrap(args)
1215# define array_tree_map_begin(args...) CCC_array_tree_map_begin(args)
1216# define array_tree_map_reverse_begin(args...) \
1217 CCC_array_tree_map_reverse_begin(args)
1218# define array_tree_map_next(args...) CCC_array_tree_map_next(args)
1219# define array_tree_map_reverse_next(args...) \
1220 CCC_array_tree_map_reverse_next(args)
1221# define array_tree_map_end(args...) CCC_array_tree_map_end(args)
1222# define array_tree_map_reverse_end(args...) \
1223 CCC_array_tree_map_reverse_end(args)
1224# define array_tree_map_is_empty(args...) CCC_array_tree_map_is_empty(args)
1225# define array_tree_map_count(args...) CCC_array_tree_map_count(args)
1226# define array_tree_map_capacity(args...) CCC_array_tree_map_capacity(args)
1227# define array_tree_map_clear(args...) CCC_array_tree_map_clear(args)
1228# define array_tree_map_clear_and_free(args...) \
1229 CCC_array_tree_map_clear_and_free(args)
1230# define array_tree_map_clear_and_free_reserve(args...) \
1231 CCC_array_tree_map_clear_and_free_reserve(args)
1232# define array_tree_map_validate(args...) CCC_array_tree_map_validate(args)
1233#endif /* ARRAY_TREE_MAP_USING_NAMESPACE_CCC */
1234
1235#endif /* CCC_ARRAY_TREE_MAP_H */
CCC_array_tree_map_swap_handle
CCC_Handle CCC_array_tree_map_swap_handle(CCC_Array_tree_map *map, void *type_output)
Invariantly inserts the key value in type_output.
CCC_array_tree_map_reverse_begin
CCC_Handle_index CCC_array_tree_map_reverse_begin(CCC_Array_tree_map const *map)
Return the start of a reverse inorder traversal of the map. O(lg N).
CCC_array_tree_map_reverse_next
CCC_Handle_index CCC_array_tree_map_reverse_next(CCC_Array_tree_map const *map, CCC_Handle_index iterator)
Return the reverse_next element in a reverse inorder traversal of the map. O(1).
CCC_array_tree_map_copy
CCC_Result CCC_array_tree_map_copy(CCC_Array_tree_map *destination, CCC_Array_tree_map const *source, CCC_Allocator *allocate)
Copy the map at source to destination.
CCC_array_tree_map_validate
CCC_Tribool CCC_array_tree_map_validate(CCC_Array_tree_map const *map)
Validation of invariants for the map.
CCC_array_tree_map_equal_range_reverse
CCC_Handle_range_reverse CCC_array_tree_map_equal_range_reverse(CCC_Array_tree_map const *map, void const *reverse_begin_key, void const *reverse_end_key)
Return an iterable range_reverse of values from [begin_key, end_key). O(lg N).
CCC_array_tree_map_and_modify
CCC_Array_tree_map_handle * CCC_array_tree_map_and_modify(CCC_Array_tree_map_handle *handle, CCC_Type_modifier *modify)
Modifies the provided handle if it is Occupied.
CCC_array_tree_map_clear_and_free_reserve
CCC_Result CCC_array_tree_map_clear_and_free_reserve(CCC_Array_tree_map *map, CCC_Type_destructor *destroy, CCC_Allocator *allocate)
Frees all slots in the map and frees the underlying Buffer that was previously dynamically reserved w...
CCC_array_tree_map_reserve
CCC_Result CCC_array_tree_map_reserve(CCC_Array_tree_map *map, size_t to_add, CCC_Allocator *allocate)
Reserves space for at least to_add more elements.
CCC_array_tree_map_count
CCC_Count CCC_array_tree_map_count(CCC_Array_tree_map const *map)
Returns the count of map occupied slots.
CCC_array_tree_map_occupied
CCC_Tribool CCC_array_tree_map_occupied(CCC_Array_tree_map_handle const *handle)
Returns the Vacant or Occupied status of the handle.
CCC_array_tree_map_and_modify_context
CCC_Array_tree_map_handle * CCC_array_tree_map_and_modify_context(CCC_Array_tree_map_handle *handle, CCC_Type_modifier *modify, void *context)
Modifies the provided handle if it is Occupied.
CCC_array_tree_map_begin
CCC_Handle_index CCC_array_tree_map_begin(CCC_Array_tree_map const *map)
Return the start of an inorder traversal of the map. O(lg N).
CCC_array_tree_map_handle
CCC_Array_tree_map_handle CCC_array_tree_map_handle(CCC_Array_tree_map const *map, void const *key)
Obtains a handle for the provided key in the map for future use.
CCC_array_tree_map_clear
CCC_Result CCC_array_tree_map_clear(CCC_Array_tree_map *map, CCC_Type_destructor *destroy)
Frees all slots in the map for use without affecting capacity.
CCC_array_tree_map_try_insert
CCC_Handle CCC_array_tree_map_try_insert(CCC_Array_tree_map *map, void const *type)
Attempts to insert the key value in type.
CCC_array_tree_map_get_key_value
CCC_Handle_index CCC_array_tree_map_get_key_value(CCC_Array_tree_map const *map, void const *key)
Returns a reference into the map at handle key.
CCC_array_tree_map_remove_key_value
CCC_Handle CCC_array_tree_map_remove_key_value(CCC_Array_tree_map *map, void *type_output)
Removes the key value in the map storing the old value, if present, in the struct containing type_out...
CCC_array_tree_map_at
void * CCC_array_tree_map_at(CCC_Array_tree_map const *handle, CCC_Handle_index index)
Returns a reference to the user data at the provided handle.
CCC_array_tree_map_insert_or_assign
CCC_Handle CCC_array_tree_map_insert_or_assign(CCC_Array_tree_map *map, void const *type)
Invariantly inserts or overwrites a user struct into the map.
CCC_array_tree_map_is_empty
CCC_Tribool CCC_array_tree_map_is_empty(CCC_Array_tree_map const *map)
Returns the size status of the map.
CCC_array_tree_map_capacity
CCC_Count CCC_array_tree_map_capacity(CCC_Array_tree_map const *map)
Returns the capacity of the map representing total available slots.
CCC_array_tree_map_or_insert
CCC_Handle_index CCC_array_tree_map_or_insert(CCC_Array_tree_map_handle const *handle, void const *type)
Inserts the provided user type if the handle is Vacant.
CCC_array_tree_map_next
CCC_Handle_index CCC_array_tree_map_next(CCC_Array_tree_map const *map, CCC_Handle_index iterator)
Return the next element in an inorder traversal of the map. O(1).
CCC_array_tree_map_remove_handle
CCC_Handle CCC_array_tree_map_remove_handle(CCC_Array_tree_map_handle const *handle)
Remove the handle from the map if Occupied.
CCC_array_tree_map_unwrap
CCC_Handle_index CCC_array_tree_map_unwrap(CCC_Array_tree_map_handle const *handle)
Unwraps the provided handle to obtain a view into the map element.
CCC_array_tree_map_insert_error
CCC_Tribool CCC_array_tree_map_insert_error(CCC_Array_tree_map_handle const *handle)
Provides the status of the handle should an insertion follow.
CCC_array_tree_map_clear_and_free
CCC_Result CCC_array_tree_map_clear_and_free(CCC_Array_tree_map *map, CCC_Type_destructor *destroy)
Frees all slots in the map and frees the underlying buffer.
CCC_array_tree_map_equal_range
CCC_Handle_range CCC_array_tree_map_equal_range(CCC_Array_tree_map const *map, void const *begin_key, void const *end_key)
Return an iterable range of values from [begin_key, end_key). O(lgN).
CCC_array_tree_map_reverse_end
CCC_Handle_index CCC_array_tree_map_reverse_end(CCC_Array_tree_map const *map)
Return the reverse_end of a reverse inorder traversal of the map. O(1).
CCC_array_tree_map_insert_handle
CCC_Handle_index CCC_array_tree_map_insert_handle(CCC_Array_tree_map_handle const *handle, void const *type)
Inserts the provided user type invariantly.
CCC_array_tree_map_handle_status
CCC_Handle_status CCC_array_tree_map_handle_status(CCC_Array_tree_map_handle const *handle)
Obtain the handle status from a container handle.
CCC_array_tree_map_end
CCC_Handle_index CCC_array_tree_map_end(CCC_Array_tree_map const *map)
Return the end of an inorder traversal of the map. O(1).
CCC_array_tree_map_contains
CCC_Tribool CCC_array_tree_map_contains(CCC_Array_tree_map const *map, void const *key)
Searches the map for the presence of key.
CCC_Array_tree_map_handle
Definition: private_array_tree_map.h:161
CCC_Array_tree_map
Definition: private_array_tree_map.h:132
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:202
CCC_Handle_range
Definition: private_types.h:173
CCC_Handle
Definition: private_types.h:80
types.h
The C Container Collection Fundamental Types.
CCC_Handle_status
enum CCC_Entry_status CCC_Handle_status
The status monitoring and handle state once it is obtained.
Definition: types.h:119
CCC_Handle_index
size_t CCC_Handle_index
A stable index to user data in a container that uses a flat array as the underlying storage method.
Definition: types.h:109
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_Allocator
void * CCC_Allocator(CCC_Allocator_context)
An allocation function at the core of all containers.
Definition: types.h:340
CCC_Type_modifier
void CCC_Type_modifier(CCC_Type_context)
A callback function for modifying an element in the container.
Definition: types.h:358
CCC_Array_tree_map_handle_wrap
Definition: private_array_tree_map.h:174
CCC_Handle_range_reverse_wrap
Definition: private_types.h:221