Doc update for cuco::arrow_filter_policy (#646)

mhaseeb123 · web-flow · commit b8429d44314a · 2024-11-26T11:24:23.000-08:00
This PR updates docstring for `cuco::arrow_filter_policy` reflecting the
recent change allowing taking in a custom `xxhash_64` hasher along with
a couple other minor changes
diff --git a/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh b/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh
@@ -40,14 +40,15 @@ namespace cuco::detail {
  * void bulk_insert_and_eval_arrow_policy_bloom_filter(device_vector<KeyType> const& positive_keys,
  *                                                 device_vector<KeyType> const& negative_keys)
  * {
- *     using policy_type = cuco::arrow_filter_policy<key_type>;
+ *     using xxhash_64 = cuco::xxhash_64<KeyType>;
+ *     using policy_type = cuco::arrow_filter_policy<KeyType, xxhash_64>;
  *
  *     // Warn or throw if the number of filter blocks is greater than maximum used by Arrow policy.
  *     static_assert(NUM_FILTER_BLOCKS <= policy_type::max_filter_blocks, "NUM_FILTER_BLOCKS must be
  *                                                                         in range: [1, 4194304]");
  *
  *     // Create a bloom filter with Arrow policy
- *     cuco::bloom_filter<key_type, cuco::extent<size_t>,
+ *     cuco::bloom_filter<KeyType, cuco::extent<size_t>,
  *         cuda::thread_scope_device, policy_type> filter{NUM_FILTER_BLOCKS};
  *
  *     // Add positive keys to the bloom filter

Original file line number	Diff line number	Diff line change
`@@ -40,14 +40,15 @@ namespace cuco::detail {`
`40`	`40`	`* void bulk_insert_and_eval_arrow_policy_bloom_filter(device_vector<KeyType> const& positive_keys,`
`41`	`41`	`* device_vector<KeyType> const& negative_keys)`
`42`	`42`	`* {`
`43`		`- * using policy_type = cuco::arrow_filter_policy<key_type>;`
	`43`	`+ * using xxhash_64 = cuco::xxhash_64<KeyType>;`
	`44`	`+ * using policy_type = cuco::arrow_filter_policy<KeyType, xxhash_64>;`
`44`	`45`	`*`
`45`	`46`	`* // Warn or throw if the number of filter blocks is greater than maximum used by Arrow policy.`
`46`	`47`	`* static_assert(NUM_FILTER_BLOCKS <= policy_type::max_filter_blocks, "NUM_FILTER_BLOCKS must be`
`47`	`48`	`* in range: [1, 4194304]");`
`48`	`49`	`*`
`49`	`50`	`* // Create a bloom filter with Arrow policy`
`50`		`- * cuco::bloom_filter<key_type, cuco::extent<size_t>,`
	`51`	`+ * cuco::bloom_filter<KeyType, cuco::extent<size_t>,`
`51`	`52`	`* cuda::thread_scope_device, policy_type> filter{NUM_FILTER_BLOCKS};`
`52`	`53`	`*`
`53`	`54`	`* // Add positive keys to the bloom filter`