pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash > Class Template Reference

#include <robin_hash.h>

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

Public Types
using	value_type = ValueType
using	distance_type = std::int16_t

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 hash, Args &&...value_type_args)
void	swap_with_value_in_bucket (distance_type &dist_from_ideal_bucket, truncated_hash_type &hash, value_type &value)
Public Member Functions inherited from pxr_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 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 = 8192

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

Detailed Description

template<typename ValueType, bool StoreHash>
class pxr_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).

Definition at line 175 of file robin_hash.h.

Member Typedef Documentation

template<typename ValueType , bool StoreHash>

using pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::distance_type = std::int16_t

Definition at line 180 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

using pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::value_type = ValueType

Definition at line 179 of file robin_hash.h.

Constructor & Destructor Documentation

template<typename ValueType , bool StoreHash>

pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::bucket_entry ( )

inlinenoexcept

Definition at line 182 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::bucket_entry ( bool  last_bucket )

inlinenoexcept

Definition at line 189 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::bucket_entry ( const bucket_entry< ValueType, StoreHash > &  other )

inlinenoexcept

Definition at line 196 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::bucket_entry ( bucket_entry< ValueType, StoreHash > &&  other )

inlinenoexcept

Never really used, but still necessary as we must call resize on an empty std::vector<bucket_entry>. and we need to support move-only types. See robin_hash constructor for details.

Definition at line 214 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::~bucket_entry ( )

inlinenoexcept

Definition at line 247 of file robin_hash.h.

Member Function Documentation

template<typename ValueType , bool StoreHash>

void pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::clear ( )

inlinenoexcept

Definition at line 249 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

distance_type pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::dist_from_ideal_bucket ( ) const

inlinenoexcept

Definition at line 280 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

bool pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::empty ( void  ) const

inlinenoexcept

Definition at line 256 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

bool pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::last_bucket ( ) const

inlinenoexcept

Definition at line 284 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

bucket_entry& pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::operator= ( const bucket_entry< ValueType, StoreHash > &  other )

inlinenoexcept

Definition at line 227 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

bucket_entry& pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::operator= ( bucket_entry< ValueType, StoreHash > &&  )

delete

template<typename ValueType , bool StoreHash>

void pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::set_as_last_bucket ( )

inlinenoexcept

Definition at line 286 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

template<typename... Args>

void pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::set_value_of_empty_bucket ( distance_type  dist_from_ideal_bucket, truncated_hash_type  hash, Args &&...  value_type_args  )

inline

Definition at line 289 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

void pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::swap_with_value_in_bucket ( distance_type &  dist_from_ideal_bucket, truncated_hash_type &  hash, value_type &  value  )

inline

Definition at line 303 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

static truncated_hash_type pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::truncate_hash ( std::size_t  hash )

inlinestaticnoexcept

Definition at line 322 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

value_type& pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::value ( )

inlinenoexcept

Definition at line 260 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

const value_type& pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::value ( ) const

inlinenoexcept

Definition at line 270 of file robin_hash.h.

Member Data Documentation

template<typename ValueType , bool StoreHash>

const distance_type pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::DIST_FROM_IDEAL_BUCKET_LIMIT = 8192

static

Definition at line 334 of file robin_hash.h.

template<typename ValueType , bool StoreHash>

const distance_type pxr_tsl::detail_robin_hash::bucket_entry< ValueType, StoreHash >::EMPTY_MARKER_DIST_FROM_IDEAL_BUCKET = -1

static

Definition at line 333 of file robin_hash.h.

---

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

• pxr/base/tf/pxrTslRobinMap/robin_hash.h