Skip to content

[DOCS] Improves docs for DeviceTopK, clarifying that inputs and output ranges must not overlap #7086

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.

Sign up for GitHub

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

Merged
elstehle merged 4 commits into from
Jan 12, 2026
Merged

[DOCS] Improves docs for DeviceTopK, clarifying that inputs and output ranges must not overlap #7086

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4be51d
improves topk docs that in/out must not overlap
elstehle Jan 6, 2026
760bda1
adds highlighted text box
elstehle Jan 6, 2026
964574f
Merge branch 'main' into docs/topk-no-alias-in-out2
elstehle Jan 7, 2026
da0dc3b
Merge branch 'main' into docs/topk-no-alias-in-out2
elstehle Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions cub/cub/device/device_topk.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,11 @@ struct DeviceTopK
//! Overview
//! +++++++++++++++++++++++++++++++++++++++++++++
//!
//! - Finds the largest K keys and their corresponding values from an unordered input sequence of key-value pairs.
//! - Note that the behavior is undefined if the input and output ranges overlap in any way.
//! Finds the largest K keys and their corresponding values from an unordered input sequence of key-value pairs.
//!
//! .. note::
//!
//! The behavior is undefined if the input and output ranges overlap in any way.
//!
//! - @devicestorage
//!
Expand Down Expand Up @@ -247,8 +250,11 @@ struct DeviceTopK
//! Overview
//! +++++++++++++++++++++++++++++++++++++++++++++
//!
//! - Finds the lowest K keys and their corresponding values from an unordered input sequence of key-value pairs.
//! - Note that the behavior is undefined if the input and output ranges overlap in any way.
//! Finds the lowest K keys and their corresponding values from an unordered input sequence of key-value pairs.
//!
//! .. note::
//!
//! The behavior is undefined if the input and output ranges overlap in any way.
//!
//! - @devicestorage
//!
Expand Down Expand Up @@ -351,8 +357,11 @@ struct DeviceTopK
//! Overview
//! +++++++++++++++++++++++++++++++++++++++++++++
//!
//! - Finds the largest K keys from an unordered input sequence of keys.
//! - Note that the behavior is undefined if the input and output ranges overlap in any way.
//! Finds the largest K keys from an unordered input sequence of keys.
//!
//! .. note::
//!
//! The behavior is undefined if the input and output ranges overlap in any way.
//!
//! - @devicestorage
//!
Expand Down Expand Up @@ -438,8 +447,11 @@ struct DeviceTopK
//! Overview
//! +++++++++++++++++++++++++++++++++++++++++++++
//!
//! - Finds the lowest K keys from an unordered input sequence of keys.
//! - Note that the behavior is undefined if the input and output ranges overlap in any way.
//! Finds the lowest K keys from an unordered input sequence of keys.
//!
//! .. note::
//!
//! The behavior is undefined if the input and output ranges overlap in any way.
//!
//! - @devicestorage
//!
Expand Down