C Container Collection (CCC)
Loading...
Searching...
No Matches
flat_hash_map.h
Go to the documentation of this file.
1
91#ifndef CCC_FLAT_HASH_MAP_H
92#define CCC_FLAT_HASH_MAP_H
93
95#include <stddef.h>
98#include "private/private_flat_hash_map.h"
99#include "types.h"
100
110typedef struct CCC_Flat_hash_map CCC_Flat_hash_map;
111
116typedef union CCC_Flat_hash_map_entry_wrap CCC_Flat_hash_map_entry;
117
182#define CCC_flat_hash_map_declare_fixed(fixed_map_type_name, type_name, \
183 capacity) \
184 CCC_private_flat_hash_map_declare_fixed(fixed_map_type_name, type_name, \
185 capacity)
186
191#define CCC_flat_hash_map_fixed_capacity(fixed_map_type_name) \
192 CCC_private_flat_hash_map_fixed_capacity(fixed_map_type_name)
193
256#define CCC_flat_hash_map_initialize(type_name, key_field, hash, compare, \
257 allocate, context_data, capacity, \
258 map_pointer) \
259 CCC_private_flat_hash_map_initialize(type_name, key_field, hash, compare, \
260 allocate, context_data, capacity, \
261 map_pointer)
262
321#define CCC_flat_hash_map_from(key_field, hash, compare, allocate, \
322 context_data, optional_capacity, \
323 array_compound_literal...) \
324 CCC_private_flat_hash_map_from(key_field, hash, compare, allocate, \
325 context_data, optional_capacity, \
326 array_compound_literal)
327
375#define CCC_flat_hash_map_with_capacity(type_name, key_field, hash, compare, \
376 allocate, context_data, capacity) \
377 CCC_private_flat_hash_map_with_capacity( \
378 type_name, key_field, hash, compare, allocate, context_data, capacity)
379
413#define CCC_flat_hash_map_with_compound_literal(key_field, hash, compare, \
414 compound_literal) \
415 CCC_private_flat_hash_map_with_compound_literal(key_field, hash, compare, \
416 compound_literal)
417
453#define CCC_flat_hash_map_with_context_compound_literal( \
454 key_field, hash, compare, context, compound_literal) \
455 CCC_private_flat_hash_map_with_context_compound_literal( \
456 key_field, hash, compare, context, compound_literal)
457
489#define CCC_flat_hash_map_with_allocator(type_name, key_field, hash, compare, \
490 allocate) \
491 CCC_private_flat_hash_map_with_allocator(type_name, key_field, hash, \
492 compare, allocate)
493
525#define CCC_flat_hash_map_with_context_allocator(type_name, key_field, hash, \
526 compare, allocate, context) \
527 CCC_private_flat_hash_map_with_context_allocator( \
528 type_name, key_field, hash, compare, allocate, context)
529
661CCC_Result CCC_flat_hash_map_copy(CCC_Flat_hash_map *destination,
662 CCC_Flat_hash_map const *source,
663 CCC_Allocator *allocate);
664
680CCC_Result CCC_flat_hash_map_reserve(CCC_Flat_hash_map *map, size_t to_add,
681 CCC_Allocator *allocate);
682
694[[nodiscard]] CCC_Tribool
695CCC_flat_hash_map_contains(CCC_Flat_hash_map const *map, void const *key);
696
701[[nodiscard]] void *
702CCC_flat_hash_map_get_key_value(CCC_Flat_hash_map const *map, void const *key);
703
726[[nodiscard]] CCC_Flat_hash_map_entry
727CCC_flat_hash_map_entry(CCC_Flat_hash_map *map, void const *key);
728
745#define CCC_flat_hash_map_entry_wrap(map_pointer, key_pointer) \
746 &(CCC_Flat_hash_map_entry) \
747 { \
748 CCC_flat_hash_map_entry(map_pointer, key_pointer).private \
749 }
750
760[[nodiscard]] CCC_Flat_hash_map_entry *
761CCC_flat_hash_map_and_modify(CCC_Flat_hash_map_entry *entry,
762 CCC_Type_modifier *modify);
763
772[[nodiscard]] CCC_Flat_hash_map_entry *
773CCC_flat_hash_map_and_modify_context(CCC_Flat_hash_map_entry *entry,
774 CCC_Type_modifier *modify, void *context);
775
812#define CCC_flat_hash_map_and_modify_with(map_entry_pointer, type_name, \
813 closure_over_T...) \
814 &(CCC_Flat_hash_map_entry) \
815 { \
816 CCC_private_flat_hash_map_and_modify_with(map_entry_pointer, \
817 type_name, closure_over_T) \
818 }
819
829[[nodiscard]] void *
830CCC_flat_hash_map_or_insert(CCC_Flat_hash_map_entry const *entry,
831 void const *type);
832
844#define CCC_flat_hash_map_or_insert_with(map_entry_pointer, \
845 type_compound_literal...) \
846 CCC_private_flat_hash_map_or_insert_with(map_entry_pointer, \
847 type_compound_literal)
848
860[[nodiscard]] void *
861CCC_flat_hash_map_insert_entry(CCC_Flat_hash_map_entry const *entry,
862 void const *type);
863
870#define CCC_flat_hash_map_insert_entry_with(map_entry_pointer, \
871 type_compound_literal...) \
872 CCC_private_flat_hash_map_insert_entry_with(map_entry_pointer, \
873 type_compound_literal)
874
885[[nodiscard]]
886CCC_Entry CCC_flat_hash_map_swap_entry(CCC_Flat_hash_map *map,
887 void *type_output);
888
901#define CCC_flat_hash_map_swap_entry_wrap(map_pointer, type_pointer) \
902 &(CCC_Entry) \
903 { \
904 CCC_flat_hash_map_swap_entry(map_pointer, type_pointer).private \
905 }
906
911[[nodiscard]] CCC_Entry
912CCC_flat_hash_map_remove_entry(CCC_Flat_hash_map_entry const *entry);
913
919#define CCC_flat_hash_map_remove_entry_wrap(map_entry_pointer) \
920 &(CCC_Entry) \
921 { \
922 CCC_flat_hash_map_remove_entry(map_entry_pointer).private \
923 }
924
934[[nodiscard]]
935CCC_Entry CCC_flat_hash_map_try_insert(CCC_Flat_hash_map *map,
936 void const *type);
937
948#define CCC_flat_hash_map_try_insert_wrap(map_pointer, type_pointer) \
949 &(CCC_Entry) \
950 { \
951 CCC_flat_hash_map_try_insert(map_pointer, type_pointer).private \
952 }
953
970#define CCC_flat_hash_map_try_insert_with(map_pointer, key, \
971 type_compound_literal...) \
972 &(CCC_Entry) \
973 { \
974 CCC_private_flat_hash_map_try_insert_with(map_pointer, key, \
975 type_compound_literal) \
976 }
977
986[[nodiscard]]
987CCC_Entry CCC_flat_hash_map_insert_or_assign(CCC_Flat_hash_map *map,
988 void const *type);
989
998#define CCC_flat_hash_map_insert_or_assign_wrap(map_pointer, type_pointer) \
999 &(CCC_Entry) \
1000 { \
1001 CCC_flat_hash_map_insert_or_assign(map_pointer, type_pointer).private \
1002 }
1003
1016#define CCC_flat_hash_map_insert_or_assign_with(map_pointer, key, \
1017 type_compound_literal...) \
1018 &(CCC_Entry) \
1019 { \
1020 CCC_private_flat_hash_map_insert_or_assign_with(map_pointer, key, \
1021 type_compound_literal) \
1022 }
1023
1036[[nodiscard]] CCC_Entry
1037CCC_flat_hash_map_remove_key_value(CCC_Flat_hash_map *map, void *type_output);
1038
1052#define CCC_flat_hash_map_remove_key_value_wrap(map_pointer, \
1053 type_output_pointer) \
1054 &(CCC_Entry) \
1055 { \
1056 CCC_flat_hash_map_remove_key_value(map_pointer, type_output_pointer) \
1057 .private \
1058 }
1059
1063[[nodiscard]] void *
1064CCC_flat_hash_map_unwrap(CCC_Flat_hash_map_entry const *entry);
1065
1069[[nodiscard]] CCC_Tribool
1070CCC_flat_hash_map_occupied(CCC_Flat_hash_map_entry const *entry);
1071
1087[[nodiscard]] CCC_Tribool
1088CCC_flat_hash_map_insert_error(CCC_Flat_hash_map_entry const *entry);
1089
1099[[nodiscard]] CCC_Entry_status
1100CCC_flat_hash_map_entry_status(CCC_Flat_hash_map_entry const *entry);
1101
1115CCC_Result CCC_flat_hash_map_clear(CCC_Flat_hash_map *map,
1116 CCC_Type_destructor *destroy);
1117
1126CCC_Result CCC_flat_hash_map_clear_and_free(CCC_Flat_hash_map *map,
1127 CCC_Type_destructor *destroy);
1128
1156CCC_Result
1157CCC_flat_hash_map_clear_and_free_reserve(CCC_Flat_hash_map *map,
1158 CCC_Type_destructor *destroy,
1159 CCC_Allocator *allocate);
1160
1175[[nodiscard]] void *CCC_flat_hash_map_begin(CCC_Flat_hash_map const *map);
1176
1183[[nodiscard]] void *CCC_flat_hash_map_next(CCC_Flat_hash_map const *map,
1184 void const *type_iterator);
1185
1190[[nodiscard]] void *CCC_flat_hash_map_end(CCC_Flat_hash_map const *map);
1191
1201[[nodiscard]] CCC_Tribool
1202CCC_flat_hash_map_is_empty(CCC_Flat_hash_map const *map);
1203
1207[[nodiscard]] CCC_Count CCC_flat_hash_map_count(CCC_Flat_hash_map const *map);
1208
1212[[nodiscard]] CCC_Count
1213CCC_flat_hash_map_capacity(CCC_Flat_hash_map const *map);
1214
1219[[nodiscard]] CCC_Tribool
1220CCC_flat_hash_map_validate(CCC_Flat_hash_map const *map);
1221
1226#ifdef FLAT_HASH_MAP_USING_NAMESPACE_CCC
1227typedef CCC_Flat_hash_map Flat_hash_map;
1228typedef CCC_Flat_hash_map_entry Flat_hash_map_entry;
1229# define flat_hash_map_declare_fixed(arguments...) \
1230 CCC_flat_hash_map_declare_fixed(arguments)
1231# define flat_hash_map_fixed_capacity(arguments...) \
1232 CCC_flat_hash_map_fixed_capacity(arguments)
1233# define flat_hash_map_reserve(arguments...) \
1234 CCC_flat_hash_map_reserve(arguments)
1235# define flat_hash_map_initialize(arguments...) \
1236 CCC_flat_hash_map_initialize(arguments)
1237# define flat_hash_map_from(arguments...) CCC_flat_hash_map_from(arguments)
1238# define flat_hash_map_with_capacity(arguments...) \
1239 CCC_flat_hash_map_with_capacity(arguments)
1240# define flat_hash_map_with_compound_literal(arguments...) \
1241 CCC_flat_hash_map_with_compound_literal(arguments)
1242# define flat_hash_map_with_context_compound_literal(arguments...) \
1243 CCC_flat_hash_map_with_context_compound_literal(arguments)
1244# define flat_hash_map_with_allocator(arguments...) \
1245 CCC_flat_hash_map_with_allocator(arguments)
1246# define flat_hash_map_with_context_allocator(arguments...) \
1247 CCC_flat_hash_map_with_context_allocator(arguments)
1248# define flat_hash_map_copy(arguments...) CCC_flat_hash_map_copy(arguments)
1249# define flat_hash_map_and_modify_with(arguments...) \
1250 CCC_flat_hash_map_and_modify_with(arguments)
1251# define flat_hash_map_or_insert_with(arguments...) \
1252 CCC_flat_hash_map_or_insert_with(arguments)
1253# define flat_hash_map_insert_entry_with(arguments...) \
1254 CCC_flat_hash_map_insert_entry_with(arguments)
1255# define flat_hash_map_try_insert_with(arguments...) \
1256 CCC_flat_hash_map_try_insert_with(arguments)
1257# define flat_hash_map_insert_or_assign_with(arguments...) \
1258 CCC_flat_hash_map_insert_or_assign_with(arguments)
1259# define flat_hash_map_contains(arguments...) \
1260 CCC_flat_hash_map_contains(arguments)
1261# define flat_hash_map_get_key_value(arguments...) \
1262 CCC_flat_hash_map_get_key_value(arguments)
1263# define flat_hash_map_remove_key_value_wrap(arguments...) \
1264 CCC_flat_hash_map_remove_key_value_wrap(arguments)
1265# define flat_hash_map_swap_entry_wrap(arguments...) \
1266 CCC_flat_hash_map_swap_entry_wrap(arguments)
1267# define flat_hash_map_try_insert_wrap(arguments...) \
1268 CCC_flat_hash_map_try_insert_wrap(arguments)
1269# define flat_hash_map_insert_or_assign_wrap(arguments...) \
1270 CCC_flat_hash_map_insert_or_assign_wrap(arguments)
1271# define flat_hash_map_remove_entry_wrap(arguments...) \
1272 CCC_flat_hash_map_remove_entry_wrap(arguments)
1273# define flat_hash_map_remove_key_value(arguments...) \
1274 CCC_flat_hash_map_remove_key_value(arguments)
1275# define flat_hash_map_swap_entry(arguments...) \
1276 CCC_flat_hash_map_swap_entry(arguments)
1277# define flat_hash_map_try_insert(arguments...) \
1278 CCC_flat_hash_map_try_insert(arguments)
1279# define flat_hash_map_insert_or_assign(arguments...) \
1280 CCC_flat_hash_map_insert_or_assign(arguments)
1281# define flat_hash_map_remove_entry(arguments...) \
1282 CCC_flat_hash_map_remove_entry(arguments)
1283# define flat_hash_map_entry_wrap(arguments...) \
1284 CCC_flat_hash_map_entry_wrap(arguments)
1285# define flat_hash_map_entry(arguments...) CCC_flat_hash_map_entry(arguments)
1286# define flat_hash_map_and_modify(arguments...) \
1287 CCC_flat_hash_map_and_modify(arguments)
1288# define flat_hash_map_and_modify_context(arguments...) \
1289 CCC_flat_hash_map_and_modify_context(arguments)
1290# define flat_hash_map_or_insert(arguments...) \
1291 CCC_flat_hash_map_or_insert(arguments)
1292# define flat_hash_map_insert_entry(arguments...) \
1293 CCC_flat_hash_map_insert_entry(arguments)
1294# define flat_hash_map_unwrap(arguments...) \
1295 CCC_flat_hash_map_unwrap(arguments)
1296# define flat_hash_map_occupied(arguments...) \
1297 CCC_flat_hash_map_occupied(arguments)
1298# define flat_hash_map_insert_error(arguments...) \
1299 CCC_flat_hash_map_insert_error(arguments)
1300# define flat_hash_map_begin(arguments...) CCC_flat_hash_map_begin(arguments)
1301# define flat_hash_map_next(arguments...) CCC_flat_hash_map_next(arguments)
1302# define flat_hash_map_end(arguments...) CCC_flat_hash_map_end(arguments)
1303# define flat_hash_map_is_empty(arguments...) \
1304 CCC_flat_hash_map_is_empty(arguments)
1305# define flat_hash_map_count(arguments...) CCC_flat_hash_map_count(arguments)
1306# define flat_hash_map_clear(arguments...) CCC_flat_hash_map_clear(arguments)
1307# define flat_hash_map_clear_and_free(arguments...) \
1308 CCC_flat_hash_map_clear_and_free(arguments)
1309# define flat_hash_map_clear_and_free_reserve(arguments...) \
1310 CCC_flat_hash_map_clear_and_free_reserve(arguments)
1311# define flat_hash_map_capacity(arguments...) \
1312 CCC_flat_hash_map_capacity(arguments)
1313# define flat_hash_map_validate(arguments...) \
1314 CCC_flat_hash_map_validate(arguments)
1315#endif
1316
1317#endif /* CCC_FLAT_HASH_MAP_H */
CCC_flat_hash_map_remove_entry
CCC_Entry CCC_flat_hash_map_remove_entry(CCC_Flat_hash_map_entry const *entry)
Remove the entry from the table if Occupied.
CCC_flat_hash_map_get_key_value
void * CCC_flat_hash_map_get_key_value(CCC_Flat_hash_map const *map, void const *key)
Returns a reference into the table at entry key.
CCC_flat_hash_map_insert_or_assign
CCC_Entry CCC_flat_hash_map_insert_or_assign(CCC_Flat_hash_map *map, void const *type)
Invariantly inserts or overwrites a user struct into the table.
CCC_flat_hash_map_entry_status
CCC_Entry_status CCC_flat_hash_map_entry_status(CCC_Flat_hash_map_entry const *entry)
Obtain the entry status from a container entry.
CCC_flat_hash_map_begin
void * CCC_flat_hash_map_begin(CCC_Flat_hash_map const *map)
Obtains a pointer to the first element in the table.
CCC_flat_hash_map_remove_key_value
CCC_Entry CCC_flat_hash_map_remove_key_value(CCC_Flat_hash_map *map, void *type_output)
Removes the key value in the map storing the old value, if present, in the struct containing out_hand...
CCC_flat_hash_map_end
void * CCC_flat_hash_map_end(CCC_Flat_hash_map const *map)
Check the current iterator against the end for loop termination.
CCC_flat_hash_map_next
void * CCC_flat_hash_map_next(CCC_Flat_hash_map const *map, void const *type_iterator)
Advances the iterator to the next occupied table slot.
CCC_flat_hash_map_or_insert
void * CCC_flat_hash_map_or_insert(CCC_Flat_hash_map_entry const *entry, void const *type)
Inserts the struct with handle elem if the entry is Vacant.
CCC_flat_hash_map_is_empty
CCC_Tribool CCC_flat_hash_map_is_empty(CCC_Flat_hash_map const *map)
Returns the size status of the table.
CCC_flat_hash_map_swap_entry
CCC_Entry CCC_flat_hash_map_swap_entry(CCC_Flat_hash_map *map, void *type_output)
Invariantly inserts the key value wrapping out_handle.
CCC_flat_hash_map_clear_and_free
CCC_Result CCC_flat_hash_map_clear_and_free(CCC_Flat_hash_map *map, CCC_Type_destructor *destroy)
Frees all slots in the table and frees the underlying buffer.
CCC_flat_hash_map_validate
CCC_Tribool CCC_flat_hash_map_validate(CCC_Flat_hash_map const *map)
Validation of invariants for the hash table.
CCC_flat_hash_map_and_modify
CCC_Flat_hash_map_entry * CCC_flat_hash_map_and_modify(CCC_Flat_hash_map_entry *entry, CCC_Type_modifier *modify)
Modifies the provided entry if it is Occupied.
CCC_flat_hash_map_contains
CCC_Tribool CCC_flat_hash_map_contains(CCC_Flat_hash_map const *map, void const *key)
Searches the table for the presence of key.
CCC_flat_hash_map_insert_entry
void * CCC_flat_hash_map_insert_entry(CCC_Flat_hash_map_entry const *entry, void const *type)
Inserts the provided entry invariantly.
CCC_flat_hash_map_unwrap
void * CCC_flat_hash_map_unwrap(CCC_Flat_hash_map_entry const *entry)
Unwraps the provided entry to obtain a view into the table element.
CCC_flat_hash_map_and_modify_context
CCC_Flat_hash_map_entry * CCC_flat_hash_map_and_modify_context(CCC_Flat_hash_map_entry *entry, CCC_Type_modifier *modify, void *context)
Modifies the provided entry if it is Occupied.
CCC_flat_hash_map_clear_and_free_reserve
CCC_Result CCC_flat_hash_map_clear_and_free_reserve(CCC_Flat_hash_map *map, CCC_Type_destructor *destroy, CCC_Allocator *allocate)
Frees all slots in the table and frees the underlying Buffer that was previously dynamically reserved...
CCC_flat_hash_map_reserve
CCC_Result CCC_flat_hash_map_reserve(CCC_Flat_hash_map *map, size_t to_add, CCC_Allocator *allocate)
Reserve space required to add a specified number of elements to the map. If the current capacity is s...
CCC_flat_hash_map_entry
CCC_Flat_hash_map_entry CCC_flat_hash_map_entry(CCC_Flat_hash_map *map, void const *key)
Obtains an entry for the provided key in the table for future use.
CCC_flat_hash_map_copy
CCC_Result CCC_flat_hash_map_copy(CCC_Flat_hash_map *destination, CCC_Flat_hash_map const *source, CCC_Allocator *allocate)
Copy the map at source to destination.
CCC_flat_hash_map_occupied
CCC_Tribool CCC_flat_hash_map_occupied(CCC_Flat_hash_map_entry const *entry)
Returns the Vacant or Occupied status of the entry.
CCC_flat_hash_map_capacity
CCC_Count CCC_flat_hash_map_capacity(CCC_Flat_hash_map const *map)
Return the full capacity of the backing storage.
CCC_flat_hash_map_count
CCC_Count CCC_flat_hash_map_count(CCC_Flat_hash_map const *map)
Returns the count of table occupied slots.
CCC_flat_hash_map_clear
CCC_Result CCC_flat_hash_map_clear(CCC_Flat_hash_map *map, CCC_Type_destructor *destroy)
Frees all slots in the table for use without affecting capacity.
CCC_flat_hash_map_insert_error
CCC_Tribool CCC_flat_hash_map_insert_error(CCC_Flat_hash_map_entry const *entry)
Provides the status of the entry should an insertion follow.
CCC_flat_hash_map_try_insert
CCC_Entry CCC_flat_hash_map_try_insert(CCC_Flat_hash_map *map, void const *type)
Attempts to insert the key value wrapping key_val_handle.
private_flat_hash_map.h
Private Flat Hash Map Interface.
CCC_Count
A type for returning an unsigned integer from a container for counting. Intended to count sizes,...
Definition: types.h:202
CCC_Entry
Definition: private_types.h:53
CCC_Flat_hash_map_entry
Definition: private_flat_hash_map.h:172
CCC_Flat_hash_map
Definition: private_flat_hash_map.h:144
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: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_Flat_hash_map_entry_wrap
Definition: private_flat_hash_map.h:190