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

Add precondition to gather documentation. #1384

Merged
merged 1 commit into from
Feb 16, 2021
Merged

Add precondition to gather documentation. #1384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions thrust/gather.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ namespace thrust
* \tparam OutputIterator must be a model of <a href="http://www.sgi.com/tech/stl/OutputIterator.html">Output Iterator</a>.
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather is the inverse of thrust::scatter.
*
Expand Down Expand Up @@ -108,6 +109,7 @@ __host__ __device__
* \tparam OutputIterator must be a model of <a href="http://www.sgi.com/tech/stl/OutputIterator.html">Output Iterator</a>.
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather is the inverse of thrust::scatter.
*
Expand Down Expand Up @@ -166,6 +168,7 @@ template<typename InputIterator,
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The range <tt>[stencil, stencil + (map_last - map_first))</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather_if is the inverse of \p scatter_if.
*
Expand Down Expand Up @@ -232,6 +235,7 @@ __host__ __device__
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The range <tt>[stencil, stencil + (map_last - map_first))</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather_if is the inverse of \p scatter_if.
*
Expand Down Expand Up @@ -299,6 +303,7 @@ template<typename InputIterator1,
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The range <tt>[stencil, stencil + (map_last - map_first))</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather_if is the inverse of \p scatter_if.
*
Expand Down Expand Up @@ -379,6 +384,7 @@ __host__ __device__
*
* \pre The range <tt>[map_first, map_last)</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The range <tt>[stencil, stencil + (map_last - map_first))</tt> shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
* \pre The input data shall not overlap the range <tt>[result, result + (map_last - map_first))</tt>.
*
* \remark \p gather_if is the inverse of \p scatter_if.
*
Expand Down