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

"reflexive" vs. "symmetric" in hash_table.h doc #519

Closed
sfsiegel opened this issue Oct 6, 2019 · 1 comment · Fixed by #1056
Closed

"reflexive" vs. "symmetric" in hash_table.h doc #519

sfsiegel opened this issue Oct 6, 2019 · 1 comment · Fixed by #1056
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue pending-release This issue will be fixed by an approved PR that hasn't been released yet.

Comments

@sfsiegel
Copy link

sfsiegel commented Oct 6, 2019

The documentation for function aws_hash_callback_eq_fn in hash_table.h states

Equality functions used in a hash table must be reflexive (i.e., a == b if and only if b == a)...

"Reflexive" means a==a for all a. A relation satisfying (a==b iff b==a) is "symmetric". Probably you want to require that equality functions are reflexive, symmetric, and transitive, i.e., that they are equivalence relations.

For comparison, see https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-

@JonathanHenson
Copy link
Contributor

Thanks for letting us know. We’ll update it.

@JonathanHenson JonathanHenson added the documentation This is a problem with documentation. label Oct 6, 2019
@jmklix jmklix linked a pull request Sep 6, 2023 that will close this issue
@jmklix jmklix added pending-release This issue will be fixed by an approved PR that hasn't been released yet. p3 This is a minor priority issue labels Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue pending-release This issue will be fixed by an approved PR that hasn't been released yet.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants