hash_map_cxx.h File Reference

C++ Hashmap. More...

#include <stddef.h>
#include <zephyr/sys/hash_function.h>
#include <zephyr/sys/hash_map_api.h>

Go to the source code of this file.

Macros
#define	SYS_HASHMAP_CXX_DEFINE_ADVANCED(_name, _hash_func, _alloc_func, ...)
	Declare a C++ Hashmap (advanced)
#define	SYS_HASHMAP_CXX_DEFINE_STATIC_ADVANCED(_name, _hash_func, _alloc_func, ...)
	Declare a C++ Hashmap (advanced)
#define	SYS_HASHMAP_CXX_DEFINE_STATIC(_name)
	Declare a C++ Hashmap statically.
#define	SYS_HASHMAP_CXX_DEFINE(_name)
	Declare a C++ Hashmap.

Variables
const struct sys_hashmap_api	sys_hashmap_cxx_api

Detailed Description

C++ Hashmap.

This is a C wrapper around std::unordered_map. It is mainly used for benchmarking purposes.

Note

Enable with CONFIG_SYS_HASH_MAP_CXX

Macro Definition Documentation

SYS_HASHMAP_CXX_DEFINE

#define SYS_HASHMAP_CXX_DEFINE

(

_name

)

Value:

        SYS_HASHMAP_CXX_DEFINE_ADVANCED(                                                           \
                _name, sys_hash32, SYS_HASHMAP_DEFAULT_ALLOCATOR,                                  \
                SYS_HASHMAP_CONFIG(SIZE_MAX, SYS_HASHMAP_DEFAULT_LOAD_FACTOR))

Declare a C++ Hashmap.

Declare a C++ Hashmap with default parameters.

Parameters

_name

Name of the Hashmap.

SYS_HASHMAP_CXX_DEFINE_ADVANCED

#define SYS_HASHMAP_CXX_DEFINE_ADVANCED	(		_name,
			_hash_func,
			_alloc_func,
			... )

Value:

        SYS_HASHMAP_DEFINE_ADVANCED(_name, &sys_hashmap_cxx_api, sys_hashmap_config,               \
                                    sys_hashmap_data, _hash_func, _alloc_func, __VA_ARGS__)

Declare a C++ Hashmap (advanced)

Declare a C++ Hashmap with control over advanced parameters.

Note

The allocator _alloc is used for allocating internal Hashmap entries and does not interact with any user-provided keys or values.

Parameters

_name	Name of the Hashmap.
_hash_func	Hash function pointer of type sys_hash_func32_t.
_alloc_func	Allocator function pointer of type sys_hashmap_allocator_t.
...	Variant-specific details for sys_hashmap_config.

SYS_HASHMAP_CXX_DEFINE_STATIC

#define SYS_HASHMAP_CXX_DEFINE_STATIC

(

_name

)

Value:

        SYS_HASHMAP_CXX_DEFINE_STATIC_ADVANCED(                                                    \
                _name, sys_hash32, SYS_HASHMAP_DEFAULT_ALLOCATOR,                                  \
                SYS_HASHMAP_CONFIG(SIZE_MAX, SYS_HASHMAP_DEFAULT_LOAD_FACTOR))

Declare a C++ Hashmap statically.

Declare a C++ Hashmap statically with default parameters.

Parameters

_name

Name of the Hashmap.

SYS_HASHMAP_CXX_DEFINE_STATIC_ADVANCED

#define SYS_HASHMAP_CXX_DEFINE_STATIC_ADVANCED	(		_name,
			_hash_func,
			_alloc_func,
			... )

Value:

        SYS_HASHMAP_DEFINE_STATIC_ADVANCED(_name, &sys_hashmap_cxx_api, sys_hashmap_config,        \
                                           sys_hashmap_data, _hash_func, _alloc_func, __VA_ARGS__)

Declare a C++ Hashmap (advanced)

Declare a C++ Hashmap with control over advanced parameters.

Note

The allocator _alloc is used for allocating internal Hashmap entries and does not interact with any user-provided keys or values.

Parameters

_name	Name of the Hashmap.
_hash_func	Hash function pointer of type sys_hash_func32_t.
_alloc_func	Allocator function pointer of type sys_hashmap_allocator_t.
...	Details for sys_hashmap_config.

Variable Documentation

sys_hashmap_cxx_api

const struct sys_hashmap_api sys_hashmap_cxx_api

extern