Update docs

NVIDIA · Aug 22, 2024 · d42fa96 · d42fa96
1 parent 4806296
commit d42fa96
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/include/cuco/static_map.cuh b/include/cuco/static_map.cuh
@@ -953,9 +953,9 @@ class static_map {
   [[nodiscard]] constexpr key_type erased_key_sentinel() const noexcept;
 
   /**
-   * @brief Gets the key comparator.
+   * @brief Gets the function used to compare keys for equality
    *
-   * @return The comparator used to compare keys
+   * @return The function used to compare keys for equality
    */
   [[nodiscard]] constexpr key_equal key_eq() const noexcept;
 

diff --git a/include/cuco/static_multimap.cuh b/include/cuco/static_multimap.cuh
@@ -448,9 +448,9 @@ class static_multimap {
   [[nodiscard]] constexpr key_type erased_key_sentinel() const noexcept;
 
   /**
-   * @brief Gets the key comparator.
+   * @brief Gets the function used to compare keys for equality
    *
-   * @return The comparator used to compare keys
+   * @return The function used to compare keys for equality
    */
   [[nodiscard]] constexpr key_equal key_eq() const noexcept;
 

diff --git a/include/cuco/static_multiset.cuh b/include/cuco/static_multiset.cuh
@@ -571,9 +571,9 @@ class static_multiset {
   [[nodiscard]] constexpr key_type erased_key_sentinel() const noexcept;
 
   /**
-   * @brief Gets the key comparator.
+   * @brief Gets the function used to compare keys for equality
    *
-   * @return The comparator used to compare keys
+   * @return The function used to compare keys for equality
    */
   [[nodiscard]] constexpr key_equal key_eq() const noexcept;
 

diff --git a/include/cuco/static_set.cuh b/include/cuco/static_set.cuh
@@ -767,9 +767,9 @@ class static_set {
   [[nodiscard]] constexpr key_type erased_key_sentinel() const noexcept;
 
   /**
-   * @brief Gets the key comparator.
+   * @brief Gets the function used to compare keys for equality
    *
-   * @return The comparator used to compare keys
+   * @return The function used to compare keys for equality
    */
   [[nodiscard]] constexpr key_equal key_eq() const noexcept;