#include <robin_hash.h>

Inheritance diagram for tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >:

Collaboration diagram for tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >:

Public Member Functions
	bucket_entry () noexcept
	bucket_entry (bool last_bucket) noexcept
	bucket_entry (const bucket_entry &other) noexcept(std::is_nothrow_copy_constructible< value_type >::value)
	bucket_entry (bucket_entry &&other) noexcept(std::is_nothrow_move_constructible< value_type >::value)
bucket_entry &	operator= (const bucket_entry &other) noexcept(std::is_nothrow_copy_constructible< value_type >::value)
bucket_entry &	operator= (bucket_entry &&)=delete
	~bucket_entry () noexcept
void	clear () noexcept
bool	empty () const noexcept
value_type &	value () noexcept
const value_type &	value () const noexcept
distance_type	dist_from_ideal_bucket () const noexcept
bool	last_bucket () const noexcept
void	set_as_last_bucket () noexcept
template<typename... Args>
void	set_value_of_empty_bucket (distance_type dist_from_ideal_bucket, truncated_hash_type my_hash, Args &&...value_type_args)
void	swap_with_value_in_bucket (distance_type &dist_from_ideal_bucket, truncated_hash_type &my_hash, value_type &value)
Public Member Functions inherited from tsl::detail_robin_hash::bucket_entry_hash< StoreHash >
bool	bucket_hash_equal (std::size_t) const noexcept
truncated_hash_type	truncated_hash () const noexcept

Static Public Member Functions
static truncated_hash_type	truncate_hash (std::size_t my_hash) noexcept

Static Public Attributes
static const distance_type	EMPTY_MARKER_DIST_FROM_IDEAL_BUCKET = -1
static const distance_type	DIST_FROM_IDEAL_BUCKET_LIMIT = 4096

Private Types
using	bucket_hash = bucket_entry_hash<StoreHash>
using	storage = typename std::aligned_storage<sizeof(value_type), alignof(value_type)>::type

Private Member Functions
void	destroy_value () noexcept

Additional Inherited Members
Protected Member Functions inherited from tsl::detail_robin_hash::bucket_entry_hash< StoreHash >
void	set_hash (truncated_hash_type) noexcept

Detailed Description

template<typename ValueType, bool StoreHash>
class tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >

Each bucket entry has:

A value of type ValueType.
An integer to store how far the value of the bucket, if any, is from its ideal bucket (ex: if the current bucket 5 has the value 'foo' and ‘hash('foo’) % nb_buckets == 3, dist_from_ideal_bucket() will return 2 as the current value of the bucket is two buckets away from its ideal bucket) If there is no value in the bucket (i.e. empty() is true) dist_from_ideal_bucket() will be < 0.
A marker which tells us if the bucket is the last bucket of the bucket array (useful for the iterator of the hash table).
If StoreHash` is true, 32 bits of the hash of the value, if any, are also stored in the bucket. If the size of the hash is more than 32 bits, it is truncated. We don't store the full hash as storing the hash is a potential opportunity to use the unused space due to the alignment of the bucket_entry structure. We can thus potentially store the hash without any extra space (which would not be possible with 64 bits of the hash).