DRY up and document magic constant used for hash maps

This commit is contained in:
Vinnie Falco
2013-06-07 11:35:56 -07:00
parent 3cf2fb884d
commit db9f62646d
3 changed files with 25 additions and 19 deletions

View File

@@ -15,6 +15,28 @@
class HashMaps // : beast::Uncopayble
{
public:
/** Golden ratio constant used in hashing functions.
The magic number is supposed to be 32 random bits, where each is
equally likely to be 0 or 1, and with no simple correlation between
the bits. A common way to find a string of such bits is to use the
binary expansion of an irrational number; in this case, that number
is the reciprocal of the golden ratio:
@code
phi = (1 + sqrt(5)) / 2
2^32 / phi = 0x9e3779b9
@endcode
References:
http://stackoverflow.com/questions/4948780/magic-number-in-boosthash-combine
http://burtleburtle.net/bob/hash/doobs.html
*/
static std::size_t const goldenRatio = 0x9e3779b9;
/** Retrieve the singleton.
@return The global instance of the singleton.