/* * Copyright 2008-2012 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 replace.h * \brief Functions for replacing elements in a range with a particular value */ #pragma once #include #include namespace thrust { /*! \addtogroup transformations * \addtogroup replacing * \ingroup transformations * \{ */ /*! \p replace replaces every element in the range [first, last) equal to \p old_value * with \p new_value. That is: for every iterator \c i, if *i == old_value * then it performs the assignment *i = new_value. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param old_value The value to replace. * \param new_value The new value to replace \p old_value. * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam ForwardIterator is a model of Forward Iterator, * and \p ForwardIterator is mutable. * \tparam T is a model of Assignable, * \p T is a model of EqualityComparable, * objects of \p T may be compared for equality with objects of * \p ForwardIterator's \c value_type, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace to replace * a value of interest in a \c device_vector with another using the \p thrust::device * execution policy for parallelization: * * \code * #include * #include * #include * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = 2; * A[2] = 3; * A[3] = 1; * * thrust::replace(thrust::device, A.begin(), A.end(), 1, 99); * * // A contains [99, 2, 3, 99] * \endcode * * \see http://www.sgi.com/tech/stl/replace.html * \see \c replace_if * \see \c replace_copy * \see \c replace_copy_if */ template void replace(const thrust::detail::execution_policy_base &exec, ForwardIterator first, ForwardIterator last, const T &old_value, const T &new_value); /*! \p replace replaces every element in the range [first, last) equal to \p old_value * with \p new_value. That is: for every iterator \c i, if *i == old_value * then it performs the assignment *i = new_value. * * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param old_value The value to replace. * \param new_value The new value to replace \p old_value. * * \tparam ForwardIterator is a model of Forward Iterator, * and \p ForwardIterator is mutable. * \tparam T is a model of Assignable, * \p T is a model of EqualityComparable, * objects of \p T may be compared for equality with objects of * \p ForwardIterator's \c value_type, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace to replace * a value of interest in a \c device_vector with another. * * \code * #include * #include * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = 2; * A[2] = 3; * A[3] = 1; * * thrust::replace(A.begin(), A.end(), 1, 99); * * // A contains [99, 2, 3, 99] * \endcode * * \see http://www.sgi.com/tech/stl/replace.html * \see \c replace_if * \see \c replace_copy * \see \c replace_copy_if */ template void replace(ForwardIterator first, ForwardIterator last, const T &old_value, const T &new_value); /*! \p replace_if replaces every element in the range [first, last) for which * \p pred returns \c true with \p new_value. That is: for every iterator \c i, if * pred(*i) is \c true then it performs the assignment *i = new_value. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The new value to replace elements which pred(*i) evaluates * to \c true. * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam ForwardIterator is a model of Forward Iterator, * \p ForwardIterator is mutable, * and \p ForwardIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace_if to replace * a \c device_vector's negative elements with \c 0 using the \p thrust::device execution policy * for parallelization: * * \code * #include * #include * #include * ... * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = -3; * A[2] = 2; * A[3] = -1; * * is_less_than_zero pred; * * thrust::replace_if(thrust::device, A.begin(), A.end(), pred, 0); * * // A contains [1, 0, 2, 0] * \endcode * * \see http://www.sgi.com/tech/stl/replace_if.html * \see \c replace * \see \c replace_copy * \see \c replace_copy_if */ template void replace_if(const thrust::detail::execution_policy_base &exec, ForwardIterator first, ForwardIterator last, Predicate pred, const T &new_value); /*! \p replace_if replaces every element in the range [first, last) for which * \p pred returns \c true with \p new_value. That is: for every iterator \c i, if * pred(*i) is \c true then it performs the assignment *i = new_value. * * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The new value to replace elements which pred(*i) evaluates * to \c true. * * \tparam ForwardIterator is a model of Forward Iterator, * \p ForwardIterator is mutable, * and \p ForwardIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace_if to replace * a \c device_vector's negative elements with \c 0. * * \code * #include * #include * ... * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = -3; * A[2] = 2; * A[3] = -1; * * is_less_than_zero pred; * * thrust::replace_if(A.begin(), A.end(), pred, 0); * * // A contains [1, 0, 2, 0] * \endcode * * \see http://www.sgi.com/tech/stl/replace_if.html * \see \c replace * \see \c replace_copy * \see \c replace_copy_if */ template void replace_if(ForwardIterator first, ForwardIterator last, Predicate pred, const T &new_value); /*! \p replace_if replaces every element in the range [first, last) for which * pred(*s) returns \c true with \p new_value. That is: for every iterator * \c i in the range [first, last), and \c s in the range [stencil, stencil + (last - first)), * if pred(*s) is \c true then it performs the assignment *i = new_value. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param stencil The beginning of the stencil sequence. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The new value to replace elements which pred(*i) evaluates * to \c true. * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam ForwardIterator is a model of Forward Iterator, * and \p ForwardIterator is mutable. * \tparam InputIterator is a model of Input Iterator, * and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace_if to replace * a \c device_vector's element with \c 0 when its corresponding stencil element is less than zero * using the \p thrust::device execution policy for parallelization: * * \code * #include * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 10; * A[1] = 20; * A[2] = 30; * A[3] = 40; * * thrust::device_vector S(4); * S[0] = -1; * S[1] = 0; * S[2] = -1; * S[3] = 0; * * is_less_than_zero pred; * thrust::replace_if(thrust::device, A.begin(), A.end(), S.begin(), pred, 0); * * // A contains [0, 20, 0, 40] * \endcode * * \see http://www.sgi.com/tech/stl/replace_if.html * \see \c replace * \see \c replace_copy * \see \c replace_copy_if */ template void replace_if(const thrust::detail::execution_policy_base &exec, ForwardIterator first, ForwardIterator last, InputIterator stencil, Predicate pred, const T &new_value); /*! \p replace_if replaces every element in the range [first, last) for which * pred(*s) returns \c true with \p new_value. That is: for every iterator * \c i in the range [first, last), and \c s in the range [stencil, stencil + (last - first)), * if pred(*s) is \c true then it performs the assignment *i = new_value. * * \param first The beginning of the sequence of interest. * \param last The end of the sequence of interest. * \param stencil The beginning of the stencil sequence. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The new value to replace elements which pred(*i) evaluates * to \c true. * * \tparam ForwardIterator is a model of Forward Iterator, * and \p ForwardIterator is mutable. * \tparam InputIterator is a model of Input Iterator, * and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p ForwardIterator's \c value_type. * * The following code snippet demonstrates how to use \p replace_if to replace * a \c device_vector's element with \c 0 when its corresponding stencil element is less than zero. * * \code * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 10; * A[1] = 20; * A[2] = 30; * A[3] = 40; * * thrust::device_vector S(4); * S[0] = -1; * S[1] = 0; * S[2] = -1; * S[3] = 0; * * is_less_than_zero pred; * thrust::replace_if(A.begin(), A.end(), S.begin(), pred, 0); * * // A contains [0, 20, 0, 40] * \endcode * * \see http://www.sgi.com/tech/stl/replace_if.html * \see \c replace * \see \c replace_copy * \see \c replace_copy_if */ template void replace_if(ForwardIterator first, ForwardIterator last, InputIterator stencil, Predicate pred, const T &new_value); /*! \p replace_copy copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element equal to \p old_value * is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, \p replace_copy * performs the assignment *(result+n) = new_value if *(first+n) == old_value, * and *(result+n) = *(first+n) otherwise. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param result The beginning of the sequence to copy to. * \param old_value The value to replace. * \param new_value The replacement value for which *i == old_value evaluates to \c true. * \return result + (last-first) * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam InputIterator is a model of Input Iterator. * \tparam OutputIterator is a model of Output Iterator. * \tparam T is a model of Assignable, * \p T is a model of Equality Comparable, * \p T may be compared for equality with \p InputIterator's \c value_type, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * #include * ... * thrust::device_vector A(4); * A[0] = 1; * A[1] = 2; * A[2] = 3; * A[3] = 1; * * thrust::device_vector B(4); * * thrust::replace_copy(thrust::device, A.begin(), A.end(), B.begin(), 1, 99); * * // B contains [99, 2, 3, 99] * \endcode * * \see http://www.sgi.com/tech/stl/replace_copy.html * \see \c copy * \see \c replace * \see \c replace_if * \see \c replace_copy_if */ template OutputIterator replace_copy(const thrust::detail::execution_policy_base &exec, InputIterator first, InputIterator last, OutputIterator result, const T &old_value, const T &new_value); /*! \p replace_copy copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element equal to \p old_value * is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, \p replace_copy * performs the assignment *(result+n) = new_value if *(first+n) == old_value, * and *(result+n) = *(first+n) otherwise. * * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param result The beginning of the sequence to copy to. * \param old_value The value to replace. * \param new_value The replacement value for which *i == old_value evaluates to \c true. * \return result + (last-first) * * \tparam InputIterator is a model of Input Iterator. * \tparam OutputIterator is a model of Output Iterator. * \tparam T is a model of Assignable, * \p T is a model of Equality Comparable, * \p T may be compared for equality with \p InputIterator's \c value_type, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * ... * thrust::device_vector A(4); * A[0] = 1; * A[1] = 2; * A[2] = 3; * A[3] = 1; * * thrust::device_vector B(4); * * thrust::replace_copy(A.begin(), A.end(), B.begin(), 1, 99); * * // B contains [99, 2, 3, 99] * \endcode * * \see http://www.sgi.com/tech/stl/replace_copy.html * \see \c copy * \see \c replace * \see \c replace_if * \see \c replace_copy_if */ template OutputIterator replace_copy(InputIterator first, InputIterator last, OutputIterator result, const T &old_value, const T &new_value); /*! \p replace_copy_if copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element for which \p pred * is \c true is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, * \p replace_copy_if performs the assignment *(result+n) = new_value if * pred(*(first+n)), and *(result+n) = *(first+n) otherwise. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param result The beginning of the sequence to copy to. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The replacement value to assign pred(*i) evaluates to \c true. * \return result + (last-first) * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam InputIterator is a model of Input Iterator, * and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam OutputIterator is a model of Output Iterator. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = -3; * A[2] = 2; * A[3] = -1; * thrust::device_vector B(4); * is_less_than_zero pred; * * thrust::replace_copy_if(thrust::device, A.begin(), A.end(), B.begin(), pred, 0); * * // B contains [1, 0, 2, 0] * \endcode * * \see http://www.sgi.com/tech/stl/replace_copy_if.html * \see \c replace * \see \c replace_if * \see \c replace_copy */ template OutputIterator replace_copy_if(const thrust::detail::execution_policy_base &exec, InputIterator first, InputIterator last, OutputIterator result, Predicate pred, const T &new_value); /*! \p replace_copy_if copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element for which \p pred * is \c true is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, * \p replace_copy_if performs the assignment *(result+n) = new_value if * pred(*(first+n)), and *(result+n) = *(first+n) otherwise. * * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param result The beginning of the sequence to copy to. * \param pred The predicate to test on every value of the range [first,last). * \param new_value The replacement value to assign pred(*i) evaluates to \c true. * \return result + (last-first) * * \tparam InputIterator is a model of Input Iterator, * and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam OutputIterator is a model of Output Iterator. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 1; * A[1] = -3; * A[2] = 2; * A[3] = -1; * thrust::device_vector B(4); * is_less_than_zero pred; * * thrust::replace_copy_if(A.begin(), A.end(), B.begin(), pred, 0); * * // B contains [1, 0, 2, 0] * \endcode * * \see http://www.sgi.com/tech/stl/replace_copy_if.html * \see \c replace * \see \c replace_if * \see \c replace_copy */ template OutputIterator replace_copy_if(InputIterator first, InputIterator last, OutputIterator result, Predicate pred, const T &new_value); /*! This version of \p replace_copy_if copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element whose corresponding stencil * element causes \p pred to be \c true is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, * \p replace_copy_if performs the assignment *(result+n) = new_value if * pred(*(stencil+n)), and *(result+n) = *(first+n) otherwise. * * The algorithm's execution is parallelized as determined by \p exec. * * \param exec The execution policy to use for parallelization. * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param stencil The beginning of the stencil sequence. * \param result The beginning of the sequence to copy to. * \param pred The predicate to test on every value of the range [stencil, stencil + (last - first)). * \param new_value The replacement value to assign when pred(*s) evaluates to \c true. * \return result + (last-first) * * \tparam DerivedPolicy The name of the derived execution policy. * \tparam InputIterator1 is a model of Input Iterator. * \tparam InputIterator2 is a model of Input Iterator * and \p InputIterator2's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam OutputIterator is a model of Output Iterator. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * \pre \p stencil may equal \p result, but the ranges [stencil, stencil + (last - first)) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 10; * A[1] = 20; * A[2] = 30; * A[3] = 40; * * thrust::device_vector S(4); * S[0] = -1; * S[1] = 0; * S[2] = -1; * S[3] = 0; * * thrust::device_vector B(4); * is_less_than_zero pred; * * thrust::replace_if(thrust::device, A.begin(), A.end(), S.begin(), B.begin(), pred, 0); * * // B contains [0, 20, 0, 40] * \endcode * * \see \c replace_copy * \see \c replace_if */ template OutputIterator replace_copy_if(const thrust::detail::execution_policy_base &exec, InputIterator1 first, InputIterator1 last, InputIterator2 stencil, OutputIterator result, Predicate pred, const T &new_value); /*! This version of \p replace_copy_if copies elements from the range [first, last) to the range * [result, result + (last-first)), except that any element whose corresponding stencil * element causes \p pred to be \c true is not copied; \p new_value is copied instead. * * More precisely, for every integer \c n such that 0 <= n < last-first, * \p replace_copy_if performs the assignment *(result+n) = new_value if * pred(*(stencil+n)), and *(result+n) = *(first+n) otherwise. * * \param first The beginning of the sequence to copy from. * \param last The end of the sequence to copy from. * \param stencil The beginning of the stencil sequence. * \param result The beginning of the sequence to copy to. * \param pred The predicate to test on every value of the range [stencil, stencil + (last - first)). * \param new_value The replacement value to assign when pred(*s) evaluates to \c true. * \return result + (last-first) * * \tparam InputIterator1 is a model of Input Iterator. * \tparam InputIterator2 is a model of Input Iterator * and \p InputIterator2's \c value_type is convertible to \p Predicate's \c argument_type. * \tparam OutputIterator is a model of Output Iterator. * \tparam Predicate is a model of Predicate. * \tparam T is a model of Assignable, * and \p T is convertible to \p OutputIterator's \c value_type. * * \pre \p first may equal \p result, but the ranges [first, last) and [result, result + (last - first)) shall not overlap otherwise. * \pre \p stencil may equal \p result, but the ranges [stencil, stencil + (last - first)) and [result, result + (last - first)) shall not overlap otherwise. * * \code * #include * #include * * struct is_less_than_zero * { * __host__ __device__ * bool operator()(int x) * { * return x < 0; * } * }; * * ... * * thrust::device_vector A(4); * A[0] = 10; * A[1] = 20; * A[2] = 30; * A[3] = 40; * * thrust::device_vector S(4); * S[0] = -1; * S[1] = 0; * S[2] = -1; * S[3] = 0; * * thrust::device_vector B(4); * is_less_than_zero pred; * * thrust::replace_if(A.begin(), A.end(), S.begin(), B.begin(), pred, 0); * * // B contains [0, 20, 0, 40] * \endcode * * \see \c replace_copy * \see \c replace_if */ template OutputIterator replace_copy_if(InputIterator1 first, InputIterator1 last, InputIterator2 stencil, OutputIterator result, Predicate pred, const T &new_value); /*! \} // end replacing * \} // transformations */ } // end thrust #include