Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardmgruber committed Jan 8, 2025
1 parent a6c8e2e commit cfbbb24
Show file tree
Hide file tree
Showing 25 changed files with 260 additions and 327 deletions.
20 changes: 11 additions & 9 deletions thrust/thrust/adjacent_difference.h
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down Expand Up @@ -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".
Expand Down
8 changes: 4 additions & 4 deletions thrust/thrust/copy.h
Original file line number Diff line number Diff line change
Expand Up @@ -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>.
Expand Down Expand Up @@ -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>.
Expand Down Expand Up @@ -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>.
*
Expand Down Expand Up @@ -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>.
*
Expand Down
4 changes: 2 additions & 2 deletions thrust/thrust/count.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions thrust/thrust/equal.h
Original file line number Diff line number Diff line change
Expand Up @@ -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>.
*
Expand Down Expand Up @@ -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>.
*
Expand Down
34 changes: 17 additions & 17 deletions thrust/thrust/extrema.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Expand Down
23 changes: 9 additions & 14 deletions thrust/thrust/for_each.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ THRUST_NAMESPACE_BEGIN
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">Input
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's \c argument_type. \tparam
* UnaryFunction is a model of <a href="https://en.cppreference.com/w/cpp/utility/functional/unary_function">Unary
* Function</a>, and \p UnaryFunction does not apply any non-constant operation through its argument.
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's argument type. \tparam
* UnaryFunction does not apply any non-constant operation through its argument.
*
* The following code snippet demonstrates how to use \p for_each to print the elements
* of a \p thrust::device_vector using the \p thrust::device parallelization policy:
Expand Down Expand Up @@ -115,10 +114,8 @@ _CCCL_HOST_DEVICE InputIterator for_each(
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">Input
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's \c argument_type. \tparam
* Size is an integral type. \tparam UnaryFunction is a model of <a
* href="https://en.cppreference.com/w/cpp/utility/functional/unary_function">Unary Function</a>, and \p UnaryFunction
* does not apply any non-constant operation through its argument.
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's argument type. \tparam
* Size is an integral type. \tparam UnaryFunction does not apply any non-constant operation through its argument.
*
* The following code snippet demonstrates how to use \p for_each_n to print the elements
* of a \p device_vector using the \p thrust::device parallelization policy.
Expand Down Expand Up @@ -169,9 +166,8 @@ _CCCL_HOST_DEVICE InputIterator for_each_n(
* \return last
*
* \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">Input
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's \c argument_type. \tparam
* UnaryFunction is a model of <a href="https://en.cppreference.com/w/cpp/utility/functional/unary_function">Unary
* Function</a>, and \p UnaryFunction does not apply any non-constant operation through its argument.
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's argument type.
* \tparam UnaryFunction does not apply any non-constant operation through its argument.
*
* The following code snippet demonstrates how to use \p for_each to print the elements
* of a \p device_vector.
Expand Down Expand Up @@ -219,10 +215,9 @@ InputIterator for_each(InputIterator first, InputIterator last, UnaryFunction f)
* \return <tt>first + n</tt>
*
* \tparam InputIterator is a model of <a href="https://en.cppreference.com/w/cpp/named_req/InputIterator">Input
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's \c argument_type. \tparam
* Size is an integral type. \tparam UnaryFunction is a model of <a
* href="https://en.cppreference.com/w/cpp/utility/functional/unary_function">Unary Function</a>, and \p UnaryFunction
* does not apply any non-constant operation through its argument.
* Iterator</a>, and \p InputIterator's \c value_type is convertible to \p UnaryFunction's argument type. \tparam
* Size is an integral type.
* \tparam UnaryFunction does not apply any non-constant operation through its argument.
*
* The following code snippet demonstrates how to use \p for_each_n to print the elements
* of a \p device_vector.
Expand Down
Loading

0 comments on commit cfbbb24

Please sign in to comment.