Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
raw_hash_set documentation does not appear to match its implementation #236
Comments
|
The documentation does need to be fixed. We originally had groupings but later moved to floating windows. |
|
Ping on this. Has the documentation been fixed? |
|
Note that this is documentation within an implementation file, not in the API. Yes, it should be fixed. But it should not be depended on, in any case. |
The documentation of raw_hash_set (in particular, the ASCII-art drawing) clearly show that slots are divided into groups and groups are handled individually, i.e., when probing the structures the probe sequence is a sequence of groups. However, the implementation appears to use unaligned access and handles groups starting at any offset in the slot array (i.e., for every offset in the slot array there is a group starting at that offset, and groups overlap). Is this the case? If so, the documentation should be amended.