Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit b5126d6

Browse files
committed
Fix scan by key docs for in-place execution
1 parent d261949 commit b5126d6

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

Diff for: thrust/scan.h

+14-14
Original file line numberDiff line numberDiff line change
@@ -679,7 +679,7 @@ template<typename InputIterator,
679679
* and if \c x and \c y are objects of \c OutputIterator's \c value_type, then
680680
* <tt>binary_op(x,y)</tt> is defined.
681681
*
682-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
682+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
683683
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
684684
*
685685
* The following code snippet demonstrates how to use \p inclusive_scan_by_key using the \p thrust::host
@@ -748,7 +748,7 @@ __host__ __device__
748748
* and if \c x and \c y are objects of \c OutputIterator's \c value_type, then
749749
* <tt>binary_op(x,y)</tt> is defined.
750750
*
751-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
751+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
752752
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
753753
*
754754
* The following code snippet demonstrates how to use \p inclusive_scan_by_key
@@ -817,7 +817,7 @@ template<typename InputIterator1,
817817
* <tt>binary_op(x,y)</tt> is defined.
818818
* \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
819819
*
820-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
820+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
821821
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
822822
*
823823
* The following code snippet demonstrates how to use \p inclusive_scan_by_key using the \p thrust::host
@@ -893,7 +893,7 @@ __host__ __device__
893893
* <tt>binary_op(x,y)</tt> is defined.
894894
* \tparam BinaryPredicate is a model of <a href="https://en.cppreference.com/w/cpp/named_req/BinaryPredicate">Binary Predicate</a>.
895895
*
896-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
896+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
897897
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
898898
*
899899
* The following code snippet demonstrates how to use \p inclusive_scan_by_key
@@ -971,7 +971,7 @@ template<typename InputIterator1,
971971
* and \c AssociativeOperator's \c result_type is
972972
* convertible to \c OutputIterator's \c value_type.
973973
*
974-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
974+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
975975
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
976976
*
977977
* The following code snippet demonstrates how to use \p inclusive_scan_by_key using the \p thrust::host
@@ -1054,7 +1054,7 @@ __host__ __device__
10541054
* and \c AssociativeOperator's \c result_type is
10551055
* convertible to \c OutputIterator's \c value_type.
10561056
*
1057-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1057+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
10581058
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
10591059
*
10601060
* The following code snippet demonstrates how to use \p inclusive_scan_by_key
@@ -1120,7 +1120,7 @@ template<typename InputIterator1,
11201120
* \param first2 The beginning of the input value sequence.
11211121
* \param result The beginning of the output value sequence.
11221122
*
1123-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1123+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
11241124
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
11251125
*
11261126
* The following code snippet demonstrates how to use \p exclusive_scan_by_key using the
@@ -1180,7 +1180,7 @@ __host__ __device__
11801180
* \param first2 The beginning of the input value sequence.
11811181
* \param result The beginning of the output value sequence.
11821182
*
1183-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1183+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
11841184
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
11851185
*
11861186
* The following code snippet demonstrates how to use \p exclusive_scan_by_key.
@@ -1232,7 +1232,7 @@ template<typename InputIterator1,
12321232
* \param init The initial of the exclusive sum value.
12331233
* \return The end of the output sequence.
12341234
*
1235-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1235+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
12361236
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
12371237
*
12381238
* The following code snippet demonstrates how to use \p exclusive_scan_by_key using the \p
@@ -1293,7 +1293,7 @@ __host__ __device__
12931293
* \param init The initial of the exclusive sum value.
12941294
* \return The end of the output sequence.
12951295
*
1296-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1296+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
12971297
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
12981298
*
12991299
* The following code snippet demonstrates how to use \p exclusive_scan_by_key
@@ -1357,7 +1357,7 @@ template<typename InputIterator1,
13571357
* \param binary_pred The binary predicate used to determine equality of keys.
13581358
* \return The end of the output sequence.
13591359
*
1360-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1360+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
13611361
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
13621362
*
13631363
* The following code snippet demonstrates how to use \p exclusive_scan_by_key using the
@@ -1428,7 +1428,7 @@ __host__ __device__
14281428
* \param binary_pred The binary predicate used to determine equality of keys.
14291429
* \return The end of the output sequence.
14301430
*
1431-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1431+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
14321432
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
14331433
*
14341434
* The following code snippet demonstrates how to use \p exclusive_scan_by_key
@@ -1513,7 +1513,7 @@ template<typename InputIterator1,
15131513
* \tparam AssociativeOperator is a model of <a href="https://en.cppreference.com/w/cpp/utility/functional/binary_function">Binary Function</a>
15141514
* and \c AssociativeOperator's \c result_type is convertible to \c OutputIterator's \c value_type.
15151515
*
1516-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1516+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
15171517
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
15181518
*
15191519
* The following code snippet demonstrates how to use \p exclusive_scan_by_key using the
@@ -1603,7 +1603,7 @@ __host__ __device__
16031603
* \tparam AssociativeOperator is a model of <a href="https://en.cppreference.com/w/cpp/utility/functional/binary_function">Binary Function</a>
16041604
* and \c AssociativeOperator's \c result_type is convertible to \c OutputIterator's \c value_type.
16051605
*
1606-
* \pre \p first1 may equal \p result but the range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
1606+
* \pre The range <tt>[first1, last1)</tt> and the range <tt>[result, result + (last1 - first1))</tt> shall not overlap in any way.
16071607
* \pre \p first2 may equal \p result but the range <tt>[first2, first2 + (last1 - first1)</tt> and range <tt>[result, result + (last1 - first1))</tt> shall not overlap otherwise.
16081608
*
16091609
* The following code snippet demonstrates how to use \p exclusive_scan_by_key

0 commit comments

Comments
 (0)