Skip to content

Commit

Permalink
Fix doxygen warnings unveiled by newer version
Browse files Browse the repository at this point in the history
  • Loading branch information
PointKernel committed Jun 21, 2022
1 parent da62bf4 commit 6d3763e
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 20 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ into three categories:
- Post about your intended feature, and we shall discuss the design and
implementation.
- Once we agree that the plan looks good, go ahead and implement it, using
the [code contributions](#code-contributions) guide below.
the [code contributions](https://github.com/NVIDIA/cuCollections/blob/master/CONTRIBUTING.md#code-contributions) guide below.
3. You want to implement a feature or bug-fix for an outstanding issue
- Follow the [code contributions](#code-contributions) guide below.
- Follow the [code contributions](https://github.com/NVIDIA/cuCollections/blob/master/CONTRIBUTING.md#code-contributions) guide below.
- If you need more context on a particular issue, please ask and we shall
provide.

Expand Down
9 changes: 0 additions & 9 deletions doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2149,15 +2149,6 @@ EXTERNAL_PAGES = YES
# Configuration options related to the dot tool
#---------------------------------------------------------------------------

# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.

CLASS_DIAGRAMS = YES

# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
Expand Down
1 change: 1 addition & 0 deletions include/cuco/detail/hash_functions.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ struct MurmurHash3_32 {
using argument_type = Key; ///< The type of the values taken as argument
using result_type = uint32_t; ///< The type of the hash values produced

/// Default constructor
__host__ __device__ constexpr MurmurHash3_32() : MurmurHash3_32{0} {}

/**
Expand Down
27 changes: 18 additions & 9 deletions include/cuco/detail/probe_sequence_impl.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class probe_sequence_base {
static constexpr uint32_t vector_width() noexcept { return 2u; }
};

/*
/**
* @brief Base class of probe sequence implementation.
*
* Hash map operations are generally memory-bandwidth bound. A vector-load loads two consecutive
Expand All @@ -70,14 +70,17 @@ template <typename Key,
uint32_t CGSize>
class probe_sequence_impl_base {
protected:
using value_type = cuco::pair_type<Key, Value>;
using key_type = Key;
using mapped_type = Value;
using atomic_key_type = cuda::atomic<key_type, Scope>;
using atomic_mapped_type = cuda::atomic<mapped_type, Scope>;
using pair_atomic_type = cuco::pair_type<atomic_key_type, atomic_mapped_type>;
using iterator = pair_atomic_type*;
using const_iterator = pair_atomic_type const*;
using value_type = cuco::pair_type<Key, Value>; ///< Type of key/value pairs
using key_type = Key; ///< Key type
using mapped_type = Value; ///< Type of mapped values
using atomic_key_type = cuda::atomic<key_type, Scope>; ///< Type of atomic keys
using atomic_mapped_type = cuda::atomic<mapped_type, Scope>; ///< Type of atomic mapped values
/// Pair type of atomic key and atomic mapped value
using pair_atomic_type = cuco::pair_type<atomic_key_type, atomic_mapped_type>;
/// Type of the forward iterator to `pair_atomic_type`
using iterator = pair_atomic_type*;
/// Type of the forward iterator to `const pair_atomic_type`
using const_iterator = pair_atomic_type const*;

/**
* @brief Returns the number of elements loaded with each vector-load.
Expand Down Expand Up @@ -115,6 +118,8 @@ class probe_sequence_impl_base {
public:
/**
* @brief Returns the capacity of the hash map.
*
* @return The capacity of the hash map
*/
__host__ __device__ __forceinline__ std::size_t get_capacity() const noexcept
{
Expand All @@ -123,11 +128,15 @@ class probe_sequence_impl_base {

/**
* @brief Returns slots array.
*
* @return Slots array
*/
__device__ __forceinline__ iterator get_slots() noexcept { return slots_; }

/**
* @brief Returns slots array.
*
* @return Slots array
*/
__device__ __forceinline__ const_iterator get_slots() const noexcept { return slots_; }

Expand Down

0 comments on commit 6d3763e

Please sign in to comment.