diff --git a/include/cuco/detail/open_addressing_impl.cuh b/include/cuco/detail/open_addressing_impl.cuh index 4cc79084d..556f821d4 100644 --- a/include/cuco/detail/open_addressing_impl.cuh +++ b/include/cuco/detail/open_addressing_impl.cuh @@ -139,12 +139,16 @@ class open_addressing_impl { /** * @brief Constructs a statically-sized open addressing data structure with the number of elements - * to insert, sentinel values, the desired load factor and CUDA stream - * - * @note The actual capacity depends on the given `n`, the probing scheme, CG size, the desired - * load factor and the window size and it is computed via the `make_window_extent` factory. Insert - * operations will not automatically grow the container. Attempting to insert more unique keys - * than the capacity of the container results in undefined behavior. + * to insert `n`, the desired load factor, etc. + * + * @note This constructor helps users create a data structure based on the number of elements to + * insert and the desired load factor without manually computing the desired capacity. The actual + * capacity will be a size no smaller than `ceil(n / desired_load_factor)`. It's determined by + * multiple factors including the given `n`, the desired load factor, the probing scheme, the CG + * size, and the window size and is computed via the `make_window_extent` factory. + * @note Insert operations will not automatically grow the container. + * @note Attempting to insert more unique keys than the capacity of the container results in + * undefined behavior. * @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert * this sentinel value. * @note This constructor doesn't synchronize the given stream. diff --git a/include/cuco/static_map.cuh b/include/cuco/static_map.cuh index 9dd861683..4db0d43e7 100644 --- a/include/cuco/static_map.cuh +++ b/include/cuco/static_map.cuh @@ -183,14 +183,17 @@ class static_map { cuda_stream_ref stream = {}); /** - * @brief Constructs a statically-sized map with the number of elements to insert, sentinel - * values, the desired load factor, and CUDA stream - * - * The actual map capacity depends on the given `n`, the probing scheme, CG size, the desired load - * factor and the window size and it is computed via the `make_window_extent` factory. Insert - * operations will not automatically grow the map. Attempting to insert more unique keys than the - * capacity of the map results in undefined behavior. - * + * @brief Constructs a statically-sized map with the number of elements to insert `n`, the desired + * load factor, etc + * + * @note This constructor helps users create a map based on the number of elements to insert and + * the desired load factor without manually computing the desired capacity. The actual map + * capacity will be a size no smaller than `ceil(n / desired_load_factor)`. It's determined by + * multiple factors including the given `n`, the desired load factor, the probing scheme, the CG + * size, and the window size and is computed via the `make_window_extent` factory. + * @note Insert operations will not automatically grow the container. + * @note Attempting to insert more unique keys than the capacity of the container results in + * undefined behavior. * @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert * this sentinel value. * @note This constructor doesn't synchronize the given stream. diff --git a/include/cuco/static_set.cuh b/include/cuco/static_set.cuh index e6462b1df..6d48d5dc8 100644 --- a/include/cuco/static_set.cuh +++ b/include/cuco/static_set.cuh @@ -156,14 +156,17 @@ class static_set { cuda_stream_ref stream = {}); /** - * @brief Constructs a statically-sized set with the specified initial capacity, sentinel values, - * the desired load factor, and CUDA stream - * - * The actual set capacity depends on the given `n`, the probing scheme, CG size, the desired load - * factor and the window size and it is computed via the `make_window_extent` factory. Insert - * operations will not automatically grow the set. Attempting to insert more unique keys than the - * capacity of the map results in undefined behavior. - * + * @brief Constructs a statically-sized map with the number of elements to insert `n`, the desired + * load factor, etc + * + * @note This constructor helps users create a set based on the number of elements to insert and + * the desired load factor without manually computing the desired capacity. The actual set + * capacity will be a size no smaller than `ceil(n / desired_load_factor)`. It's determined by + * multiple factors including the given `n`, the desired load factor, the probing scheme, the CG + * size, and the window size and is computed via the `make_window_extent` factory. + * @note Insert operations will not automatically grow the container. + * @note Attempting to insert more unique keys than the capacity of the container results in + * undefined behavior. * @note Any `*_sentinel`s are reserved and behavior is undefined when attempting to insert * this sentinel value. * @note This constructor doesn't synchronize the given stream.