Associative container for key-value pairs with unique keys. More...

#include <dense_map.hpp>

Public Types
using	allocator_type = Allocator
	Allocator type.
using	key_type = Key
	Key type of the container.
using	mapped_type = Type
	Mapped type of the container.
using	value_type = stl::pair<const Key, Type>
	Key-value type of the container.
using	size_type = stl::size_t
	Unsigned integer type.
using	difference_type = stl::ptrdiff_t
	Signed integer type.
using	hasher = Hash
	Type of function to use to hash the keys.
using	key_equal = KeyEqual
	Type of function to use to compare the keys for equality.
using	iterator = internal::dense_map_iterator<typename packed_container_type::pointer>
	Input iterator type.
using	const_iterator = internal::dense_map_iterator<typename packed_container_type::const_pointer>
	Constant input iterator type.
using	local_iterator = internal::dense_map_local_iterator<typename packed_container_type::pointer>
	Input iterator type.
using	const_local_iterator = internal::dense_map_local_iterator<typename packed_container_type::const_pointer>
	Constant input iterator type.

Public Member Functions
	dense_map ()
	Default constructor.
	dense_map (const allocator_type &allocator)
	Constructs an empty container with a given allocator.
	dense_map (const size_type cnt, const allocator_type &allocator)
	Constructs an empty container with a given allocator and user supplied minimal number of buckets.
	dense_map (const size_type cnt, const hasher &hash, const allocator_type &allocator)
	Constructs an empty container with a given allocator, hash function and user supplied minimal number of buckets.
	dense_map (const size_type cnt, const hasher &hash=hasher{}, const key_equal &equal=key_equal{}, const allocator_type &allocator=allocator_type{})
	Constructs an empty container with a given allocator, hash function, compare function and user supplied minimal number of buckets.
	dense_map (const dense_map &)=default
	Default copy constructor.
	dense_map (const dense_map &other, const allocator_type &allocator)
	Allocator-extended copy constructor.
	dense_map (dense_map &&) noexcept=default
	Default move constructor.
	dense_map (dense_map &&other, const allocator_type &allocator)
	Allocator-extended move constructor.
	~dense_map ()=default
	Default destructor.
dense_map &	operator= (const dense_map &)=default
	Default copy assignment operator.
dense_map &	operator= (dense_map &&) noexcept=default
	Default move assignment operator.
void	swap (dense_map &other) noexcept
	Exchanges the contents with those of a given container.
constexpr allocator_type	get_allocator () const noexcept
	Returns the associated allocator.
const_iterator	cbegin () const noexcept
	Returns an iterator to the beginning.
const_iterator	begin () const noexcept
	Returns an iterator to the beginning.
iterator	begin () noexcept
	Returns an iterator to the beginning.
const_iterator	cend () const noexcept
	Returns an iterator to the end.
const_iterator	end () const noexcept
	Returns an iterator to the end.
iterator	end () noexcept
	Returns an iterator to the end.
bool	empty () const noexcept
	Checks whether a container is empty.
size_type	size () const noexcept
	Returns the number of elements in a container.
size_type	max_size () const noexcept
	Returns the maximum possible number of elements.
void	clear () noexcept
	Clears the container.
stl::pair< iterator, bool >	insert (const value_type &value)
	Inserts an element into the container, if the key does not exist.
stl::pair< iterator, bool >	insert (value_type &&value)
	Inserts an element into the container, if the key does not exist.
template<typename Arg> requires stl::constructible_from<value_type, Arg &&>
stl::pair< iterator, bool >	insert (Arg &&value)
	Inserts an element into the container, if the key does not exist.
void	insert (stl::input_iterator auto first, stl::input_iterator auto last)
	Inserts elements into the container, if their keys do not exist.
template<typename Arg>
stl::pair< iterator, bool >	insert_or_assign (const key_type &key, Arg &&value)
	Inserts an element into the container or assigns to the current element if the key already exists.
template<typename Arg>
stl::pair< iterator, bool >	insert_or_assign (key_type &&key, Arg &&value)
	Inserts an element into the container or assigns to the current element if the key already exists.
template<typename... Args>
stl::pair< iterator, bool >	emplace (Args &&...args)
	Constructs an element in-place, if the key does not exist.
template<typename... Args>
stl::pair< iterator, bool >	try_emplace (const key_type &key, Args &&...args)
	Inserts in-place if the key does not exist, does nothing if the key exists.
template<typename... Args>
stl::pair< iterator, bool >	try_emplace (key_type &&key, Args &&...args)
	Inserts in-place if the key does not exist, does nothing if the key exists.
iterator	erase (const_iterator pos)
	Removes an element from a given position.
iterator	erase (const_iterator first, const_iterator last)
	Removes the given elements from a container.
size_type	erase (const key_type &key)
	Removes the element associated with a given key.
mapped_type &	at (const key_type &key)
	Accesses a given element with bounds checking.
const mapped_type &	at (const key_type &key) const
	Accesses a given element with bounds checking.
mapped_type const &	at (const auto &key) const
	Accesses a given element with bounds checking.
mapped_type &	at (const auto &key)
	Accesses a given element with bounds checking.
mapped_type &	operator[] (const key_type &key)
	Accesses or inserts a given element.
mapped_type &	operator[] (key_type &&key)
	Accesses or inserts a given element.
size_type	count (const key_type &key) const
	Returns the number of elements matching a key (either 1 or 0).
size_type	count (const auto &key) const
	Returns the number of elements matching a key (either 1 or 0).
iterator	find (const key_type &key)
	Finds an element with a given key.
const_iterator	find (const key_type &key) const
	Finds an element with a given key.
iterator	find (const auto &key)
	Finds an element with a key that compares equivalent to a given key.
const_iterator	find (const auto &key) const
	Finds an element with a given key.
stl::pair< iterator, iterator >	equal_range (const key_type &key)
	Returns a range containing all elements with a given key.
stl::pair< const_iterator, const_iterator >	equal_range (const key_type &key) const
	Returns a range containing all elements with a given key.
stl::pair< iterator, iterator >	equal_range (const auto &key)
	Returns a range containing all elements that compare equivalent to a given key.
stl::pair< const_iterator, const_iterator >	equal_range (const auto &key) const
	Returns a range containing all elements with a given key.
bool	contains (const key_type &key) const
	Checks if the container contains an element with a given key.
bool	contains (const auto &key) const
	Checks if the container contains an element with a key that compares equivalent to a given value.
const_local_iterator	cbegin (const size_type index) const
	Returns an iterator to the beginning of a given bucket.
const_local_iterator	begin (const size_type index) const
	Returns an iterator to the beginning of a given bucket.
local_iterator	begin (const size_type index)
	Returns an iterator to the beginning of a given bucket.
const_local_iterator	cend (const size_type index) const
	Returns an iterator to the end of a given bucket.
const_local_iterator	end (const size_type index) const
	Returns an iterator to the end of a given bucket.
local_iterator	end (const size_type index)
	Returns an iterator to the end of a given bucket.
size_type	bucket_count () const
	Returns the number of buckets.
size_type	max_bucket_count () const
	Returns the maximum number of buckets.
size_type	bucket_size (const size_type index) const
	Returns the number of elements in a given bucket.
size_type	bucket (const key_type &key) const
	Returns the bucket for a given key.
float	load_factor () const
	Returns the average number of elements per bucket.
float	max_load_factor () const
	Returns the maximum average number of elements per bucket.
void	max_load_factor (const float value)
	Sets the desired maximum average number of elements per bucket.
void	rehash (const size_type cnt)
	Reserves at least the specified number of buckets and regenerates the hash table.
void	reserve (const size_type cnt)
	Reserves space for at least the specified number of elements and regenerates the hash table.
hasher	hash_function () const
	Returns the function used to hash the keys.
key_equal	key_eq () const
	Returns the function used to compare keys for equality.

Detailed Description

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>
class entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >

Associative container for key-value pairs with unique keys.

Internally, elements are organized into buckets. Which bucket an element is placed into depends entirely on the hash of its key. Keys with the same hash code appear in the same bucket.

Template Parameters

Key	Key type of the associative container.
Type	Mapped type of the associative container.
Hash	Type of function to use to hash the keys.
KeyEqual	Type of function to use to compare the keys for equality.
Allocator	Type of allocator used to manage memory and elements.

Definition at line 231 of file dense_map.hpp.

Member Typedef Documentation

◆ allocator_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::allocator_type = Allocator

Allocator type.

Definition at line 317 of file dense_map.hpp.

◆ const_iterator

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::const_iterator = internal::dense_map_iterator<typename packed_container_type::const_pointer>

Constant input iterator type.

Definition at line 335 of file dense_map.hpp.

◆ const_local_iterator

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::const_local_iterator = internal::dense_map_local_iterator<typename packed_container_type::const_pointer>

Constant input iterator type.

Definition at line 339 of file dense_map.hpp.

◆ difference_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::difference_type = stl::ptrdiff_t

Signed integer type.

Definition at line 327 of file dense_map.hpp.

◆ hasher

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::hasher = Hash

Type of function to use to hash the keys.

Definition at line 329 of file dense_map.hpp.

◆ iterator

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::iterator = internal::dense_map_iterator<typename packed_container_type::pointer>

Input iterator type.

Definition at line 333 of file dense_map.hpp.

◆ key_equal

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::key_equal = KeyEqual

Type of function to use to compare the keys for equality.

Definition at line 331 of file dense_map.hpp.

◆ key_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::key_type = Key

Key type of the container.

Definition at line 319 of file dense_map.hpp.

◆ local_iterator

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::local_iterator = internal::dense_map_local_iterator<typename packed_container_type::pointer>

Input iterator type.

Definition at line 337 of file dense_map.hpp.

◆ mapped_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::mapped_type = Type

Mapped type of the container.

Definition at line 321 of file dense_map.hpp.

◆ size_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::size_type = stl::size_t

Unsigned integer type.

Definition at line 325 of file dense_map.hpp.

◆ value_type

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

using entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::value_type = stl::pair<const Key, Type>

Key-value type of the container.

Definition at line 323 of file dense_map.hpp.

Constructor & Destructor Documentation

◆ dense_map() [1/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map ( )

inline

Default constructor.

Definition at line 342 of file dense_map.hpp.

◆ dense_map() [2/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map ( const allocator_type & allocator )

inlineexplicit

Constructs an empty container with a given allocator.

Parameters

allocator The allocator to use.

Definition at line 349 of file dense_map.hpp.

◆ dense_map() [3/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map	(	const size_type	cnt,
		const allocator_type &	allocator )

inline

Constructs an empty container with a given allocator and user supplied minimal number of buckets.

Parameters

cnt	Minimal number of buckets.
allocator	The allocator to use.

Definition at line 358 of file dense_map.hpp.

◆ dense_map() [4/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map	(	const size_type	cnt,
		const hasher &	hash,
		const allocator_type &	allocator )

inline

Constructs an empty container with a given allocator, hash function and user supplied minimal number of buckets.

Parameters

cnt	Minimal number of buckets.
hash	Hash function to use.
allocator	The allocator to use.

Definition at line 368 of file dense_map.hpp.

◆ dense_map() [5/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map	(	const size_type	cnt,
		const hasher &	hash = hasher{},
		const key_equal &	equal = key_equal{},
		const allocator_type &	allocator = allocator_type{} )

inlineexplicit

Constructs an empty container with a given allocator, hash function, compare function and user supplied minimal number of buckets.

Parameters

cnt	Minimal number of buckets.
hash	Hash function to use.
equal	Compare function to use.
allocator	The allocator to use.

Definition at line 379 of file dense_map.hpp.

◆ dense_map() [6/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map	(	const dense_map< Key, Type, Hash, KeyEqual, Allocator > &	other,
		const allocator_type &	allocator )

inline

Allocator-extended copy constructor.

Parameters

other	The instance to copy from.
allocator	The allocator to use.

Definition at line 393 of file dense_map.hpp.

◆ dense_map() [7/7]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::dense_map	(	dense_map< Key, Type, Hash, KeyEqual, Allocator > &&	other,
		const allocator_type &	allocator )

inline

Allocator-extended move constructor.

Parameters

other	The instance to move from.
allocator	The allocator to use.

Definition at line 406 of file dense_map.hpp.

Member Function Documentation

◆ at() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

mapped_type & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::at ( const auto & key )

inlinenodiscard

Accesses a given element with bounds checking.

Parameters

key	A key of an element to find.

Returns: A reference to the mapped value of the requested element.

Definition at line 708 of file dense_map.hpp.

◆ at() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

mapped_type const & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::at ( const auto & key ) const

inlinenodiscard

Accesses a given element with bounds checking.

Parameters

key	A key of an element to find.

Returns: A reference to the mapped value of the requested element.

Definition at line 700 of file dense_map.hpp.

◆ at() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

mapped_type & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::at ( const key_type & key )

inlinenodiscard

Accesses a given element with bounds checking.

Parameters

key	A key of an element to find.

Returns: A reference to the mapped value of the requested element.

Definition at line 682 of file dense_map.hpp.

◆ at() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const mapped_type & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::at ( const key_type & key ) const

inlinenodiscard

Accesses a given element with bounds checking.

Parameters

key	A key of an element to find.

Returns: A reference to the mapped value of the requested element.

Definition at line 689 of file dense_map.hpp.

◆ begin() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::begin ( ) const

inlinenodiscardnoexcept

Returns an iterator to the beginning.

If the array is empty, the returned iterator will be equal to end().

Returns: An iterator to the first instance of the internal array.

Definition at line 457 of file dense_map.hpp.

◆ begin() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::begin ( )

inlinenodiscardnoexcept

Returns an iterator to the beginning.

If the array is empty, the returned iterator will be equal to end().

Returns: An iterator to the first instance of the internal array.

Definition at line 462 of file dense_map.hpp.

◆ begin() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::begin ( const size_type index )

inlinenodiscard

Returns an iterator to the beginning of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the beginning of the given bucket.

Definition at line 865 of file dense_map.hpp.

◆ begin() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::begin ( const size_type index ) const

inlinenodiscard

Returns an iterator to the beginning of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the beginning of the given bucket.

Definition at line 856 of file dense_map.hpp.

◆ bucket()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::bucket ( const key_type & key ) const

inlinenodiscard

Returns the bucket for a given key.

Parameters

key	The value of the key to examine.

Returns: The bucket for the given key.

Definition at line 926 of file dense_map.hpp.

◆ bucket_count()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::bucket_count ( ) const

inlinenodiscard

Returns the number of buckets.

Returns: The number of buckets.

Definition at line 900 of file dense_map.hpp.

◆ bucket_size()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::bucket_size ( const size_type index ) const

inlinenodiscard

Returns the number of elements in a given bucket.

Parameters

index The index of the bucket to examine.

Returns: The number of elements in the given bucket.

Definition at line 917 of file dense_map.hpp.

◆ cbegin() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::cbegin ( ) const

inlinenodiscardnoexcept

Returns an iterator to the beginning.

If the array is empty, the returned iterator will be equal to end().

Returns: An iterator to the first instance of the internal array.

Definition at line 452 of file dense_map.hpp.

◆ cbegin() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::cbegin ( const size_type index ) const

inlinenodiscard

Returns an iterator to the beginning of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the beginning of the given bucket.

Definition at line 847 of file dense_map.hpp.

◆ cend() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::cend ( ) const

inlinenodiscardnoexcept

Returns an iterator to the end.

Returns: An iterator to the element following the last instance of the internal array.

Definition at line 471 of file dense_map.hpp.

◆ cend() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::cend ( const size_type index ) const

inlinenodiscard

Returns an iterator to the end of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the end of the given bucket.

Definition at line 874 of file dense_map.hpp.

◆ clear()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::clear ( )

inlinenoexcept

Clears the container.

Definition at line 510 of file dense_map.hpp.

◆ contains() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

bool entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::contains ( const auto & key ) const

inlinenodiscard

Checks if the container contains an element with a key that compares equivalent to a given value.

Parameters

key	Key value of an element to search for.

Returns: True if there is such an element, false otherwise.

Definition at line 837 of file dense_map.hpp.

◆ contains() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

bool entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::contains ( const key_type & key ) const

inlinenodiscard

Checks if the container contains an element with a given key.

Parameters

key	Key value of an element to search for.

Returns: True if there is such an element, false otherwise.

Definition at line 827 of file dense_map.hpp.

◆ count() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::count ( const auto & key ) const

inlinenodiscard

Returns the number of elements matching a key (either 1 or 0).

Parameters

key	Key value of an element to search for.

Returns: Number of elements matching the key (either 1 or 0).

Definition at line 747 of file dense_map.hpp.

◆ count() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::count ( const key_type & key ) const

inlinenodiscard

Returns the number of elements matching a key (either 1 or 0).

Parameters

key	Key value of an element to search for.

Returns: Number of elements matching the key (either 1 or 0).

Definition at line 738 of file dense_map.hpp.

◆ emplace()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename... Args>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::emplace ( Args &&... args )

inline

Constructs an element in-place, if the key does not exist.

The element is also constructed when the container already has the key, in which case the newly constructed object is destroyed immediately.

Template Parameters

Args	Types of arguments to forward to the constructor of the element.

Parameters

args	Arguments to forward to the constructor of the element.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Definition at line 587 of file dense_map.hpp.

◆ empty()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

bool entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::empty ( ) const

inlinenodiscardnoexcept

Checks whether a container is empty.

Returns: True if the container is empty, false otherwise.

Definition at line 489 of file dense_map.hpp.

◆ end() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::end ( ) const

inlinenodiscardnoexcept

Returns an iterator to the end.

Returns: An iterator to the element following the last instance of the internal array.

Definition at line 476 of file dense_map.hpp.

◆ end() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::end ( )

inlinenodiscardnoexcept

Returns an iterator to the end.

Returns: An iterator to the element following the last instance of the internal array.

Definition at line 481 of file dense_map.hpp.

◆ end() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::end ( const size_type index )

inlinenodiscard

Returns an iterator to the end of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the end of the given bucket.

Definition at line 892 of file dense_map.hpp.

◆ end() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_local_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::end ( const size_type index ) const

inlinenodiscard

Returns an iterator to the end of a given bucket.

Parameters

index An index of a bucket to access.

Returns: An iterator to the end of the given bucket.

Definition at line 883 of file dense_map.hpp.

◆ equal_range() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< iterator, iterator > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::equal_range ( const auto & key )

inlinenodiscard

Returns a range containing all elements that compare equivalent to a given key.

Parameters

key	Key value of an element to search for.

Returns: A pair of iterators pointing to the first element and past the last element of the range.

Definition at line 809 of file dense_map.hpp.

◆ equal_range() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< const_iterator, const_iterator > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::equal_range ( const auto & key ) const

inlinenodiscard

Returns a range containing all elements with a given key.

Parameters

key	Key value of an element to search for.

Returns: A pair of iterators pointing to the first element and past the last element of the range.

Definition at line 816 of file dense_map.hpp.

◆ equal_range() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< iterator, iterator > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::equal_range ( const key_type & key )

inlinenodiscard

Returns a range containing all elements with a given key.

Parameters

key	Key value of an element to search for.

Returns: A pair of iterators pointing to the first element and past the last element of the range.

Definition at line 791 of file dense_map.hpp.

◆ equal_range() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< const_iterator, const_iterator > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::equal_range ( const key_type & key ) const

inlinenodiscard

Returns a range containing all elements with a given key.

Parameters

key	Key value of an element to search for.

Returns: A pair of iterators pointing to the first element and past the last element of the range.

Definition at line 797 of file dense_map.hpp.

◆ erase() [1/3]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::erase ( const key_type & key )

inline

Removes the element associated with a given key.

Parameters

key	A key value of an element to remove.

Returns: Number of elements removed (either 0 or 1).

Definition at line 664 of file dense_map.hpp.

◆ erase() [2/3]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::erase	(	const_iterator	first,
		const_iterator	last )

inline

Removes the given elements from a container.

Parameters

first	An iterator to the first element of the range of elements.
last	An iterator past the last element of the range of elements.

Returns: An iterator following the last removed element.

Definition at line 649 of file dense_map.hpp.

◆ erase() [3/3]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::erase ( const_iterator pos )

inline

Removes an element from a given position.

Parameters

pos	An iterator to the element to remove.

Returns: An iterator following the removed element.

Definition at line 637 of file dense_map.hpp.

◆ find() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::find ( const auto & key )

inlinenodiscard

Finds an element with a key that compares equivalent to a given key.

Parameters

key	Key value of an element to search for.

Returns: An iterator to an element with the given key. If no such element is found, a past-the-end iterator is returned.

Definition at line 774 of file dense_map.hpp.

◆ find() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::find ( const auto & key ) const

inlinenodiscard

Finds an element with a given key.

Parameters

key	Key value of an element to search for.

Returns: An iterator to an element with the given key. If no such element is found, a past-the-end iterator is returned.

Definition at line 780 of file dense_map.hpp.

◆ find() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::find ( const key_type & key )

inlinenodiscard

Finds an element with a given key.

Parameters

key	Key value of an element to search for.

Returns: An iterator to an element with the given key. If no such element is found, a past-the-end iterator is returned.

Definition at line 758 of file dense_map.hpp.

◆ find() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

const_iterator entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::find ( const key_type & key ) const

inlinenodiscard

Finds an element with a given key.

Parameters

key	Key value of an element to search for.

Returns: An iterator to an element with the given key. If no such element is found, a past-the-end iterator is returned.

Definition at line 763 of file dense_map.hpp.

◆ get_allocator()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

allocator_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::get_allocator ( ) const

inlinenodiscardconstexprnoexcept

Returns the associated allocator.

Returns: The associated allocator.

Definition at line 441 of file dense_map.hpp.

◆ hash_function()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

hasher entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::hash_function ( ) const

inlinenodiscard

Returns the function used to hash the keys.

Returns: The function used to hash the keys.

Definition at line 994 of file dense_map.hpp.

◆ insert() [1/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename Arg>
requires stl::constructible_from<value_type, Arg &&>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert ( Arg && value )

inline

Inserts an element into the container, if the key does not exist.

Parameters

value A key-value pair eventually convertible to the value type.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Template Parameters

Arg	Type of the key-value pair to insert into the container.

Definition at line 538 of file dense_map.hpp.

◆ insert() [2/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert ( const value_type & value )

inline

Inserts an element into the container, if the key does not exist.

Parameters

value A key-value pair eventually convertible to the value type.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Definition at line 523 of file dense_map.hpp.

◆ insert() [3/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert	(	stl::input_iterator auto	first,
		stl::input_iterator auto	last )

inline

Inserts elements into the container, if their keys do not exist.

Parameters

first	An iterator to the first element of the range of elements.
last	An iterator past the last element of the range of elements.

Definition at line 547 of file dense_map.hpp.

◆ insert() [4/4]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert ( value_type && value )

inline

Inserts an element into the container, if the key does not exist.

Parameters

value A key-value pair eventually convertible to the value type.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Definition at line 528 of file dense_map.hpp.

◆ insert_or_assign() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename Arg>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert_or_assign	(	const key_type &	key,
		Arg &&	value )

inline

Inserts an element into the container or assigns to the current element if the key already exists.

Template Parameters

Arg	Type of the value to insert or assign.

Parameters

key	A key used both to look up and to insert if not found.
value	A value to insert or assign.

Returns: A pair consisting of an iterator to the element and a bool denoting whether the insertion took place.

Definition at line 563 of file dense_map.hpp.

◆ insert_or_assign() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename Arg>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::insert_or_assign	(	key_type &&	key,
		Arg &&	value )

inline

Inserts an element into the container or assigns to the current element if the key already exists.

Template Parameters

Arg	Type of the value to insert or assign.

Parameters

key	A key used both to look up and to insert if not found.
value	A value to insert or assign.

Returns: A pair consisting of an iterator to the element and a bool denoting whether the insertion took place.

Definition at line 569 of file dense_map.hpp.

◆ key_eq()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

key_equal entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::key_eq ( ) const

inlinenodiscard

Returns the function used to compare keys for equality.

Returns: The function used to compare keys for equality.

Definition at line 1002 of file dense_map.hpp.

◆ load_factor()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

float entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::load_factor ( ) const

inlinenodiscard

Returns the average number of elements per bucket.

Returns: The average number of elements per bucket.

Definition at line 934 of file dense_map.hpp.

◆ max_bucket_count()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::max_bucket_count ( ) const

inlinenodiscard

Returns the maximum number of buckets.

Returns: The maximum number of buckets.

Definition at line 908 of file dense_map.hpp.

◆ max_load_factor() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

float entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::max_load_factor ( ) const

inlinenodiscard

Returns the maximum average number of elements per bucket.

Returns: The maximum average number of elements per bucket.

Definition at line 942 of file dense_map.hpp.

◆ max_load_factor() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::max_load_factor ( const float value )

inline

Sets the desired maximum average number of elements per bucket.

Parameters

value A desired maximum average number of elements per bucket.

Definition at line 950 of file dense_map.hpp.

◆ max_size()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::max_size ( ) const

inlinenodiscardnoexcept

Returns the maximum possible number of elements.

Returns: Maximum possible number of elements.

Definition at line 505 of file dense_map.hpp.

◆ operator=() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

dense_map & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::operator= ( const dense_map< Key, Type, Hash, KeyEqual, Allocator > & )

default

Default copy assignment operator.

Returns: This container.

◆ operator=() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

dense_map & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::operator= ( dense_map< Key, Type, Hash, KeyEqual, Allocator > && )

defaultnoexcept

Default move assignment operator.

Returns: This container.

◆ operator[]() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

mapped_type & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::operator[] ( const key_type & key )

inlinenodiscard

Accesses or inserts a given element.

Parameters

key	A key of an element to find or insert.

Returns: A reference to the mapped value of the requested element.

Definition at line 720 of file dense_map.hpp.

◆ operator[]() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

mapped_type & entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::operator[] ( key_type && key )

inlinenodiscard

Accesses or inserts a given element.

Parameters

key	A key of an element to find or insert.

Returns: A reference to the mapped value of the requested element.

Definition at line 729 of file dense_map.hpp.

◆ rehash()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::rehash ( const size_type cnt )

inline

Reserves at least the specified number of buckets and regenerates the hash table.

Parameters

cnt	New number of buckets.

Definition at line 961 of file dense_map.hpp.

◆ reserve()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::reserve ( const size_type cnt )

inline

Reserves space for at least the specified number of elements and regenerates the hash table.

Parameters

cnt	New number of elements.

Definition at line 985 of file dense_map.hpp.

◆ size()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

size_type entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::size ( ) const

inlinenodiscardnoexcept

Returns the number of elements in a container.

Returns: Number of elements in a container.

Definition at line 497 of file dense_map.hpp.

◆ swap()

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

void entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::swap ( dense_map< Key, Type, Hash, KeyEqual, Allocator > & other )

inlinenoexcept

Exchanges the contents with those of a given container.

Parameters

other Container to exchange the content with.

Definition at line 430 of file dense_map.hpp.

◆ try_emplace() [1/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename... Args>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::try_emplace	(	const key_type &	key,
		Args &&...	args )

inline

Inserts in-place if the key does not exist, does nothing if the key exists.

Template Parameters

Args	Types of arguments to forward to the constructor of the element.

Parameters

key	A key used both to look up and to insert if not found.
args	Arguments to forward to the constructor of the element.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Definition at line 622 of file dense_map.hpp.

◆ try_emplace() [2/2]

template<typename Key, typename Type, typename Hash, typename KeyEqual, typename Allocator>

template<typename... Args>

stl::pair< iterator, bool > entt::dense_map< Key, Type, Hash, KeyEqual, Allocator >::try_emplace	(	key_type &&	key,
		Args &&...	args )

inline

Inserts in-place if the key does not exist, does nothing if the key exists.

Template Parameters

Args	Types of arguments to forward to the constructor of the element.

Parameters

key	A key used both to look up and to insert if not found.
args	Arguments to forward to the constructor of the element.

Returns: A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place.

Definition at line 628 of file dense_map.hpp.

The documentation for this class was generated from the following file:

src/entt/container/dense_map.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_local_iterator

◆ difference_type

◆ hasher

◆ iterator

◆ key_equal

◆ key_type

◆ local_iterator

◆ mapped_type

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ dense_map() [1/7]

◆ dense_map() [2/7]

◆ dense_map() [3/7]

◆ dense_map() [4/7]

◆ dense_map() [5/7]

◆ dense_map() [6/7]

◆ dense_map() [7/7]

Member Function Documentation

◆ at() [1/4]

◆ at() [2/4]

◆ at() [3/4]

◆ at() [4/4]

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ bucket()

◆ bucket_count()

◆ bucket_size()

◆ cbegin() [1/2]

◆ cbegin() [2/2]

◆ cend() [1/2]

◆ cend() [2/2]

◆ clear()

◆ contains() [1/2]

◆ contains() [2/2]

◆ count() [1/2]

◆ count() [2/2]

◆ emplace()

◆ empty()

◆ end() [1/4]

◆ end() [2/4]

◆ end() [3/4]

◆ end() [4/4]

◆ equal_range() [1/4]

◆ equal_range() [2/4]

◆ equal_range() [3/4]

◆ equal_range() [4/4]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ find() [1/4]

◆ find() [2/4]

◆ find() [3/4]

◆ find() [4/4]

◆ get_allocator()

◆ hash_function()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ insert_or_assign() [1/2]

◆ insert_or_assign() [2/2]

◆ key_eq()

◆ load_factor()

◆ max_bucket_count()

◆ max_load_factor() [1/2]

◆ max_load_factor() [2/2]

◆ max_size()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]