Skip to content

Commit

Permalink
Clarify docs regarding heterogeneous lookup
Browse files Browse the repository at this point in the history
  • Loading branch information
@sleeepyjack
sleeepyjack committed Oct 1, 2024
1 parent d11c050 commit 85ff60b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 38 deletions.
33 changes: 8 additions & 25 deletions include/cuco/bloom_filter.cuh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,7 @@ class bloom_filter {
* @note This function synchronizes the given stream. For asynchronous execution use
* `add_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
*
* @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
Expand All @@ -156,9 +153,7 @@ class bloom_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,
* bloom_filter<K>::key_type></tt> is `true`
* @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
Expand All @@ -175,9 +170,7 @@ class bloom_filter {
* @note This function synchronizes the given stream and returns the number of successful
* insertions. For asynchronous execution use `add_if_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand All @@ -200,9 +193,7 @@ class bloom_filter {
*
* @note The key `*(first + i)` is added if `pred( *(stencil + i) )` returns `true`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand All @@ -229,9 +220,7 @@ class bloom_filter {
* @note This function synchronizes the given stream. For asynchronous execution use
* `contains_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam OutputIt Device-accessible output iterator assignable from `bool`
*
* @param first Beginning of the sequence of keys
Expand All @@ -249,9 +238,7 @@ class bloom_filter {
* @brief Asynchronously tests all keys in the range `[first, last)` if their fingerprints are
* present in the filter.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam OutputIt Device-accessible output iterator assignable from `bool`
*
* @param first Beginning of the sequence of keys
Expand All @@ -273,9 +260,7 @@ class bloom_filter {
* @note This function synchronizes the given stream. For asynchronous execution use
* `contains_if_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand Down Expand Up @@ -304,9 +289,7 @@ class bloom_filter {
*
* @note The key `*(first + i)` is queried if `pred( *(stencil + i) )` returns `true`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand Down
18 changes: 5 additions & 13 deletions include/cuco/bloom_filter_ref.cuh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class bloom_filter_ref {
* @note Best performance is achieved if the size of the CG is equal to `words_per_block`.
*
* @tparam CG Cooperative Group type
* @tparam ProbeKey Input type that is implicitly convertible to `key_type`
* @tparam ProbeKey Input key type
*
* @param group The Cooperative Group this operation is executed with
* @param key The key to be added
Expand All @@ -124,9 +124,7 @@ class bloom_filter_ref {
* @note This function synchronizes the given stream. For asynchronous execution use
* `add_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @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
Expand All @@ -138,9 +136,7 @@ class bloom_filter_ref {
/**
* @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,
* bloom_filter<K>::key_type></tt> is `true`
* @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
Expand All @@ -157,9 +153,7 @@ class bloom_filter_ref {
* @note This function synchronizes the given stream and returns the number of successful
* insertions. For asynchronous execution use `add_if_async`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand All @@ -182,9 +176,7 @@ class bloom_filter_ref {
*
* @note The key `*(first + i)` is added if `pred( *(stencil + i) )` returns `true`.
*
* @tparam InputIt Device-accessible random access input iterator where
* <tt>std::is_convertible<std::iterator_traits<InputIt>::value_type,
* bloom_filter<K>::key_type></tt> is `true`
* @tparam InputIt Device-accessible random access input key iterator
* @tparam StencilIt Device-accessible random-access iterator whose `value_type` is
* convertible to Predicate's argument type
* @tparam Predicate Unary predicate callable whose return type must be convertible to `bool` and
Expand Down

0 comments on commit 85ff60b

Please sign in to comment.