Skip to content

Commit

Permalink
Fix docs regarding stream description
Browse files Browse the repository at this point in the history
  • Loading branch information
@sleeepyjack
sleeepyjack committed Oct 1, 2024
1 parent 85ff60b commit 95a0221
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
18 changes: 9 additions & 9 deletions include/cuco/bloom_filter.cuh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ class bloom_filter {
/**
* @brief Asynchronously erases all information from the filter.
*
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
__host__ constexpr void clear_async(cuda::stream_ref stream = {});

Expand All @@ -145,7 +145,7 @@ class bloom_filter {
* @tparam InputIt Device-accessible random access input key iterator
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt>
__host__ constexpr void add(InputIt first, InputIt last, cuda::stream_ref stream = {});
Expand All @@ -157,7 +157,7 @@ class bloom_filter {
*
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt>
__host__ constexpr void add_async(InputIt first, InputIt last, cuda::stream_ref stream = {});
Expand All @@ -181,7 +181,7 @@ class bloom_filter {
* @param stencil Beginning of the stencil sequence
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate>
__host__ constexpr void add_if(
Expand All @@ -204,7 +204,7 @@ class bloom_filter {
* @param stencil Beginning of the stencil sequence
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate>
__host__ constexpr void add_if_async(InputIt first,
Expand All @@ -226,7 +226,7 @@ class bloom_filter {
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class OutputIt>
__host__ constexpr void contains(InputIt first,
Expand All @@ -244,7 +244,7 @@ class bloom_filter {
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class OutputIt>
__host__ constexpr void contains_async(InputIt first,
Expand Down Expand Up @@ -273,7 +273,7 @@ class bloom_filter {
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate, class OutputIt>
__host__ constexpr void contains_if(InputIt first,
Expand Down Expand Up @@ -302,7 +302,7 @@ class bloom_filter {
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate, class OutputIt>
__host__ constexpr void contains_if_async(InputIt first,
Expand Down
20 changes: 10 additions & 10 deletions include/cuco/bloom_filter_ref.cuh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ class bloom_filter_ref {
* @note This function synchronizes the given stream. For asynchronous execution use
* `clear_async`.
*
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
__host__ constexpr void clear(cuda::stream_ref stream = {});

/**
* @brief Asynchronously erases all information from the filter.
*
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
__host__ constexpr void clear_async(cuda::stream_ref stream = {});

Expand Down Expand Up @@ -128,7 +128,7 @@ class bloom_filter_ref {
*
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt>
__host__ constexpr void add(InputIt first, InputIt last, cuda::stream_ref stream = {});
Expand All @@ -140,7 +140,7 @@ class bloom_filter_ref {
*
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt>
__host__ constexpr void add_async(InputIt first, InputIt last, cuda::stream_ref stream = {});
Expand All @@ -164,7 +164,7 @@ class bloom_filter_ref {
* @param stencil Beginning of the stencil sequence
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate>
__host__ constexpr void add_if(
Expand All @@ -187,7 +187,7 @@ class bloom_filter_ref {
* @param stencil Beginning of the stencil sequence
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate>
__host__ constexpr void add_if_async(InputIt first,
Expand Down Expand Up @@ -245,7 +245,7 @@ class bloom_filter_ref {
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class OutputIt>
__host__ constexpr void contains(InputIt first,
Expand All @@ -265,7 +265,7 @@ class bloom_filter_ref {
* @param first Beginning of the sequence of keys
* @param last End of the sequence of keys
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class OutputIt>
__host__ constexpr void contains_async(InputIt first,
Expand Down Expand Up @@ -296,7 +296,7 @@ class bloom_filter_ref {
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate, class OutputIt>
__host__ constexpr void contains_if(InputIt first,
Expand Down Expand Up @@ -327,7 +327,7 @@ class bloom_filter_ref {
* @param pred Predicate to test on every element in the range `[stencil, stencil +
* std::distance(first, last))`
* @param output_begin Beginning of the sequence of booleans for the presence of each key
* @param stream CUDA stream this operation is executed in
* @param stream CUDA stream used for device memory operations and kernel launches
*/
template <class InputIt, class StencilIt, class Predicate, class OutputIt>
__host__ constexpr void contains_if_async(InputIt first,
Expand Down

0 comments on commit 95a0221

Please sign in to comment.