Skip to content

Error in the documentation of the function "any" #147

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

Open
AntoineBut opened this issue May 12, 2025 · 1 comment
Open

Error in the documentation of the function "any" #147

AntoineBut opened this issue May 12, 2025 · 1 comment

Comments

@AntoineBut
Copy link

Hi!

I just spent quite some time figuring out why my code did not produce the expected results, and just found out the reason. In this package's documentation, I found next to the any operator:

any(x, y) = 1 if x or y are stored values

which is the usual behavior of the operation any on an iterable collection in Julia.

However, in the SuiteSparseGraphBLAS user guide (which I found there) , we are told page 65:

The ANY operator is very unusual, but very powerful. It is the function
fany(x,y) = x, or y, where GraphBLAS has to freedom to select either x,
or y, at its own discretion. Do not confuse the ANY operator with the any
function in MATLAB/Octave, which computes a reduction using the logical
OR operator.

From what I've seen, the behavior we are getting is the one from SuitedSparseGraphBLAS, so it could be nice updating the docs to avoid this confusion.

@AntoineBut
Copy link
Author

Additional information : the note next to the pair operator had an error too, which is also fixed in this quick PR :))

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

No branches or pull requests

1 participant