Address review feedback

Author: miscco

libcudacxx/include/cuda/__iterator/discard_iterator.h

@@ -47,31 +47,16 @@ _LIBCUDACXX_BEGIN_NAMESPACE_CUDA
 //!
 //! int main()
 //! {
-//!   thrust::device_vector<int> keys(7), values(7);
-//!
-//!   keys[0] = 1;
-//!   keys[1] = 3;
-//!   keys[2] = 3;
-//!   keys[3] = 3;
-//!   keys[4] = 2;
-//!   keys[5] = 2;
-//!   keys[6] = 1;
-//!
-//!   values[0] = 9;
-//!   values[1] = 8;
-//!   values[2] = 7;
-//!   values[3] = 6;
-//!   values[4] = 5;
-//!   values[5] = 4;
-//!   values[6] = 3;
+//!   thrust::device_vector<int> keys{1, 3, 3, 3, 2, 2, 1};
+//!   thrust::device_vector<int> values{9, 8, 7, 6, 5, 4, 3};
 //!
 //!   thrust::device_vector<int> result(4);
 //!
 //!   // we are only interested in the reduced values
 //!   // use discard_iterator to ignore the output keys
 //!   thrust::reduce_by_key(keys.begin(), keys.end(),
 //!                         values.begin(),
-//!                         cuda::make_discard_iterator(),
+//!                         cuda::discard_iterator{},
 //!                         result.begin());
 //!
 //!   // result is now [9, 21, 9, 3]
@@ -82,7 +67,7 @@ _LIBCUDACXX_BEGIN_NAMESPACE_CUDA
 class discard_iterator
 {
 private:
-  _CUDA_VSTD::ptrdiff_t __counter_ = 0;
+  _CUDA_VSTD::ptrdiff_t __index_ = 0;
 
   struct __discard_proxy
   {
@@ -102,21 +87,21 @@ class discard_iterator
   using pointer           = void*;
   using reference         = void;
 
-  //! @brief Default constructs a \p discard_iterator with a value initialized counter
+  //! @brief Default constructs a \p discard_iterator at index zero
   _CCCL_HIDE_FROM_ABI constexpr discard_iterator() = default;
 
-  //! @brief Constructs a \p discard_iterator with a given \p __counter
-  //! @param __counter The counter used for the discard iterator
+  //! @brief Constructs a \p discard_iterator with a given \p __index
+  //! @param __index The index used for the discard iterator
   _CCCL_TEMPLATE(class _Integer)
   _CCCL_REQUIRES(_CUDA_VSTD::__integer_like<_Integer>)
-  _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator(_Integer __counter) noexcept
-      : __counter_(static_cast<_CUDA_VSTD::ptrdiff_t>(__counter))
+  _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator(_Integer __index) noexcept
+      : __index_(static_cast<_CUDA_VSTD::ptrdiff_t>(__index))
   {}
 
-  //! @brief Returns the stored counter
-  [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr difference_type count() const noexcept
+  //! @brief Returns the stored index
+  [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr difference_type index() const noexcept
   {
-    return __counter_;
+    return __index_;
   }
 
   //! @brief Dereferences the \c discard_iterator returning a proxy that discards all values that are assigned to it
@@ -131,41 +116,41 @@ class discard_iterator
     return {};
   }
 
-  //! @brief Increments the stored counter
+  //! @brief Increments the stored index
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator& operator++() noexcept
   {
-    ++__counter_;
+    ++__index_;
     return *this;
   }
 
-  //! @brief Increments the stored counter
+  //! @brief Increments the stored index
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator operator++(int) noexcept
   {
     discard_iterator __tmp = *this;
-    ++__counter_;
+    ++__index_;
     return __tmp;
   }
 
-  //! @brief Decrements the stored counter
+  //! @brief Decrements the stored index
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator& operator--() noexcept
   {
-    --__counter_;
+    --__index_;
     return *this;
   }
 
-  //! @brief Decrements the stored counter
+  //! @brief Decrements the stored index
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator operator--(int) noexcept
   {
     discard_iterator __tmp = *this;
-    --__counter_;
+    --__index_;
     return __tmp;
   }
 
   //! @brief Returns a copy of this \c discard_iterator advanced by \p __n
   //! @param __n The number of elements to advance
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator operator+(difference_type __n) const noexcept
   {
-    return discard_iterator{__counter_ + __n};
+    return discard_iterator{__index_ + __n};
   }
 
   //! @brief Returns a copy of \p __x advanced by \p __n
@@ -177,179 +162,178 @@ class discard_iterator
     return __x + __n;
   }
 
-  //! @brief Advances this \c discard_iterator by \p __n
+  //! @brief Advances the index of this \c discard_iterator by \p __n
   //! @param __n The number of elements to advance
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator& operator+=(difference_type __n) noexcept
   {
-    __counter_ += __n;
+    __index_ += __n;
     return *this;
   }
 
   //! @brief Returns a copy of this \c discard_iterator decremented by \p __n
   //! @param __n The number of elements to decrement
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator operator-(difference_type __n) const noexcept
   {
-    return discard_iterator{__counter_ - __n};
+    return discard_iterator{__index_ - __n};
   }
 
   //! @brief Returns the distance between \p __lhs and \p __rhs
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return __rhs.__counter_ - __lhs.__counter_
+  //! @return __rhs.__index_ - __lhs.__index_
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr difference_type
   operator-(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __rhs.__counter_ - __lhs.__counter_;
+    return __rhs.__index_ - __lhs.__index_;
   }
 
   //! @brief Returns the distance between \p __lhs a \p default_sentinel
   //! @param __lhs The left \c discard_iterator
-  //! @return -__lhs.__counter_
+  //! @return -__lhs.__index_
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr difference_type
   operator-(const discard_iterator& __lhs, _CUDA_VSTD::default_sentinel_t) noexcept
   {
-    return static_cast<difference_type>(-__lhs.__counter_);
+    return static_cast<difference_type>(-__lhs.__index_);
   }
 
   //! @brief Returns the distance between a \p default_sentinel and \p __rhs
   //! @param __rhs The right \c discard_iterator
-  //! @return __rhs.__coutner_
+  //! @return __rhs.__index_
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr difference_type
   operator-(_CUDA_VSTD::default_sentinel_t, const discard_iterator& __rhs) noexcept
   {
-    return static_cast<difference_type>(__rhs.__counter_);
+    return static_cast<difference_type>(__rhs.__index_);
   }
 
-  //! @brief Decrements the \c discard_iterator by \p __n
+  //! @brief Decrements the index of the \c discard_iterator by \p __n
   //! @param __n The number of elements to decrement
   _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator& operator-=(difference_type __n) noexcept
   {
-    __counter_ -= __n;
+    __index_ -= __n;
     return *this;
   }
 
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for equality
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if both iterators store the same counter
+  //! @return true if both iterators store the same index
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator==(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ == __rhs.__counter_;
+    return __lhs.__index_ == __rhs.__index_;
   }
 
 #if _CCCL_STD_VER <= 2017
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for inequality
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if both iterators store different counters
+  //! @return true if both iterators store different indexs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator!=(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ != __rhs.__counter_;
+    return __lhs.__index_ != __rhs.__index_;
   }
 #endif // _CCCL_STD_VER <= 2017
 
   //! @brief Compares a \c discard_iterator \p __lhs with \p default_sentinel for equality
   //! @param __lhs The left \c discard_iterator
-  //! @return true if the counter of \p __lhs is zero
+  //! @return true if the index of \p __lhs is zero
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator==(const discard_iterator& __lhs, _CUDA_VSTD::default_sentinel_t) noexcept
   {
-    return __lhs.__counter_ == 0;
+    return __lhs.__index_ == 0;
   }
 
 #if _CCCL_STD_VER <= 2017
   //! @brief Compares a \c discard_iterator \p __rhs with \p default_sentinel for equality
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter of \p __rhs is zero
+  //! @return true if the index of \p __rhs is zero
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator==(_CUDA_VSTD::default_sentinel_t, const discard_iterator& __rhs) noexcept
   {
-    return __rhs.__counter_ == 0;
+    return __rhs.__index_ == 0;
   }
 
   //! @brief Compares a \c discard_iterator \p __rhs with \p default_sentinel for inequality
   //! @param __lhs The right \c discard_iterator
-  //! @return true if the counter of \p __lhs is not zero
+  //! @return true if the index of \p __lhs is not zero
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator!=(const discard_iterator& __lhs, _CUDA_VSTD::default_sentinel_t) noexcept
   {
-    return __lhs.__counter_ != 0;
+    return __lhs.__index_ != 0;
   }
 
   //! @brief Compares a \c discard_iterator \p __rhs with \p default_sentinel for inequality
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter of \p __rhs is not zero
+  //! @return true if the index of \p __rhs is not zero
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator!=(_CUDA_VSTD::default_sentinel_t, const discard_iterator& __rhs) noexcept
   {
-    return __rhs.__counter_ != 0;
+    return __rhs.__index_ != 0;
   }
 #endif // _CCCL_STD_VER <= 2017
 
 #if _LIBCUDACXX_HAS_SPACESHIP_OPERATOR()
   //! @brief Three-way-compares two \c discard_iterator \p __lhs and \p __rhs
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return the three-way ordering of the counters stored by \p __lhs and \p __rhs
+  //! @return the three-way ordering of the indexs stored by \p __lhs and \p __rhs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr strong_ordering
   operator<=>(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ <=> __rhs.__counter_;
+    return __lhs.__index_ <=> __rhs.__index_;
   }
 #endif // _LIBCUDACXX_HAS_SPACESHIP_OPERATOR()
 
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for less than
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter stored by \p __lhs compares less than the one stored by \p __rhs
+  //! @return true if the index stored by \p __lhs compares less than the one stored by \p __rhs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator<(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ < __rhs.__counter_;
+    return __lhs.__index_ < __rhs.__index_;
   }
 
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for less equal
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter stored by \p __lhs compares less equal the one stored by \p __rhs
+  //! @return true if the index stored by \p __lhs compares less equal the one stored by \p __rhs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator<=(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ <= __rhs.__counter_;
+    return __lhs.__index_ <= __rhs.__index_;
   }
 
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for greater than
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter stored by \p __lhs compares less greater the one stored by \p __rhs
+  //! @return true if the index stored by \p __lhs compares less greater the one stored by \p __rhs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator>(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ > __rhs.__counter_;
+    return __lhs.__index_ > __rhs.__index_;
   }
 
   //! @brief Compares two \c discard_iterator \p __lhs and \p __rhs for greater equal
   //! @param __lhs The left \c discard_iterator
   //! @param __rhs The right \c discard_iterator
-  //! @return true if the counter stored by \p __lhs compares greater equal the one stored by \p __rhs
+  //! @return true if the index stored by \p __lhs compares greater equal the one stored by \p __rhs
   [[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI friend constexpr bool
   operator>=(const discard_iterator& __lhs, const discard_iterator& __rhs) noexcept
   {
-    return __lhs.__counter_ >= __rhs.__counter_;
+    return __lhs.__index_ >= __rhs.__index_;
   }
 };
 
-//! @brief Creates a \p discard_iterator from an optional counter.
-//! @param __counter The index of the returned \p discard_iterator within a range. In the default case, the value of
-//! this parameter is \c 0.
-//! @return A new \p discard_iterator with \p __counter as the couner.
+//! @brief Creates a \p discard_iterator from an optional index.
+//! @param __index The index of the \p discard_iterator within a range. The default index is \c 0.
+//! @return A new \p discard_iterator with \p __index as the couner.
 _CCCL_TEMPLATE(class _Integer = _CUDA_VSTD::ptrdiff_t)
 _CCCL_REQUIRES(_CUDA_VSTD::__integer_like<_Integer>)
-[[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator make_discard_iterator(_Integer __counter = 0)
+[[nodiscard]] _LIBCUDACXX_HIDE_FROM_ABI constexpr discard_iterator make_discard_iterator(_Integer __index = 0)
 {
-  return discard_iterator{__counter};
+  return discard_iterator{__index};
 }
 
 _LIBCUDACXX_END_NAMESPACE_CUDA

libcudacxx/test/libcudacxx/cuda/iterators/discard_iterator/decrement.pass.cpp

@@ -17,10 +17,10 @@
 
 __host__ __device__ constexpr bool test()
 {
-  const int counter = 3;
-  cuda::discard_iterator iter(counter);
-  assert(iter-- == cuda::discard_iterator(counter + 0));
-  assert(--iter == cuda::discard_iterator(counter - 2));
+  const int index = 3;
+  cuda::discard_iterator iter(index);
+  assert(iter-- == cuda::discard_iterator(index + 0));
+  assert(--iter == cuda::discard_iterator(index - 2));
 
   static_assert(cuda::std::is_same_v<decltype(iter--), cuda::discard_iterator>);
   static_assert(cuda::std::is_same_v<decltype(--iter), cuda::discard_iterator&>);

libcudacxx/test/libcudacxx/cuda/iterators/discard_iterator/deref.pass.cpp

@@ -19,14 +19,14 @@
 __host__ __device__ constexpr bool test()
 {
   {
-    const int counter = 2;
-    cuda::discard_iterator iter(counter);
+    const int index = 2;
+    cuda::discard_iterator iter(index);
     *iter = 42;
   }
 
   {
-    const int counter = 2;
-    const cuda::discard_iterator iter(counter);
+    const int index = 2;
+    const cuda::discard_iterator iter(index);
     *iter = 42;
   }
 

libcudacxx/test/libcudacxx/cuda/iterators/discard_iterator/increment.pass.cpp

@@ -17,11 +17,11 @@
 
 __host__ __device__ constexpr bool test()
 {
-  const int counter = 2;
-  cuda::discard_iterator iter(counter);
+  const int index = 2;
+  cuda::discard_iterator iter(index);
 
-  assert(iter++ == cuda::discard_iterator(counter + 0));
-  assert(++iter == cuda::discard_iterator(counter + 2));
+  assert(iter++ == cuda::discard_iterator(index + 0));
+  assert(++iter == cuda::discard_iterator(index + 2));
 
   static_assert(cuda::std::is_same_v<decltype(iter++), cuda::discard_iterator>);
   static_assert(cuda::std::is_same_v<decltype(++iter), cuda::discard_iterator&>);