Drop deprecated aliases in Thrust functional (#3272)

Fixes: #3271
NVIDIA · Jan 13, 2025 · 18b8e43 · 18b8e43
1 parent 3421002
commit 18b8e43
Show file tree

Hide file tree

Showing 33 changed files with 293 additions and 1,137 deletions.
diff --git a/docs/thrust/api_docs/function_objects/predefined.rst b/docs/thrust/api_docs/function_objects/predefined.rst
@@ -1,14 +1,12 @@
 .. _thrust-module-api-function-objects-predefined:
 
-Predefined Function Objects
-----------------------------
+Function Objects
+----------------
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
+Users are encouraged to use the standard C++ function objects available from `<cuda/std/functional>`.
+Thrust provides the following additional function objects:
 
-   predefined/arithmetic
-   predefined/bitwise
-   predefined/comparison
-   predefined/identity
-   predefined/logical
+  - :cpp:struct:`thrust::square <thrust::square>`
+  - :cpp:struct:`thrust::identity <thrust::identity>`
+  - :cpp:struct:`thrust::project1st <thrust::project1st>`
+  - :cpp:struct:`thrust::project2nd <thrust::project2nd>`
diff --git a/docs/thrust/api_docs/function_objects/predefined/arithmetic.rst b/docs/thrust/api_docs/function_objects/predefined/arithmetic.rst
diff --git a/docs/thrust/api_docs/function_objects/predefined/bitwise.rst b/docs/thrust/api_docs/function_objects/predefined/bitwise.rst
diff --git a/docs/thrust/api_docs/function_objects/predefined/comparison.rst b/docs/thrust/api_docs/function_objects/predefined/comparison.rst
diff --git a/docs/thrust/api_docs/function_objects/predefined/identity.rst b/docs/thrust/api_docs/function_objects/predefined/identity.rst
diff --git a/docs/thrust/api_docs/function_objects/predefined/logical.rst b/docs/thrust/api_docs/function_objects/predefined/logical.rst
diff --git a/thrust/thrust/adjacent_difference.h b/thrust/thrust/adjacent_difference.h
@@ -111,11 +111,12 @@ _CCCL_HOST_DEVICE OutputIterator adjacent_difference(
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p BinaryFunction's \c first_argument_type and
- * \c second_argument_type, and \p InputIterator's \c value_type is convertible to a type in \p OutputIterator's set of
+ * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p BinaryFunction's first and second argument
+ * type, and \p InputIterator's \c value_type is convertible to a type in \p OutputIterator's set of
  * \c value_types. \tparam OutputIterator is a model of <a
- * href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>. \tparam BinaryFunction's \c
- * result_type is convertible to a type in \p OutputIterator's set of \c value_types.
+ * href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>.
+ *  \tparam BinaryFunction The functions's return type convertible to a type in \p OutputIterator's set of \c
+ * value_types.
  *
  *  \remark Note that \p result is permitted to be the same iterator as \p first. This is
  *          useful for computing differences "in place".
@@ -210,11 +211,12 @@ OutputIterator adjacent_difference(InputIterator first, InputIterator last, Outp
  *  \return The iterator <tt>result + (last - first)</tt>
  *
  *  \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p BinaryFunction's \c first_argument_type and
- * \c second_argument_type, and \p InputIterator's \c value_type is convertible to a type in \p OutputIterator's set of
- * \c value_types. \tparam OutputIterator is a model of <a
- * href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>. \tparam BinaryFunction's \c
- * result_type is convertible to a type in \p OutputIterator's set of \c value_types.
+ * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p BinaryFunction's first and second argument
+ * type, and \p InputIterator's \c value_type is convertible to a type in \p OutputIterator's set of \c value_types.
+ *  \tparam OutputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output
+ * Iterator</a>.
+ *  \tparam BinaryFunction The function's return type must be convertible to a type in \p OutputIterator's
+ * set of \c value_types.
  *
  *  \remark Note that \p result is permitted to be the same iterator as \p first. This is
  *          useful for computing differences "in place".

diff --git a/thrust/thrust/copy.h b/thrust/thrust/copy.h
@@ -260,7 +260,7 @@ OutputIterator copy_n(InputIterator first, Size n, OutputIterator result);
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. \tparam
+ * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p Predicate's argument type. \tparam
  * OutputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output
  * Iterator</a>. \tparam Predicate is a model of <a
  * href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
@@ -321,7 +321,7 @@ _CCCL_HOST_DEVICE OutputIterator copy_if(
  *          evaluated to \c true in the range <tt>[first, last)</tt>.
  *
  *  \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. \tparam
+ * Iterator</a>, and \p InputIterator's \c value_type is convertible to \p Predicate's argument type. \tparam
  * OutputIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output
  * Iterator</a>. \tparam Predicate is a model of <a
  * href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
@@ -383,7 +383,7 @@ OutputIterator copy_if(InputIterator first, InputIterator last, OutputIterator r
  *  \tparam InputIterator1 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
  * Iterator</a>. \tparam InputIterator2 is a model of <a
  * href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a>, and \p InputIterator2's \c
- * value_type is convertible to \p Predicate's \c argument_type. \tparam OutputIterator is a model of <a
+ * value_type is convertible to \p Predicate's argument type. \tparam OutputIterator is a model of <a
  * href="https://en.cppreference.com/w/cpp/named_req/OutputIterator">Output Iterator</a>. \tparam Predicate is a model
  * of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
  *
@@ -456,7 +456,7 @@ _CCCL_HOST_DEVICE OutputIterator copy_if(
  *  \tparam InputIterator1 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
  * Iterator</a>. \tparam InputIterator2 is a model of <a
  * href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a>, and \p InputIterator2's \c
- * value_type is convertible to \p Predicate's \c argument_type. \tparam OutputIterator is a model of <a
+ * value_type is convertible to \p Predicate's argument type. \tparam OutputIterator is a model of <a
  * href="https://en.cppreference.com/w/cpp/named_req/OutputIterator">Output Iterator</a>. \tparam Predicate is a model
  * of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
  *

diff --git a/thrust/thrust/count.h b/thrust/thrust/count.h
@@ -148,7 +148,7 @@ count(InputIterator first, InputIterator last, const EqualityComparable& value);
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam InputIterator must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a> and \c InputIterator's \c value_type must be convertible to \c Predicate's \c argument_type. \tparam
+ * Iterator</a> and \c InputIterator's \c value_type must be convertible to \c Predicate's argument type. \tparam
  * Predicate must be a model of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p count to
@@ -200,7 +200,7 @@ count_if(const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
  *  \return The number of elements where \p pred is \c true.
  *
  *  \tparam InputIterator must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a> and \c InputIterator's \c value_type must be convertible to \c Predicate's \c argument_type. \tparam
+ * Iterator</a> and \c InputIterator's \c value_type must be convertible to \c Predicate's argument type. \tparam
  * Predicate must be a model of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p count to

diff --git a/thrust/thrust/equal.h b/thrust/thrust/equal.h
@@ -148,9 +148,9 @@ bool equal(InputIterator1 first1, InputIterator1 last1, InputIterator2 first2);
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam InputIterator1 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator1's \c value_type is convertible to \p BinaryPredicate's \c first_argument_type.
+ * Iterator</a>, and \p InputIterator1's \c value_type is convertible to \p BinaryPredicate's first argument type.
  *  \tparam InputIterator2 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator2's \c value_type is convertible to \p BinaryPredicate's \c second_argument_type.
+ * Iterator</a>, and \p InputIterator2's \c value_type is convertible to \p BinaryPredicate's second argument type.
  *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
  * Predicate</a>.
  *
@@ -204,9 +204,9 @@ equal(const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
  *  \return \c true, if the sequences are equal; \c false, otherwise.
  *
  *  \tparam InputIterator1 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator1's \c value_type is convertible to \p BinaryPredicate's \c first_argument_type.
+ * Iterator</a>, and \p InputIterator1's \c value_type is convertible to \p BinaryPredicate's first argument type.
  *  \tparam InputIterator2 is a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
- * Iterator</a>, and \p InputIterator2's \c value_type is convertible to \p BinaryPredicate's \c second_argument_type.
+ * Iterator</a>, and \p InputIterator2's \c value_type is convertible to \p BinaryPredicate's second argument type.
  *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
  * Predicate</a>.
  *

diff --git a/thrust/thrust/extrema.h b/thrust/thrust/extrema.h
@@ -289,8 +289,8 @@ ForwardIterator min_element(ForwardIterator first, ForwardIterator last);
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a
  * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p min_element to find the smallest element
@@ -353,9 +353,9 @@ _CCCL_HOST_DEVICE ForwardIterator min_element(
  *          if it is not an empty range; \p last, otherwise.
  *
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
- * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
+ * Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p min_element to find the smallest element
  *  of a collection of key-value pairs.
@@ -491,9 +491,9 @@ ForwardIterator max_element(ForwardIterator first, ForwardIterator last);
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
- * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
+ * Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p max_element to find the largest element
  *  of a collection of key-value pairs using the \p thrust::host execution policy for parallelization.
@@ -555,9 +555,9 @@ _CCCL_HOST_DEVICE ForwardIterator max_element(
  *          if it is not an empty range; \p last, otherwise.
  *
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
- * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
+ * Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p max_element to find the largest element
  *  of a collection of key-value pairs.
@@ -682,9 +682,9 @@ thrust::pair<ForwardIterator, ForwardIterator> minmax_element(ForwardIterator fi
  *
  *  \tparam DerivedPolicy The name of the derived execution policy.
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
- * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
+ * Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p minmax_element to find the smallest and largest elements
  *  of a collection of key-value pairs using the \p thrust::host execution policy for parallelization:
@@ -745,9 +745,9 @@ _CCCL_HOST_DEVICE thrust::pair<ForwardIterator, ForwardIterator> minmax_element(
  *          if it is not an empty range; \p last, otherwise.
  *
  *  \tparam ForwardIterator is a model of <a href="https://en.cppreference.com/w/cpp/iterator/forward_iterator">Forward
- * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's \c first_argument_type and \c
- * second_argument_type. \tparam BinaryPredicate is a model of <a
- * href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
+ * Iterator</a>, and \p ForwardIterator's \c value_type is convertible to both \p comp's first and second argument type.
+ *  \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary
+ * Predicate</a>.
  *
  *  The following code snippet demonstrates how to use \p minmax_element to find the smallest and largest elements
  *  of a collection of key-value pairs.