Skip to content

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

Open
@AntoineBut

Description

@AntoineBut

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions