Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
Co-authored-by: Yunsong Wang <[email protected]>
  • Loading branch information
sleeepyjack and PointKernel authored Sep 30, 2024
1 parent 446e6bb commit d8c21fa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ We plan to add many GPU-accelerated, concurrent data structures to `cuCollection

### `bloom_filter`

`cuco::bloom_filter` implements a Blocked Bloom filter for approximate set membership queries.
`cuco::bloom_filter` implements a Blocked Bloom Filter for approximate set membership queries.

#### Examples:
- [Host-bulk APIs](https://github.com/NVIDIA/cuCollections/blob/dev/examples/bloom_filter/host_bulk_example.cu) (see [live example in godbolt](https://godbolt.org/z/EY7T5v5aE))
Expand Down
6 changes: 3 additions & 3 deletions include/cuco/bloom_filter.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class bloom_filter {
/**
* @brief Non-owning filter ref type
*
* @tparam NewScope Thead scope of the to be updated ref type
* @tparam NewScope Thread scope of the to be updated ref type
*/
template <cuda::thread_scope NewScope = Scope>
using ref_type = bloom_filter_ref<Key, Extent, NewScope, Policy>;
Expand Down Expand Up @@ -126,7 +126,7 @@ class bloom_filter {
* @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 = {});

Expand Down Expand Up @@ -155,7 +155,7 @@ class bloom_filter {
__host__ constexpr void add(InputIt first, InputIt last, cuda::stream_ref stream = {});

/**
* @brief Asynchrounously adds all keys in the range `[first, last)` to the filter.
* @brief Asynchronously adds all keys in the range `[first, last)` to the filter.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
Expand Down
6 changes: 3 additions & 3 deletions include/cuco/bloom_filter_ref.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class bloom_filter_ref {
__host__ constexpr void add(InputIt first, InputIt last, cuda::stream_ref stream = {});

/**
* @brief Asynchrounously adds all keys in the range `[first, last)` to the filter.
* @brief Asynchronously adds all keys in the range `[first, last)` to the filter.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
Expand Down Expand Up @@ -207,7 +207,7 @@ class bloom_filter_ref {
/**
* @brief Device function that tests if a key's fingerprint is present in the filter.
*
* @tparam ProbeKey Input type that is implicitly convertible to `key_type`
* @tparam ProbeKey Probe key type
*
* @param key The key to be tested
*
Expand Down Expand Up @@ -367,7 +367,7 @@ class bloom_filter_ref {
[[nodiscard]] __host__ __device__ constexpr extent_type block_extent() const noexcept;

private:
impl_type impl_; ///< Object containing the Blocked Bloom filter implementation
impl_type impl_; ///< Object containing the Blocked Bloom Filter implementation
};
} // namespace cuco

Expand Down

0 comments on commit d8c21fa

Please sign in to comment.