Files
TheRock/rocm-libraries/projects/rocthrust/thrust/scatter.h
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

440 lines
21 KiB
C++

/*
* Copyright 2008-2013 NVIDIA Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*! \file scatter.h
* \brief Irregular copying to a destination range
*/
#pragma once
#include <thrust/detail/config.h>
#include <thrust/detail/execution_policy.h>
THRUST_NAMESPACE_BEGIN
/*! \addtogroup scattering
* \ingroup copying
* \{
*/
/*! \p scatter copies elements from a source range into an output array
* according to a map. For each iterator \c i in the range [\p first, \p last),
* the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>. The
* output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>,
* the result is undefined.
*
* The algorithm's execution is parallelized as determined by \p exec.
*
* \param exec The execution policy to use for parallelization.
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param result Destination of the source elements.
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map, map + (last - first))` for all iterators `i` in the range `[map, map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators in the range `[map, map + (last - first))`.
*
* The following code snippet demonstrates how to use \p scatter to reorder a range using
* the \p thrust::device execution policy for parallelization:
*
* \code
* #include <thrust/scatter.h>
* #include <thrust/device_vector.h>
* #include <thrust/execution_policy.h>
* ...
* // mark even indices with a 1; odd indices with a 0
* int values[10] = {1, 0, 1, 0, 1, 0, 1, 0, 1, 0};
* thrust::device_vector<int> d_values(values, values + 10);
*
* // scatter all even indices into the first half of the
* // range, and odd indices vice versa
* int map[10] = {0, 5, 1, 6, 2, 7, 3, 8, 4, 9};
* thrust::device_vector<int> d_map(map, map + 10);
*
* thrust::device_vector<int> d_output(10);
* thrust::scatter(thrust::device,
* d_values.begin(), d_values.end(),
* d_map.begin(), d_output.begin());
* // d_output is now {1, 1, 1, 1, 1, 0, 0, 0, 0, 0}
* \endcode
*
* \note \p scatter is the inverse of thrust::gather.
*/
template <typename DerivedPolicy, typename InputIterator1, typename InputIterator2, typename RandomAccessIterator>
THRUST_HOST_DEVICE void
scatter(const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
InputIterator1 first,
InputIterator1 last,
InputIterator2 map,
RandomAccessIterator result);
/*! \p scatter copies elements from a source range into an output array
* according to a map. For each iterator \c i in the range [\p first, \p last),
* the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>. The
* output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>,
* the result is undefined.
*
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param result Destination of the source elements.
*
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map,map + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators in the range `[map,map + (last - first))`.
*
* The following code snippet demonstrates how to use \p scatter to reorder a range.
*
* \code
* #include <thrust/scatter.h>
* #include <thrust/device_vector.h>
* ...
* // mark even indices with a 1; odd indices with a 0
* int values[10] = {1, 0, 1, 0, 1, 0, 1, 0, 1, 0};
* thrust::device_vector<int> d_values(values, values + 10);
*
* // scatter all even indices into the first half of the
* // range, and odd indices vice versa
* int map[10] = {0, 5, 1, 6, 2, 7, 3, 8, 4, 9};
* thrust::device_vector<int> d_map(map, map + 10);
*
* thrust::device_vector<int> d_output(10);
* thrust::scatter(d_values.begin(), d_values.end(),
* d_map.begin(), d_output.begin());
* // d_output is now {1, 1, 1, 1, 1, 0, 0, 0, 0, 0}
* \endcode
*
* \note \p scatter is the inverse of thrust::gather.
*/
template <typename InputIterator1, typename InputIterator2, typename RandomAccessIterator>
void scatter(InputIterator1 first, InputIterator1 last, InputIterator2 map, RandomAccessIterator result);
/*! \p scatter_if conditionally copies elements from a source range into an
* output array according to a map. For each iterator \c i in the
* range <tt>[first, last)</tt> such that <tt>*(stencil + (i - first))</tt> is
* true, the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>.
* The output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>
* the result is undefined.
*
* The algorithm's execution is parallelized as determined by \p exec.
*
* \param exec The execution policy to use for parallelization.
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param stencil Beginning of the sequence of predicate values.
* \param output Beginning of the destination range.
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam InputIterator3 must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a> and \c InputIterator3's \c
* value_type must be convertible to \c bool. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map,map + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[stencil,stencil + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators `i` in the range `[map,map + (last - first))` for
* which the following condition holds: `*(stencil + i) != false`.
*
* \code
* #include <thrust/scatter.h>
* #include <thrust/execution_policy.h>
* ...
* int V[8] = {10, 20, 30, 40, 50, 60, 70, 80};
* int M[8] = {0, 5, 1, 6, 2, 7, 3, 4};
* int S[8] = {1, 0, 1, 0, 1, 0, 1, 0};
* int D[8] = {0, 0, 0, 0, 0, 0, 0, 0};
*
* thrust::scatter_if(thrust::host, V, V + 8, M, S, D);
*
* // D contains [10, 30, 50, 70, 0, 0, 0, 0];
* \endcode
*
* \note \p scatter_if is the inverse of thrust::gather_if.
*/
template <typename DerivedPolicy,
typename InputIterator1,
typename InputIterator2,
typename InputIterator3,
typename RandomAccessIterator>
THRUST_HOST_DEVICE void scatter_if(
const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
InputIterator1 first,
InputIterator1 last,
InputIterator2 map,
InputIterator3 stencil,
RandomAccessIterator output);
/*! \p scatter_if conditionally copies elements from a source range into an
* output array according to a map. For each iterator \c i in the
* range <tt>[first, last)</tt> such that <tt>*(stencil + (i - first))</tt> is
* true, the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>.
* The output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>
* the result is undefined.
*
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param stencil Beginning of the sequence of predicate values.
* \param output Beginning of the destination range.
*
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam InputIterator3 must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a> and \c InputIterator3's \c
* value_type must be convertible to \c bool. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map,map + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[stencil,stencil + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators `i` in the range `[map,map + (last - first))` for
* which the following condition holds: `*(stencil + i) != false`.
*
* \code
* #include <thrust/scatter.h>
* ...
* int V[8] = {10, 20, 30, 40, 50, 60, 70, 80};
* int M[8] = {0, 5, 1, 6, 2, 7, 3, 4};
* int S[8] = {1, 0, 1, 0, 1, 0, 1, 0};
* int D[8] = {0, 0, 0, 0, 0, 0, 0, 0};
*
* thrust::scatter_if(V, V + 8, M, S, D);
*
* // D contains [10, 30, 50, 70, 0, 0, 0, 0];
* \endcode
*
* \note \p scatter_if is the inverse of thrust::gather_if.
*/
template <typename InputIterator1, typename InputIterator2, typename InputIterator3, typename RandomAccessIterator>
void scatter_if(
InputIterator1 first, InputIterator1 last, InputIterator2 map, InputIterator3 stencil, RandomAccessIterator output);
/*! \p scatter_if conditionally copies elements from a source range into an
* output array according to a map. For each iterator \c i in the
* range <tt>[first, last)</tt> such that <tt>pred(*(stencil + (i - first)))</tt> is
* \c true, the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>.
* The output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>
* the result is undefined.
*
* The algorithm's execution is parallelized as determined by \p exec.
*
* \param exec The execution policy to use for parallelization.
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param stencil Beginning of the sequence of predicate values.
* \param output Beginning of the destination range.
* \param pred Predicate to apply to the stencil values.
*
* \tparam DerivedPolicy The name of the derived execution policy.
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam InputIterator3 must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a> and \c InputIterator3's \c
* value_type must be convertible to \c Predicate's \c argument_type. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>. \tparam
* Predicate must be a model of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map,map + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[stencil,stencil + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators `i` in the range `[map,map + (last - first))` for
* which the following condition holds: `pred(*(stencil + i)) != false`.
*
* \code
* #include <thrust/scatter.h>
* #include <thrust/execution_policy.h>
*
* struct is_even
* {
* THRUST_HOST_DEVICE
* bool operator()(int x)
* {
* return (x % 2) == 0;
* }
* };
*
* ...
*
* int V[8] = {10, 20, 30, 40, 50, 60, 70, 80};
* int M[8] = {0, 5, 1, 6, 2, 7, 3, 4};
* int S[8] = {2, 1, 2, 1, 2, 1, 2, 1};
* int D[8] = {0, 0, 0, 0, 0, 0, 0, 0};
*
* is_even pred;
* thrust::scatter_if(thrust::host, V, V + 8, M, S, D, pred);
*
* // D contains [10, 30, 50, 70, 0, 0, 0, 0];
* \endcode
*
* \note \p scatter_if is the inverse of thrust::gather_if.
*/
template <typename DerivedPolicy,
typename InputIterator1,
typename InputIterator2,
typename InputIterator3,
typename RandomAccessIterator,
typename Predicate>
THRUST_HOST_DEVICE void scatter_if(
const thrust::detail::execution_policy_base<DerivedPolicy>& exec,
InputIterator1 first,
InputIterator1 last,
InputIterator2 map,
InputIterator3 stencil,
RandomAccessIterator output,
Predicate pred);
/*! \p scatter_if conditionally copies elements from a source range into an
* output array according to a map. For each iterator \c i in the
* range <tt>[first, last)</tt> such that <tt>pred(*(stencil + (i - first)))</tt> is
* \c true, the value \c *i is assigned to <tt>output[*(map + (i - first))]</tt>.
* The output iterator must permit random access. If the same index
* appears more than once in the range <tt>[map, map + (last - first))</tt>
* the result is undefined.
*
* \param first Beginning of the sequence of values to scatter.
* \param last End of the sequence of values to scatter.
* \param map Beginning of the sequence of output indices.
* \param stencil Beginning of the sequence of predicate values.
* \param output Beginning of the destination range.
* \param pred Predicate to apply to the stencil values.
*
* \tparam InputIterator1 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator1's \c value_type must be convertible to \c RandomAccessIterator's \c value_type.
* \tparam InputIterator2 must be a model of <a href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input
* Iterator</a> and \c InputIterator2's \c value_type must be convertible to \c RandomAccessIterator's \c
* difference_type. \tparam InputIterator3 must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/input_iterator">Input Iterator</a> and \c InputIterator3's \c
* value_type must be convertible to \c Predicate's \c argument_type. \tparam RandomAccessIterator must be a model of <a
* href="https://en.cppreference.com/w/cpp/iterator/random_access_iterator">Random Access iterator</a>. \tparam
* Predicate must be a model of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[first,last)` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[map,map + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The iterator `result + i` shall not refer to any element referenced by any iterator `j` in the range
* `[stencil,stencil + (last - first))` for all iterators `i` in the range `[map,map + (last - first))`.
*
* \pre The expression `result[*i]` shall be valid for all iterators `i` in the range `[map,map + (last - first))` for
* which the following condition holds: `pred(*(stencil + i)) != false`.
*
* \code
* #include <thrust/scatter.h>
*
* struct is_even
* {
* THRUST_HOST_DEVICE
* bool operator()(int x)
* {
* return (x % 2) == 0;
* }
* };
*
* ...
*
* int V[8] = {10, 20, 30, 40, 50, 60, 70, 80};
* int M[8] = {0, 5, 1, 6, 2, 7, 3, 4};
* int S[8] = {2, 1, 2, 1, 2, 1, 2, 1};
* int D[8] = {0, 0, 0, 0, 0, 0, 0, 0};
*
* is_even pred;
* thrust::scatter_if(V, V + 8, M, S, D, pred);
*
* // D contains [10, 30, 50, 70, 0, 0, 0, 0];
* \endcode
*
* \note \p scatter_if is the inverse of thrust::gather_if.
*/
template <typename InputIterator1,
typename InputIterator2,
typename InputIterator3,
typename RandomAccessIterator,
typename Predicate>
void scatter_if(InputIterator1 first,
InputIterator1 last,
InputIterator2 map,
InputIterator3 stencil,
RandomAccessIterator output,
Predicate pred);
/*! \} // end scattering
*/
THRUST_NAMESPACE_END
#include <thrust/detail/scatter.inl>