Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Documentation for cub::DeviceSpmv refers to unused alpha and beta parameters #416

Closed
WeiqunZhang opened this issue Jan 2, 2022 · 1 comment · Fixed by #430
Closed

Documentation for cub::DeviceSpmv refers to unused alpha and beta parameters #416

WeiqunZhang opened this issue Jan 2, 2022 · 1 comment · Fixed by #430
Labels
good first issue Good for newcomers. only: docs Documentation changes only. Doesn't need code CI. P0: must have Absolutely necessary. Critical issue, major blocker, etc.
Milestone

Comments

@WeiqunZhang
Copy link

WeiqunZhang commented Jan 2, 2022

There is some inconsistency in the documentation for cub::DeviceSpmv (https://nvlabs.github.io/cub/structcub_1_1_device_spmv.html). The overview says

The SpMV computation performs the matrix-vector operation y = alpha*A*x + beta*y,

But the function signature of CsrMV has neither alpha nor beta, and the function's description says

This function performs the matrix-vector operation y = A*x

However, the code snippet has alpha and beta.

cub::DeviceSpmv::CsrMV(d_temp_storage, temp_storage_bytes, d_values,
    d_row_offsets, d_column_indices, d_vector_x, d_vector_y,
    num_rows, num_cols, num_nonzeros, alpha, beta);

Could someone clarify on this? Thanks!

@alliepiper
Copy link
Collaborator

Thanks for reporting this! This should be fixed for the next release.

You are correct, the DeviceSPMV function does not expose the alpha/beta parameters, they are fixed to 1 and 0 respectively.

@alliepiper alliepiper added good first issue Good for newcomers. only: docs Documentation changes only. Doesn't need code CI. P0: must have Absolutely necessary. Critical issue, major blocker, etc. labels Jan 10, 2022
@alliepiper alliepiper added this to the 1.16.0 milestone Jan 10, 2022
@alliepiper alliepiper changed the title Documentation for cub::DeviceSpmv Documentation for cub::DeviceSpmv refers to unused alpha and beta parameters Jan 10, 2022
alliepiper added a commit to alliepiper/cub that referenced this issue Feb 7, 2022
These parameters are not exposed in the public APIs.

Fixes NVIDIA#416.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers. only: docs Documentation changes only. Doesn't need code CI. P0: must have Absolutely necessary. Critical issue, major blocker, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants