Skip to content

Commit

Permalink
adds tparam docs for NumItemsT
Browse files Browse the repository at this point in the history
  • Loading branch information
elstehle committed Aug 19, 2024
1 parent ebea6bd commit 7672dff
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions cub/cub/device/device_scan.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ struct DeviceScan
//! @tparam OutputIteratorT
//! **[inferred]** Random-access output iterator type for writing scan outputs @iterator
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -262,6 +265,9 @@ struct DeviceScan
//! @tparam IteratorT
//! **[inferred]** Random-access iterator type for reading scan inputs and wrigin scan outputs
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -378,6 +384,9 @@ struct DeviceScan
//! **[inferred]** Type of the `init_value` used Binary scan functor type
//! having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -521,6 +530,9 @@ struct DeviceScan
//! **[inferred]** Type of the `init_value` used Binary scan functor type
//! having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -656,6 +668,9 @@ struct DeviceScan
//! **[inferred]** Type of the `init_value` used Binary scan functor type
//! having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -812,6 +827,9 @@ struct DeviceScan
//! **[inferred]** Type of the `init_value` used Binary scan functor type
//! having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -934,6 +952,9 @@ struct DeviceScan
//! @tparam OutputIteratorT
//! **[inferred]** Random-access output iterator type for writing scan outputs @iterator
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -1038,6 +1059,9 @@ struct DeviceScan
//! @tparam IteratorT
//! **[inferred]** Random-access input iterator type for reading scan inputs and writing scan outputs
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage. When `nullptr`, the
//! required allocation size is written to `temp_storage_bytes` and no work is done.
Expand Down Expand Up @@ -1148,6 +1172,9 @@ struct DeviceScan
//! @tparam ScanOp
//! **[inferred]** Binary scan functor type having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in]
//! d_temp_storage Device-accessible allocation of temporary storage.
//! When `nullptr`, the required allocation size is written to
Expand Down Expand Up @@ -1231,6 +1258,9 @@ struct DeviceScan
//! @tparam InitValueT
//! **[inferred]** Type of the `init_value`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in] d_temp_storage
//! Device-accessible allocation of temporary storage.
//! When `nullptr`, the required allocation size is written to
Expand Down Expand Up @@ -1375,6 +1405,9 @@ struct DeviceScan
//! @tparam ScanOp
//! **[inferred]** Binary scan functor type having member `T operator()(const T &a, const T &b)`
//!
//! @tparam NumItemsT
//! **[inferred]** An integral type representing the number of input elements
//!
//! @param[in]
//! d_temp_storage Device-accessible allocation of temporary storage.
//! When `nullptr`, the required allocation size is written to
Expand Down

0 comments on commit 7672dff

Please sign in to comment.