Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PointKernel committed Sep 28, 2023
1 parent e134f7d commit 418a382
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
7 changes: 2 additions & 5 deletions include/cuco/static_map.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ namespace experimental {
* @tparam Allocator Type of allocator used for device storage
* @tparam Storage Slot window storage type
*/

template <class Key,
class T,
class Extent = cuco::experimental::extent<std::size_t>,
Expand Down Expand Up @@ -165,8 +164,7 @@ class static_map {
*
* @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert
* this sentinel value.
* @note If a non-default CUDA stream is provided, the caller is responsible for synchronizing the
* stream before the object is first used.
* @note This constructor doesn't synchronize the given stream.
*
* @param capacity The requested lower-bound map size
* @param empty_key_sentinel The reserved key value for empty slots
Expand Down Expand Up @@ -195,8 +193,7 @@ class static_map {
*
* @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert
* this sentinel value.
* @note If a non-default CUDA stream is provided, the caller is responsible for synchronizing the
* stream before the object is first used.
* @note This constructor doesn't synchronize the given stream.
* @note This overload will convert compile-time extents to runtime constants which might lead to
* performance regressions.
*
Expand Down
7 changes: 2 additions & 5 deletions include/cuco/static_set.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ namespace experimental {
* @tparam Allocator Type of allocator used for device storage
* @tparam Storage Slot window storage type
*/

template <class Key,
class Extent = cuco::experimental::extent<std::size_t>,
cuda::thread_scope Scope = cuda::thread_scope_device,
Expand Down Expand Up @@ -140,8 +139,7 @@ class static_set {
*
* @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert
* this sentinel value.
* @note If a non-default CUDA stream is provided, the caller is responsible for synchronizing the
* stream before the object is first used.
* @note This constructor doesn't synchronize the given stream.
*
* @param capacity The requested lower-bound set size
* @param empty_key_sentinel The reserved key value for empty slots
Expand All @@ -168,8 +166,7 @@ class static_set {
*
* @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert
* this sentinel value.
* @note If a non-default CUDA stream is provided, the caller is responsible for synchronizing the
* stream before the object is first used.
* @note This constructor doesn't synchronize the given stream.
* @note This overload will convert compile-time extents to runtime constants which might lead to
* performance regressions.
*
Expand Down

0 comments on commit 418a382

Please sign in to comment.