Grow the hash table by a factor of GrowthFactor keeping the bucket count to a power of two. More...

#include <robin_growth_policy.h>

Public Member Functions
	power_of_two_growth_policy (std::size_t &min_bucket_count_in_out)
	Called on the hash table creation and on rehash.

std::size_t	bucket_for_hash (std::size_t hash) const noexcept
	Return the bucket [0, bucket_count()) to which the hash belongs.

std::size_t	next_bucket_count () const
	Return the number of buckets that should be used on next growth.

std::size_t	max_bucket_count () const
	Return the maximum number of buckets supported by the policy.

void	clear () noexcept
	Reset the growth policy as if it was created with a bucket count of 0.

Protected Attributes
std::size_t	m_mask

Detailed Description

template<std::size_t GrowthFactor>
class pxr_tsl::rh::power_of_two_growth_policy< GrowthFactor >

Grow the hash table by a factor of GrowthFactor keeping the bucket count to a power of two.

It allows the table to use a mask operation instead of a modulo operation to map a hash to a bucket.

GrowthFactor must be a power of two >= 2.

Definition at line 90 of file robin_growth_policy.h.

Constructor & Destructor Documentation

◆ power_of_two_growth_policy()

power_of_two_growth_policy ( std::size_t & min_bucket_count_in_out )

inlineexplicit

Called on the hash table creation and on rehash.

The number of buckets for the table is passed in parameter. This number is a minimum, the policy may update this value with a higher value if needed (but not lower).

If 0 is given, min_bucket_count_in_out must still be 0 after the policy creation and bucket_for_hash must always return 0 in this case.

Definition at line 100 of file robin_growth_policy.h.

Member Function Documentation

◆ bucket_for_hash()

std::size_t bucket_for_hash ( std::size_t hash ) const

inlinenoexcept

Return the bucket [0, bucket_count()) to which the hash belongs.

If bucket_count() is 0, it must always return 0.

Definition at line 119 of file robin_growth_policy.h.

◆ clear()

void clear ( )

inlinenoexcept

Reset the growth policy as if it was created with a bucket count of 0.

After a clear, the policy must always return 0 when bucket_for_hash is called.

Definition at line 148 of file robin_growth_policy.h.

◆ max_bucket_count()

std::size_t max_bucket_count ( ) const

inline

Return the maximum number of buckets supported by the policy.

Definition at line 138 of file robin_growth_policy.h.

◆ next_bucket_count()

std::size_t next_bucket_count ( ) const

inline

Return the number of buckets that should be used on next growth.

Definition at line 126 of file robin_growth_policy.h.

Member Data Documentation

◆ m_mask

std::size_t m_mask

protected

Definition at line 176 of file robin_growth_policy.h.

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

pxr/base/tf/pxrTslRobinMap/robin_growth_policy.h

Public Member Functions

Protected Attributes