Implementation of a hash map using open-addressing and the robin hood hashing algorithm with backward shift deletion. More...

#include <robin_map.h>

Public Types
using	key_type = typename ht::key_type

using	mapped_type = T

using	value_type = typename ht::value_type

using	size_type = typename ht::size_type

using	difference_type = typename ht::difference_type

using	hasher = typename ht::hasher

using	key_equal = typename ht::key_equal

using	allocator_type = typename ht::allocator_type

using	reference = typename ht::reference

using	const_reference = typename ht::const_reference

using	pointer = typename ht::pointer

using	const_pointer = typename ht::const_pointer

using	iterator = typename ht::iterator

using	const_iterator = typename ht::const_iterator

Public Member Functions
	robin_map (size_type bucket_count, const Hash &hash=Hash(), const KeyEqual &equal=KeyEqual(), const Allocator &alloc=Allocator())

	robin_map (size_type bucket_count, const Allocator &alloc)

	robin_map (size_type bucket_count, const Hash &hash, const Allocator &alloc)

	robin_map (const Allocator &alloc)

template<class InputIt >
	robin_map (InputIt first, InputIt last, size_type bucket_count=ht::DEFAULT_INIT_BUCKETS_SIZE, const Hash &hash=Hash(), const KeyEqual &equal=KeyEqual(), const Allocator &alloc=Allocator())

template<class InputIt >
	robin_map (InputIt first, InputIt last, size_type bucket_count, const Allocator &alloc)

template<class InputIt >
	robin_map (InputIt first, InputIt last, size_type bucket_count, const Hash &hash, const Allocator &alloc)

	robin_map (std::initializer_list< value_type > init, size_type bucket_count=ht::DEFAULT_INIT_BUCKETS_SIZE, const Hash &hash=Hash(), const KeyEqual &equal=KeyEqual(), const Allocator &alloc=Allocator())

	robin_map (std::initializer_list< value_type > init, size_type bucket_count, const Allocator &alloc)

	robin_map (std::initializer_list< value_type > init, size_type bucket_count, const Hash &hash, const Allocator &alloc)

robin_map &	operator= (std::initializer_list< value_type > ilist)

allocator_type	get_allocator () const

iterator	begin () noexcept

const_iterator	begin () const noexcept

const_iterator	cbegin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cend () const noexcept

bool	empty () const noexcept

size_type	size () const noexcept

size_type	max_size () const noexcept

void	clear () noexcept

std::pair< iterator, bool >	insert (const value_type &value)

template<class P , typename std::enable_if< std::is_constructible< value_type, P && >::value >::type * = nullptr>
std::pair< iterator, bool >	insert (P &&value)

std::pair< iterator, bool >	insert (value_type &&value)

iterator	insert (const_iterator hint, const value_type &value)

template<class P , typename std::enable_if< std::is_constructible< value_type, P && >::value >::type * = nullptr>
iterator	insert (const_iterator hint, P &&value)

iterator	insert (const_iterator hint, value_type &&value)

template<class InputIt >
void	insert (InputIt first, InputIt last)

void	insert (std::initializer_list< value_type > ilist)

template<class M >
std::pair< iterator, bool >	insert_or_assign (const key_type &k, M &&obj)

template<class M >
std::pair< iterator, bool >	insert_or_assign (key_type &&k, M &&obj)

template<class M >
iterator	insert_or_assign (const_iterator hint, const key_type &k, M &&obj)

template<class M >
iterator	insert_or_assign (const_iterator hint, key_type &&k, M &&obj)

template<class... Args>
std::pair< iterator, bool >	emplace (Args &&... args)
	Due to the way elements are stored, emplace will need to move or copy the key-value once.

template<class... Args>
iterator	emplace_hint (const_iterator hint, Args &&... args)
	Due to the way elements are stored, emplace_hint will need to move or copy the key-value once.

template<class... Args>
std::pair< iterator, bool >	try_emplace (const key_type &k, Args &&... args)

template<class... Args>
std::pair< iterator, bool >	try_emplace (key_type &&k, Args &&... args)

template<class... Args>
iterator	try_emplace (const_iterator hint, const key_type &k, Args &&... args)

template<class... Args>
iterator	try_emplace (const_iterator hint, key_type &&k, Args &&... args)

iterator	erase (iterator pos)

iterator	erase (const_iterator pos)

iterator	erase (const_iterator first, const_iterator last)

size_type	erase (const key_type &key)

size_type	erase (const key_type &key, std::size_t precalculated_hash)
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
size_type	erase (const K &key)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
size_type	erase (const K &key, std::size_t precalculated_hash)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

void	swap (robin_map &other)

T &	at (const Key &key)

T &	at (const Key &key, std::size_t precalculated_hash)
	Use the hash value 'precalculated_hash' instead of hashing the key.

const T &	at (const Key &key) const

const T &	at (const Key &key, std::size_t precalculated_hash) const
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
T &	at (const K &key)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
T &	at (const K &key, std::size_t precalculated_hash)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
const T &	at (const K &key) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
const T &	at (const K &key, std::size_t precalculated_hash) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

T &	operator[] (const Key &key)

T &	operator[] (Key &&key)

size_type	count (const Key &key) const

size_type	count (const Key &key, std::size_t precalculated_hash) const
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
size_type	count (const K &key) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
size_type	count (const K &key, std::size_t precalculated_hash) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

iterator	find (const Key &key)

iterator	find (const Key &key, std::size_t precalculated_hash)
	Use the hash value 'precalculated_hash' instead of hashing the key.

const_iterator	find (const Key &key) const

const_iterator	find (const Key &key, std::size_t precalculated_hash) const
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
iterator	find (const K &key)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
iterator	find (const K &key, std::size_t precalculated_hash)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
const_iterator	find (const K &key) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
const_iterator	find (const K &key, std::size_t precalculated_hash) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

bool	contains (const Key &key) const

bool	contains (const Key &key, std::size_t precalculated_hash) const
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
bool	contains (const K &key) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
bool	contains (const K &key, std::size_t precalculated_hash) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

std::pair< iterator, iterator >	equal_range (const Key &key)

std::pair< iterator, iterator >	equal_range (const Key &key, std::size_t precalculated_hash)
	Use the hash value 'precalculated_hash' instead of hashing the key.

std::pair< const_iterator, const_iterator >	equal_range (const Key &key) const

std::pair< const_iterator, const_iterator >	equal_range (const Key &key, std::size_t precalculated_hash) const
	Use the hash value 'precalculated_hash' instead of hashing the key.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
std::pair< iterator, iterator >	equal_range (const K &key)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
std::pair< iterator, iterator >	equal_range (const K &key, std::size_t precalculated_hash)
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
std::pair< const_iterator, const_iterator >	equal_range (const K &key) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

template<class K , class KE = KeyEqual, typename std::enable_if< has_is_transparent< KE >::value >::type * = nullptr>
std::pair< const_iterator, const_iterator >	equal_range (const K &key, std::size_t precalculated_hash) const
	This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

size_type	bucket_count () const

size_type	max_bucket_count () const

float	load_factor () const

float	min_load_factor () const

float	max_load_factor () const

void	min_load_factor (float ml)
	Set the `min_load_factor` to `ml`.

void	max_load_factor (float ml)

void	rehash (size_type count_)

void	reserve (size_type count_)

hasher	hash_function () const

key_equal	key_eq () const

iterator	mutable_iterator (const_iterator pos)
	Convert a const_iterator to an iterator.

template<class Serializer >
void	serialize (Serializer &serializer) const
	Serialize the map through the `serializer` parameter.

Static Public Member Functions
template<class Deserializer >
static robin_map	deserialize (Deserializer &deserializer, bool hash_compatible=false)
	Deserialize a previously serialized map through the `deserializer` parameter.

Friends
bool	operator== (const robin_map &lhs, const robin_map &rhs)

bool	operator!= (const robin_map &lhs, const robin_map &rhs)

void	swap (robin_map &lhs, robin_map &rhs)

Detailed Description

template<class Key, class T, class Hash = std::hash<Key>, class KeyEqual = std::equal_to<Key>, class Allocator = std::allocator<std::pair<Key, T>>, bool StoreHash = false, class GrowthPolicy = pxr_tsl::rh::power_of_two_growth_policy<2>>
class pxr_tsl::robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy >

Implementation of a hash map using open-addressing and the robin hood hashing algorithm with backward shift deletion.

For operations modifying the hash map (insert, erase, rehash, ...), the strong exception guarantee is only guaranteed when the expression std::is_nothrow_swappable<std::pair<Key, T>>::value && std::is_nothrow_move_constructible<std::pair<Key, T>>::value is true, otherwise if an exception is thrown during the swap or the move, the hash map may end up in a undefined state. Per the standard a Key or T with a noexcept copy constructor and no move constructor also satisfies the std::is_nothrow_move_constructible<std::pair<Key, T>>::value criterion (and will thus guarantee the strong exception for the map).

When StoreHash is true, 32 bits of the hash are stored alongside the values. It can improve the performance during lookups if the KeyEqual function takes time (if it engenders a cache-miss for example) as we then compare the stored hashes before comparing the keys. When pxr_tsl::rh::power_of_two_growth_policy is used as GrowthPolicy, it may also speed-up the rehash process as we can avoid to recalculate the hash. When it is detected that storing the hash will not incur any memory penalty due to alignment (i.e. sizeof(pxr_tsl::detail_robin_hash::bucket_entry<ValueType, true>) == sizeof(pxr_tsl::detail_robin_hash::bucket_entry<ValueType, false>)) and pxr_tsl::rh::power_of_two_growth_policy is used, the hash will be stored even if StoreHash is false so that we can speed-up the rehash (but it will not be used on lookups unless StoreHash is true).

GrowthPolicy defines how the map grows and consequently how a hash value is mapped to a bucket. By default the map uses pxr_tsl::rh::power_of_two_growth_policy. This policy keeps the number of buckets to a power of two and uses a mask to map the hash to a bucket instead of the slow modulo. Other growth policies are available and you may define your own growth policy, check pxr_tsl::rh::power_of_two_growth_policy for the interface.

std::pair<Key, T> must be swappable.

Key and T must be copy and/or move constructible.

If the destructor of Key or T throws an exception, the behaviour of the class is undefined.

Iterators invalidation:

clear, operator=, reserve, rehash: always invalidate the iterators.
insert, emplace, emplace_hint, operator[]: if there is an effective insert, invalidate the iterators.
erase: always invalidate the iterators.

Definition at line 96 of file robin_map.h.

Member Typedef Documentation

◆ allocator_type

using allocator_type = typename ht::allocator_type

Definition at line 141 of file robin_map.h.

◆ const_iterator

using const_iterator = typename ht::const_iterator

Definition at line 147 of file robin_map.h.

◆ const_pointer

using const_pointer = typename ht::const_pointer

Definition at line 145 of file robin_map.h.

◆ const_reference

using const_reference = typename ht::const_reference

Definition at line 143 of file robin_map.h.

◆ difference_type

using difference_type = typename ht::difference_type

Definition at line 138 of file robin_map.h.

◆ hasher

using hasher = typename ht::hasher

Definition at line 139 of file robin_map.h.

◆ iterator

using iterator = typename ht::iterator

Definition at line 146 of file robin_map.h.

◆ key_equal

using key_equal = typename ht::key_equal

Definition at line 140 of file robin_map.h.

◆ key_type

using key_type = typename ht::key_type

Definition at line 134 of file robin_map.h.

◆ mapped_type

using mapped_type = T

Definition at line 135 of file robin_map.h.

◆ pointer

using pointer = typename ht::pointer

Definition at line 144 of file robin_map.h.

◆ reference

using reference = typename ht::reference

Definition at line 142 of file robin_map.h.

◆ size_type

using size_type = typename ht::size_type

Definition at line 137 of file robin_map.h.

◆ value_type

using value_type = typename ht::value_type

Definition at line 136 of file robin_map.h.

Constructor & Destructor Documentation

◆ robin_map() [1/11]

robin_map ( )

inline

Definition at line 153 of file robin_map.h.

◆ robin_map() [2/11]

robin_map	(	size_type	bucket_count,
		const Hash &	hash = `Hash()`,
		const KeyEqual &	equal = `KeyEqual()`,
		const Allocator &	alloc = `Allocator()`
	)

inlineexplicit

Definition at line 155 of file robin_map.h.

◆ robin_map() [3/11]

robin_map	(	size_type	bucket_count,
		const Allocator &	alloc
	)

inline

Definition at line 160 of file robin_map.h.

◆ robin_map() [4/11]

robin_map	(	size_type	bucket_count,
		const Hash &	hash,
		const Allocator &	alloc
	)

inline

Definition at line 163 of file robin_map.h.

◆ robin_map() [5/11]

robin_map ( const Allocator & alloc )

inlineexplicit

Definition at line 166 of file robin_map.h.

◆ robin_map() [6/11]

robin_map	(	InputIt	first,
		InputIt	last,
		size_type	bucket_count = `ht::DEFAULT_INIT_BUCKETS_SIZE`,
		const Hash &	hash = `Hash()`,
		const KeyEqual &	equal = `KeyEqual()`,
		const Allocator &	alloc = `Allocator()`
	)

inline

Definition at line 170 of file robin_map.h.

◆ robin_map() [7/11]

robin_map	(	InputIt	first,
		InputIt	last,
		size_type	bucket_count,
		const Allocator &	alloc
	)

inline

Definition at line 179 of file robin_map.h.

◆ robin_map() [8/11]

robin_map	(	InputIt	first,
		InputIt	last,
		size_type	bucket_count,
		const Hash &	hash,
		const Allocator &	alloc
	)

inline

Definition at line 184 of file robin_map.h.

◆ robin_map() [9/11]

robin_map	(	std::initializer_list< value_type >	init,
		size_type	bucket_count = `ht::DEFAULT_INIT_BUCKETS_SIZE`,
		const Hash &	hash = `Hash()`,
		const KeyEqual &	equal = `KeyEqual()`,
		const Allocator &	alloc = `Allocator()`
	)

inline

Definition at line 188 of file robin_map.h.

◆ robin_map() [10/11]

robin_map	(	std::initializer_list< value_type >	init,
		size_type	bucket_count,
		const Allocator &	alloc
	)

inline

Definition at line 194 of file robin_map.h.

◆ robin_map() [11/11]

robin_map	(	std::initializer_list< value_type >	init,
		size_type	bucket_count,
		const Hash &	hash,
		const Allocator &	alloc
	)

inline

Definition at line 199 of file robin_map.h.

Member Function Documentation

◆ at() [1/8]

T & at ( const K & key )

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 415 of file robin_map.h.

◆ at() [2/8]

const T & at ( const K & key ) const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 439 of file robin_map.h.

◆ at() [3/8]

T & at	(	const K &	key,
		std::size_t	precalculated_hash
	)

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 429 of file robin_map.h.

◆ at() [4/8]

const T & at	(	const K &	key,
		std::size_t	precalculated_hash
	)		const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 449 of file robin_map.h.

◆ at() [5/8]

T & at ( const Key & key )

inline

Definition at line 387 of file robin_map.h.

◆ at() [6/8]

const T & at ( const Key & key ) const

inline

Definition at line 398 of file robin_map.h.

◆ at() [7/8]

T & at	(	const Key &	key,
		std::size_t	precalculated_hash
	)

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 394 of file robin_map.h.

◆ at() [8/8]

const T & at	(	const Key &	key,
		std::size_t	precalculated_hash
	)		const

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 403 of file robin_map.h.

◆ begin() [1/2]

const_iterator begin ( ) const

inlinenoexcept

Definition at line 219 of file robin_map.h.

◆ begin() [2/2]

iterator begin ( )

inlinenoexcept

Definition at line 218 of file robin_map.h.

◆ bucket_count()

size_type bucket_count ( ) const

inline

Definition at line 677 of file robin_map.h.

◆ cbegin()

const_iterator cbegin ( ) const

inlinenoexcept

Definition at line 220 of file robin_map.h.

◆ cend()

const_iterator cend ( ) const

inlinenoexcept

Definition at line 224 of file robin_map.h.

◆ clear()

void clear ( )

inlinenoexcept

Definition at line 236 of file robin_map.h.

◆ contains() [1/4]

bool contains ( const K & key ) const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 582 of file robin_map.h.

◆ contains() [2/4]

bool contains	(	const K &	key,
		std::size_t	precalculated_hash
	)		const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 596 of file robin_map.h.

◆ contains() [3/4]

bool contains ( const Key & key ) const

inline

Definition at line 563 of file robin_map.h.

◆ contains() [4/4]

bool contains	(	const Key &	key,
		std::size_t	precalculated_hash
	)		const

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 570 of file robin_map.h.

◆ count() [1/4]

size_type count ( const K & key ) const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 475 of file robin_map.h.

◆ count() [2/4]

size_type count	(	const K &	key,
		std::size_t	precalculated_hash
	)		const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 489 of file robin_map.h.

◆ count() [3/4]

size_type count ( const Key & key ) const

inline

Definition at line 456 of file robin_map.h.

◆ count() [4/4]

size_type count	(	const Key &	key,
		std::size_t	precalculated_hash
	)		const

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 463 of file robin_map.h.

◆ deserialize()

static robin_map deserialize	(	Deserializer &	deserializer,
		bool	hash_compatible = `false`
	)

inlinestatic

Deserialize a previously serialized map through the deserializer parameter.

The deserializer parameter must be a function object that supports the following call:

template<typename U> U operator()(); where the types std::int16_t, std::uint32_t, std::uint64_t, float and std::pair<Key, T> must be supported for U.

If the deserialized hash map type is hash compatible with the serialized map, the deserialization process can be sped up by setting hash_compatible to true. To be hash compatible, the Hash, KeyEqual and GrowthPolicy must behave the same way than the ones used on the serialized map and the StoreHash must have the same value. The std::size_t must also be of the same size as the one on the platform used to serialize the map. If these criteria are not met, the behaviour is undefined with hash_compatible sets to true.

The behaviour is undefined if the type Key and T of the robin_map are not the same as the types used during serialization.

The implementation leaves binary compatibility (endianness, IEEE 754 for floats, size of int, ...) of the types it deserializes in the hands of the Deserializer function object if compatibility is required.

Definition at line 765 of file robin_map.h.

◆ emplace()

std::pair< iterator, bool > emplace ( Args &&... args )

inline

Due to the way elements are stored, emplace will need to move or copy the key-value once.

The method is equivalent to insert(value_type(std::forward<Args>(args)...));

Mainly here for compatibility with the std::unordered_map interface.

Definition at line 303 of file robin_map.h.

◆ emplace_hint()

iterator emplace_hint	(	const_iterator	hint,
		Args &&...	args
	)

inline

Due to the way elements are stored, emplace_hint will need to move or copy the key-value once.

The method is equivalent to insert(hint, value_type(std::forward<Args>(args)...));

Mainly here for compatibility with the std::unordered_map interface.

Definition at line 315 of file robin_map.h.

◆ empty()

bool empty ( ) const

inlinenoexcept

Definition at line 229 of file robin_map.h.

◆ end() [1/2]

const_iterator end ( ) const

inlinenoexcept

Definition at line 223 of file robin_map.h.

◆ end() [2/2]

iterator end ( )

inlinenoexcept

Definition at line 222 of file robin_map.h.

◆ equal_range() [1/8]

std::pair< iterator, iterator > equal_range ( const K & key )

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 634 of file robin_map.h.

◆ equal_range() [2/8]

std::pair< const_iterator, const_iterator > equal_range ( const K & key ) const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 659 of file robin_map.h.

◆ equal_range() [3/8]

std::pair< iterator, iterator > equal_range	(	const K &	key,
		std::size_t	precalculated_hash
	)

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 648 of file robin_map.h.

◆ equal_range() [4/8]

std::pair< const_iterator, const_iterator > equal_range	(	const K &	key,
		std::size_t	precalculated_hash
	)		const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 669 of file robin_map.h.

◆ equal_range() [5/8]

std::pair< iterator, iterator > equal_range ( const Key & key )

inline

Definition at line 600 of file robin_map.h.

◆ equal_range() [6/8]

std::pair< const_iterator, const_iterator > equal_range ( const Key & key ) const

inline

Definition at line 614 of file robin_map.h.

◆ equal_range() [7/8]

std::pair< iterator, iterator > equal_range	(	const Key &	key,
		std::size_t	precalculated_hash
	)

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 609 of file robin_map.h.

◆ equal_range() [8/8]

std::pair< const_iterator, const_iterator > equal_range	(	const Key &	key,
		std::size_t	precalculated_hash
	)		const

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 621 of file robin_map.h.

◆ erase() [1/7]

size_type erase ( const K & key )

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 364 of file robin_map.h.

◆ erase() [2/7]

size_type erase	(	const K &	key,
		std::size_t	precalculated_hash
	)

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup to the value if you already have the hash.

Definition at line 378 of file robin_map.h.

◆ erase() [3/7]

size_type erase ( const key_type & key )

inline

Definition at line 345 of file robin_map.h.

◆ erase() [4/7]

size_type erase	(	const key_type &	key,
		std::size_t	precalculated_hash
	)

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup to the value if you already have the hash.

Definition at line 352 of file robin_map.h.

◆ erase() [5/7]

iterator erase	(	const_iterator	first,
		const_iterator	last
	)

inline

Definition at line 342 of file robin_map.h.

◆ erase() [6/7]

iterator erase ( const_iterator pos )

inline

Definition at line 341 of file robin_map.h.

◆ erase() [7/7]

iterator erase ( iterator pos )

inline

Definition at line 340 of file robin_map.h.

◆ find() [1/8]

iterator find ( const K & key )

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 521 of file robin_map.h.

◆ find() [2/8]

const_iterator find ( const K & key ) const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Definition at line 545 of file robin_map.h.

◆ find() [3/8]

iterator find	(	const K &	key,
		std::size_t	precalculated_hash
	)

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 535 of file robin_map.h.

◆ find() [4/8]

const_iterator find	(	const K &	key,
		std::size_t	precalculated_hash
	)		const

inline

This overload only participates in the overload resolution if the typedef KeyEqual::is_transparent exists.

If so, K must be hashable and comparable to Key.

Use the hash value 'precalculated_hash' instead of hashing the key. The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 559 of file robin_map.h.

◆ find() [5/8]

iterator find ( const Key & key )

inline

Definition at line 493 of file robin_map.h.

◆ find() [6/8]

const_iterator find ( const Key & key ) const

inline

Definition at line 504 of file robin_map.h.

◆ find() [7/8]

iterator find	(	const Key &	key,
		std::size_t	precalculated_hash
	)

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 500 of file robin_map.h.

◆ find() [8/8]

const_iterator find	(	const Key &	key,
		std::size_t	precalculated_hash
	)		const

inline

Use the hash value 'precalculated_hash' instead of hashing the key.

The hash value should be the same as hash_function()(key). Useful to speed-up the lookup if you already have the hash.

Definition at line 509 of file robin_map.h.

◆ get_allocator()

allocator_type get_allocator ( ) const

inline

Definition at line 213 of file robin_map.h.

◆ hash_function()

hasher hash_function ( ) const

inline

Definition at line 706 of file robin_map.h.

◆ insert() [1/8]

std::pair< iterator, bool > insert ( const value_type & value )

inline

Definition at line 238 of file robin_map.h.

◆ insert() [2/8]

iterator insert	(	const_iterator	hint,
		const value_type &	value
	)

inline

Definition at line 252 of file robin_map.h.

◆ insert() [3/8]

iterator insert	(	const_iterator	hint,
		P &&	value
	)

inline

Definition at line 258 of file robin_map.h.

◆ insert() [4/8]

iterator insert	(	const_iterator	hint,
		value_type &&	value
	)

inline

Definition at line 262 of file robin_map.h.

◆ insert() [5/8]

void insert	(	InputIt	first,
		InputIt	last
	)

inline

Definition at line 267 of file robin_map.h.

◆ insert() [6/8]

std::pair< iterator, bool > insert ( P && value )

inline

Definition at line 244 of file robin_map.h.

◆ insert() [7/8]

void insert ( std::initializer_list< value_type > ilist )

inline

Definition at line 271 of file robin_map.h.

◆ insert() [8/8]

std::pair< iterator, bool > insert ( value_type && value )

inline

Definition at line 248 of file robin_map.h.

◆ insert_or_assign() [1/4]

std::pair< iterator, bool > insert_or_assign	(	const key_type &	k,
		M &&	obj
	)

inline

Definition at line 276 of file robin_map.h.

◆ insert_or_assign() [2/4]

iterator insert_or_assign	(	const_iterator	hint,
		const key_type &	k,
		M &&	obj
	)

inline

Definition at line 286 of file robin_map.h.

◆ insert_or_assign() [3/4]

iterator insert_or_assign	(	const_iterator	hint,
		key_type &&	k,
		M &&	obj
	)

inline

Definition at line 291 of file robin_map.h.

◆ insert_or_assign() [4/4]

std::pair< iterator, bool > insert_or_assign	(	key_type &&	k,
		M &&	obj
	)

inline

Definition at line 281 of file robin_map.h.

◆ key_eq()

key_equal key_eq ( ) const

inline

Definition at line 707 of file robin_map.h.

◆ load_factor()

float load_factor ( ) const

inline

Definition at line 683 of file robin_map.h.

◆ max_bucket_count()

size_type max_bucket_count ( ) const

inline

Definition at line 678 of file robin_map.h.

◆ max_load_factor() [1/2]

float max_load_factor ( ) const

inline

Definition at line 686 of file robin_map.h.

◆ max_load_factor() [2/2]

void max_load_factor ( float ml )

inline

Definition at line 698 of file robin_map.h.

◆ max_size()

size_type max_size ( ) const

inlinenoexcept

Definition at line 231 of file robin_map.h.

◆ min_load_factor() [1/2]

float min_load_factor ( ) const

inline

Definition at line 685 of file robin_map.h.

◆ min_load_factor() [2/2]

void min_load_factor ( float ml )

inline

Set the min_load_factor to ml.

When the load_factor of the map goes below min_load_factor after some erase operations, the map will be shrunk when an insertion occurs. The erase method itself never shrinks the map.

The default value of min_load_factor is 0.0f, the map never shrinks by default.

Definition at line 697 of file robin_map.h.

◆ mutable_iterator()

iterator mutable_iterator ( const_iterator pos )

inline

Convert a const_iterator to an iterator.

Definition at line 716 of file robin_map.h.

◆ operator=()

robin_map & operator= ( std::initializer_list< value_type > ilist )

inline

Definition at line 204 of file robin_map.h.

◆ operator[]() [1/2]

T & operator[] ( const Key & key )

inline

Definition at line 453 of file robin_map.h.

◆ operator[]() [2/2]

T & operator[] ( Key && key )

inline

Definition at line 454 of file robin_map.h.

◆ rehash()

void rehash ( size_type count_ )

inline

Definition at line 700 of file robin_map.h.

◆ reserve()

void reserve ( size_type count_ )

inline

Definition at line 701 of file robin_map.h.

◆ serialize()

void serialize ( Serializer & serializer ) const

inline

Serialize the map through the serializer parameter.

The serializer parameter must be a function object that supports the following call:

template<typename U> void operator()(const U& value); where the types std::int16_t, std::uint32_t, std::uint64_t, float and std::pair<Key, T> must be supported for U.

The implementation leaves binary compatibility (endianness, IEEE 754 for floats, ...) of the types it serializes in the hands of the Serializer function object if compatibility is required.

Definition at line 734 of file robin_map.h.

◆ size()

size_type size ( ) const

inlinenoexcept

Definition at line 230 of file robin_map.h.

◆ swap()

void swap ( robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > & other )

inline

Definition at line 382 of file robin_map.h.

◆ try_emplace() [1/4]

std::pair< iterator, bool > try_emplace	(	const key_type &	k,
		Args &&...	args
	)

inline

Definition at line 320 of file robin_map.h.

◆ try_emplace() [2/4]

iterator try_emplace	(	const_iterator	hint,
		const key_type &	k,
		Args &&...	args
	)

inline

Definition at line 330 of file robin_map.h.

◆ try_emplace() [3/4]

iterator try_emplace	(	const_iterator	hint,
		key_type &&	k,
		Args &&...	args
	)

inline

Definition at line 335 of file robin_map.h.

◆ try_emplace() [4/4]

std::pair< iterator, bool > try_emplace	(	key_type &&	k,
		Args &&...	args
	)

inline

Definition at line 325 of file robin_map.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	lhs,
		const robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	rhs
	)

friend

Definition at line 789 of file robin_map.h.

◆ operator==

bool operator==	(	const robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	lhs,
		const robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	rhs
	)

friend

Definition at line 773 of file robin_map.h.

◆ swap

void swap	(	robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	lhs,
		robin_map< Key, T, Hash, KeyEqual, Allocator, StoreHash, GrowthPolicy > &	rhs
	)

friend

Definition at line 793 of file robin_map.h.

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

pxr/base/tf/pxrTslRobinMap/robin_map.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ difference_type

◆ hasher

◆ iterator

◆ key_equal

◆ key_type

◆ mapped_type

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ robin_map() [1/11]

◆ robin_map() [2/11]

◆ robin_map() [3/11]

◆ robin_map() [4/11]

◆ robin_map() [5/11]

◆ robin_map() [6/11]

◆ robin_map() [7/11]

◆ robin_map() [8/11]

◆ robin_map() [9/11]

◆ robin_map() [10/11]

◆ robin_map() [11/11]

Member Function Documentation

◆ at() [1/8]

◆ at() [2/8]

◆ at() [3/8]

◆ at() [4/8]

◆ at() [5/8]

◆ at() [6/8]

◆ at() [7/8]

◆ at() [8/8]

◆ begin() [1/2]

◆ begin() [2/2]

◆ bucket_count()

◆ cbegin()

◆ cend()

◆ clear()

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ count() [1/4]

◆ count() [2/4]

◆ count() [3/4]

◆ count() [4/4]

◆ deserialize()

◆ emplace()

◆ emplace_hint()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ equal_range() [1/8]

◆ equal_range() [2/8]

◆ equal_range() [3/8]

◆ equal_range() [4/8]

◆ equal_range() [5/8]

◆ equal_range() [6/8]

◆ equal_range() [7/8]

◆ equal_range() [8/8]

◆ erase() [1/7]

◆ erase() [2/7]

◆ erase() [3/7]

◆ erase() [4/7]

◆ erase() [5/7]

◆ erase() [6/7]

◆ erase() [7/7]

◆ find() [1/8]

◆ find() [2/8]

◆ find() [3/8]

◆ find() [4/8]