Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

raw_hash_set documentation does not appear to match its implementation #236

Open
vigna opened this issue Dec 21, 2018 · 3 comments
Open

raw_hash_set documentation does not appear to match its implementation #236

vigna opened this issue Dec 21, 2018 · 3 comments
Assignees
Labels

Comments

@vigna
Copy link

@vigna vigna commented Dec 21, 2018

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.

@fowles
Copy link

@fowles fowles commented Jan 2, 2019

The documentation does need to be fixed. We originally had groupings but later moved to floating windows.

@JonathanDCohen
Copy link
Contributor

@JonathanDCohen JonathanDCohen commented Feb 26, 2019

Ping on this. Has the documentation been fixed?

@manshreck
Copy link

@manshreck manshreck commented Feb 28, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.