Collaboration diagram for Unordered map:

Data Structures
struct	map_t
	an unordered hash map More...

struct	map_entry_t
	a key-value pair in a map More...

struct	map_iter_t
	a map iterator handle More...

Macros
#define	CTU_MAP_NEXT(iter, key, value) map_next_pair(iter, (const void )(key), (void )(value))
	get the next key-value pair from a map iterator More...

Functions
CT_STD_API void	map_init (OUT_NOTNULL map_t map, size_t size, hash_info_t info, arena_t arena)
	initialize a map More...

CT_NODISCARD CT_STD_API map_t	map_make (size_t size, hash_info_t info, arena_t *arena)
	create a new map on the stack More...

CT_NODISCARD CT_STD_API map_t *	map_new (size_t size, hash_info_t info, arena_t *arena)
	create a new map on the heap More...

CT_NODISCARD CT_STD_API map_t *	map_optimal (size_t size, hash_info_t info, arena_t *arena)
	create a new map with an optimal size More...

CT_STD_API void	map_set (map_t map, const void key, void *value)
	set a key-value pair in a map More...

CT_NODISCARD CT_PUREFN CT_STD_API void *	map_get (const map_t map, const void key)
	get a value from a map More...

CT_NODISCARD CT_PUREFN CT_STD_API void *	map_get_default (const map_t map, const void key, void *other)
	get a value from a map or a default value More...

CT_NODISCARD CT_PUREFN CT_STD_API bool	map_contains (const map_t map, const void key)
	check if a map contains a key More...

CT_STD_API bool	map_delete (map_t map, const void key)
	delete a key-value pair from a map More...

CT_NODISCARD CT_STD_API vector_t *	map_values (map_t *map)
	collect all the values from a map into a vector More...

CT_NODISCARD CT_STD_API typevec_t *	map_entries (map_t *map)
	collect all key-value pairs in a map into a vector returns a typevec_t<map_entry_t> More...

CT_NODISCARD CT_PUREFN CT_STD_API size_t	map_count (const map_t *map)
	get the number of key-value pairs in a map More...

CT_STD_API void	map_reset (map_t *map)
	clear all key-value pairs from a map More...

CT_NODISCARD CT_PUREFN CT_STD_API map_iter_t	map_iter (const map_t *map)
	create a new map iterator More...

CT_NODISCARD CT_NOALIAS CT_STD_API map_entry_t	map_next (map_iter_t *iter)
	get the next key-value pair from a map iterator More...

CT_NODISCARD CT_PUREFN CT_STD_API bool	map_has_next (const map_iter_t *iter)
	check if a map iterator has more elements More...

CT_NODISCARD CT_STD_API bool	map_next_pair (map_iter_t iter, const void key, void *value)
	get the next key-value pair from a map iterator returns the values via out parameters for ease of use this also returns false if the iterator has no more elements this is intended to be used via CTU_MAP_NEXT for more idiomatic usage More...

Variables
CT_STD_API const map_t	kEmptyMap
	an empty map More...

Detailed Description

Hash map.

the map makes some assumptions about keys and values

identical pointers are equal
copying only the pointer is sufficient for copying the value
NULL is the empty value
key lifetimes are externally managed and valid for the lifetime of the map

the map interface provides a map_new and a map_optimal function for performance reasons. its recommended to use map_optimal if you have an estimate of the number of elements in the map.

Macro Definition Documentation

◆ CTU_MAP_NEXT

#define CTU_MAP_NEXT	(	iter,
		key,
		value
	)	map_next_pair(iter, (const void )(key), (void )(value))

get the next key-value pair from a map iterator

intended to be used as such:

map_iter_t iter = map_iter(map);
const char *key = NULL;
void *value = NULL;
while (CTU_MAP_NEXT(&iter, &key, &value))
{
    // do something with key and value
}

Parameters

iter	the iterator to get the next key-value pair from
key	the key of the next key-value pair
value	the value of the next key-value pair

Return values

true	the iterator has more elements

Definition at line 250 of file map.h.

Function Documentation

◆ map_contains()

CT_NODISCARD CT_PUREFN CT_STD_API bool map_contains	(	const map_t *	map,
		const void *	key
	)

check if a map contains a key

Parameters

map	the map to check
key	the key to check for

Return values

true	the map contains `key`

Definition at line 351 of file map.c.

◆ map_count()

CT_NODISCARD CT_PUREFN CT_STD_API size_t map_count ( const map_t * map )

get the number of key-value pairs in a map

Parameters

map	the map to get the size of

Returns: the number of key-value pairs in the map

Definition at line 176 of file map.c.

◆ map_delete()

CT_STD_API bool map_delete	(	map_t *	map,
		const void *	key
	)

delete a key-value pair from a map

Note: this does no memory management, it only removes the key-value pair from the map

Parameters

map	the map to delete the key-value pair from
key	the key to delete

Return values

true	the key-value pair was deleted

Definition at line 361 of file map.c.

◆ map_entries()

CT_NODISCARD CT_STD_API typevec_t* map_entries ( map_t * map )

collect all key-value pairs in a map into a vector returns a typevec_t<map_entry_t>

Parameters

map	the map to collect the key-value pairs from

Returns: a vector containing all the key-value pairs

Definition at line 161 of file map.c.

◆ map_get()

CT_NODISCARD CT_PUREFN CT_STD_API void* map_get	(	const map_t *	map,
		const void *	key
	)

get a value from a map

Parameters

map	the map to get the value from
key	the key to get the value for

Returns: the value for key or NULL if the key is not found

Definition at line 324 of file map.c.

◆ map_get_default()

CT_NODISCARD CT_PUREFN CT_STD_API void* map_get_default	(	const map_t *	map,
		const void *	key,
		void *	other
	)

get a value from a map or a default value

Parameters

map	the map to get the value from
key	the key to get the value for
other	the default value to return if the key is not found

Returns: the value named by key or other if the key is not found

Definition at line 333 of file map.c.

◆ map_has_next()

CT_NODISCARD CT_PUREFN CT_STD_API bool map_has_next ( const map_iter_t * iter )

check if a map iterator has more elements

Parameters

iter	the iterator to check

Return values

true	the iterator has more elements

Definition at line 509 of file map.c.

◆ map_init()

CT_STD_API void map_init	(	OUT_NOTNULL map_t *	map,
		size_t	size,
		hash_info_t	info,
		arena_t *	arena
	)

initialize a map

Parameters

map	the map to initialize
size	the initial size of the map
info	the type info for the key type
arena	the arena to allocate from

◆ map_iter()

CT_NODISCARD CT_PUREFN CT_STD_API map_iter_t map_iter ( const map_t * map )

create a new map iterator

Warning: iterators are invalidated by any operation that modifies the map.

Note: iteration order is unspecified.

Parameters

map	the map to iterate over

Returns: the new iterator

Definition at line 456 of file map.c.

◆ map_make()

CT_NODISCARD CT_STD_API map_t map_make	(	size_t	size,
		hash_info_t	info,
		arena_t *	arena
	)

create a new map on the stack

Parameters

size	the initial size of the map
info	the type info for the key type
arena	the arena to allocate from

Returns: the new map

Definition at line 105 of file map.c.

◆ map_new()

CT_NODISCARD CT_STD_API map_t* map_new	(	size_t	size,
		hash_info_t	info,
		arena_t *	arena
	)

create a new map on the heap

Parameters

size	the initial size of the map
info	the type info for the key type
arena	the arena to allocate from

Returns: the new map

Definition at line 113 of file map.c.

◆ map_next()

CT_NODISCARD CT_NOALIAS CT_STD_API map_entry_t map_next ( map_iter_t * iter )

get the next key-value pair from a map iterator

Warning: this functions behaviour is undefined if called on an iterator that has no more elements

Parameters

iter	the iterator to get the next key-value pair from

Returns: the next key-value pair

Definition at line 476 of file map.c.

◆ map_next_pair()

CT_NODISCARD CT_STD_API bool map_next_pair	(	map_iter_t *	iter,
		const void **	key,
		void **	value
	)

get the next key-value pair from a map iterator returns the values via out parameters for ease of use this also returns false if the iterator has no more elements this is intended to be used via CTU_MAP_NEXT for more idiomatic usage

Parameters

iter	the iterator to get the next key-value pair from
key	the key of the next key-value pair
value	the value of the next key-value pair

Return values

true	the iterator has more elements

Definition at line 492 of file map.c.

◆ map_optimal()

CT_NODISCARD CT_STD_API map_t* map_optimal	(	size_t	size,
		hash_info_t	info,
		arena_t *	arena
	)

create a new map with an optimal size

Parameters

size	the estimated number of elements
info	the type info for the key type
arena	the arena to allocate from

Returns: the new map

Definition at line 85 of file optimal.c.

◆ map_reset()

CT_STD_API void map_reset ( map_t * map )

clear all key-value pairs from a map

Note: this does no memory management, it only removes all key-value pairs from the map does not free the map itself or shrink its internal storage

Parameters

map	the map to clear

Definition at line 386 of file map.c.

◆ map_set()

CT_STD_API void map_set	(	map_t *	map,
		const void *	key,
		void *	value
	)

set a key-value pair in a map

Precondition: key is not NULL

Parameters

map	the map to set the key-value pair in
key	the key to set
value	the value to set

Definition at line 294 of file map.c.

◆ map_values()

CT_NODISCARD CT_STD_API vector_t* map_values ( map_t * map )

collect all the values from a map into a vector

Parameters

map	the map to collect the values from

Returns: a vector containing all the values

Definition at line 137 of file map.c.

Variable Documentation

◆ kEmptyMap

CT_STD_API const map_t kEmptyMap

extern

an empty map

Definition at line 34 of file map.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CTU_MAP_NEXT

Function Documentation

◆ map_contains()

◆ map_count()

◆ map_delete()

◆ map_entries()

◆ map_get()

◆ map_get_default()

◆ map_has_next()

◆ map_init()

◆ map_iter()

◆ map_make()

◆ map_new()

◆ map_next()

◆ map_next_pair()

◆ map_optimal()

◆ map_reset()

◆ map_set()

◆ map_values()

Variable Documentation

◆ kEmptyMap