Update docs

NVIDIA · Oct 11, 2023 · bf38640 · bf38640
1 parent dcb0536
commit bf38640
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 30 deletions.
diff --git a/include/cuco/detail/open_addressing/open_addressing_impl.cuh b/include/cuco/detail/open_addressing/open_addressing_impl.cuh
@@ -541,17 +541,18 @@ class open_addressing_impl {
   }
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Regenerates the container
    *
-   * @note This function synchronizes the given stream.
+   * @note This function synchronizes the given stream. For asynchronous execution use
+   * `rehash_async`.
    *
    * @tparam Container The container type this function operates on
    * @tparam Predicate Type of predicate indicating if the given slot is filled
    *
+   * @param extent The container's new `window_extent` after this operation took place
    * @param container The container to be rehashed
    * @param is_filled Predicate indicating if the given slot is filled
    * @param stream CUDA stream used for this operation
-   *
    */
   template <typename Container, typename Predicate>
   void rehash(Container const& container, Predicate const& is_filled, cuda_stream_ref stream)
@@ -561,11 +562,20 @@ class open_addressing_impl {
   }
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Asynchronously reserves at least the specified number of slots and regenerates the
+   * container
    *
-   * @note This function synchronizes the given stream.
-   * @note Behavior is undefined if the desired `extent` is insufficient to store all of contained
-   * elements.
+   * @note Changes the number of windows to a value that is not less than `extent`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
+   *
+   * @note This function synchronizes the given stream. For asynchronous execution use
+   * `rehash_async`.
+   *
+   * @note Behavior is undefined if the desired `extent` is insufficient to store all of the
+   * contained elements.
+   *
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @tparam Container The container type this function operates on
    * @tparam Predicate Type of predicate indicating if the given slot is filled
@@ -574,7 +584,6 @@ class open_addressing_impl {
    * @param container The container to be rehashed
    * @param is_filled Predicate indicating if the given slot is filled
    * @param stream CUDA stream used for this operation
-   *
    */
   template <typename Container, typename Predicate>
   void rehash(extent_type extent,
@@ -587,15 +596,15 @@ class open_addressing_impl {
   }
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously regenerates the container
    *
    * @tparam Container The container type this function operates on
    * @tparam Predicate Type of predicate indicating if the given slot is filled
    *
+   * @param extent The container's new `window_extent` after this operation took place
    * @param container The container to be rehashed
    * @param is_filled Predicate indicating if the given slot is filled
    * @param stream CUDA stream used for this operation
-   *
    */
   template <typename Container, typename Predicate>
   void rehash_async(Container const& container, Predicate const& is_filled, cuda_stream_ref stream)
@@ -604,10 +613,17 @@ class open_addressing_impl {
   }
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously reserves at least the specified number of slots and regenerates the
+   * container
    *
-   * @note Behavior is undefined if the desired `extent` is insufficient to store all of contained
-   * elements.
+   * @note Changes the number of windows to a value that is not less than `extent`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
+   *
+   * @note Behavior is undefined if the desired `extent` is insufficient to store all of the
+   * contained elements.
+   *
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @tparam Container The container type this function operates on
    * @tparam Predicate Type of predicate indicating if the given slot is filled
@@ -616,7 +632,6 @@ class open_addressing_impl {
    * @param container The container to be rehashed
    * @param is_filled Predicate indicating if the given slot is filled
    * @param stream CUDA stream used for this operation
-   *
    */
   template <typename Container, typename Predicate>
   void rehash_async(extent_type extent,

diff --git a/include/cuco/static_map.cuh b/include/cuco/static_map.cuh
@@ -537,7 +537,7 @@ class static_map {
                                            cuda_stream_ref stream = {}) const;
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Regenerates the container.
    *
    * @note This function synchronizes the given stream. For asynchronous execution use
    * `rehash_async`.
@@ -547,30 +547,44 @@ class static_map {
   void rehash(cuda_stream_ref stream = {});
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Reserves at least the specified number of slots and regenerates the container
+   *
+   * @note Changes the number of slots to a value that is not less than `capacity`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
    *
    * @note This function synchronizes the given stream. For asynchronous execution use
    * `rehash_async`.
-   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of contained
-   * elements.
+   *
+   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of the
+   * contained elements.
+   *
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @param capacity New capacity of the container
    * @param stream CUDA stream used for this operation
    */
   void rehash(size_type capacity, cuda_stream_ref stream = {});
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously regenerates the container.
    *
    * @param stream CUDA stream used for this operation
    */
   void rehash_async(cuda_stream_ref stream = {});
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously reserves at least the specified number of slots and regenerates the
+   * container
+   *
+   * @note Changes the number of slots to a value that is not less than `capacity`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
+   *
+   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of the
+   * contained elements.
    *
-   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of contained
-   * elements.
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @param capacity New capacity of the container
    * @param stream CUDA stream used for this operation

diff --git a/include/cuco/static_set.cuh b/include/cuco/static_set.cuh
@@ -461,7 +461,7 @@ class static_set {
   OutputIt retrieve_all(OutputIt output_begin, cuda_stream_ref stream = {}) const;
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Regenerates the container.
    *
    * @note This function synchronizes the given stream. For asynchronous execution use
    * `rehash_async`.
@@ -471,30 +471,44 @@ class static_set {
   void rehash(cuda_stream_ref stream = {});
 
   /**
-   * @brief Rebuilds the container.
+   * @brief Reserves at least the specified number of slots and regenerates the container
+   *
+   * @note Changes the number of slots to a value that is not less than `capacity`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
    *
    * @note This function synchronizes the given stream. For asynchronous execution use
    * `rehash_async`.
-   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of contained
-   * elements.
+   *
+   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of the
+   * contained elements.
+   *
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @param capacity New capacity of the container
    * @param stream CUDA stream used for this operation
    */
   void rehash(size_type capacity, cuda_stream_ref stream = {});
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously regenerates the container.
    *
    * @param stream CUDA stream used for this operation
    */
   void rehash_async(cuda_stream_ref stream = {});
 
   /**
-   * @brief Asynchonously rebuilds the container.
+   * @brief Asynchronously reserves at least the specified number of slots and regenerates the
+   * container
+   *
+   * @note Changes the number of slots to a value that is not less than `capacity`, then
+   * rehashes the container, i.e. puts the elements into appropriate slots considering
+   * that the total number of slots has changed.
+   *
+   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of the
+   * contained elements.
    *
-   * @note Behavior is undefined if the desired `capacity` is insufficient to store all of contained
-   * elements.
+   * @note This function is not available if the conatiner's `extent_type` is static.
    *
    * @param capacity New capacity of the container
    * @param stream CUDA stream used for this operation