Permalink
Fetching contributors…
Cannot retrieve contributors at this time
289 lines (262 sloc) 10.9 KB
/*
* 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 copy.h
* \brief Copies elements from one range to another
*/
#pragma once
#include <thrust/detail/config.h>
#include <thrust/detail/dispatchable.h>
namespace thrust
{
template<typename System, typename InputIterator, typename OutputIterator>
OutputIterator copy(thrust::detail::dispatchable_base<System> &system,
InputIterator first,
InputIterator last,
OutputIterator result);
template<typename System, typename InputIterator, typename Size, typename OutputIterator>
OutputIterator copy_n(thrust::detail::dispatchable_base<System> &system,
InputIterator first,
Size n,
OutputIterator result);
template<typename System, typename InputIterator, typename OutputIterator, typename Predicate>
OutputIterator copy_if(thrust::detail::dispatchable_base<System> &system,
InputIterator first,
InputIterator last,
OutputIterator result,
Predicate pred);
template<typename System, typename InputIterator1, typename InputIterator2, typename OutputIterator, typename Predicate>
OutputIterator copy_if(thrust::detail::dispatchable_base<System> &system,
InputIterator1 first,
InputIterator1 last,
InputIterator2 stencil,
OutputIterator result,
Predicate pred);
/*! \addtogroup algorithms
*/
/*! \addtogroup copying
* \ingroup algorithms
* \{
*/
/*! \p copy copies elements from the range [\p first, \p last) to the range
* [\p result, \p result + (\p last - \p first)). That is, it performs
* the assignments *\p result = *\p first, *(\p result + \c 1) = *(\p first + \c 1),
* and so on. Generally, for every integer \c n from \c 0 to \p last - \p first, \p copy
* performs the assignment *(\p result + \c n) = *(\p first + \c n). Unlike
* \c std::copy, \p copy offers no guarantee on order of operation. As a result,
* calling \p copy with overlapping source and destination ranges has undefined
* behavior.
*
* The return value is \p result + (\p last - \p first).
*
* \param first The beginning of the sequence to copy.
* \param last The end of the sequence to copy.
* \param result The destination sequence.
* \return The end of the destination sequence.
* \see http://www.sgi.com/tech/stl/copy.html
*
* \tparam InputIterator must be a model of <a href="http://www.sgi.com/tech/stl/InputIterator.html">Input Iterator</a> and \c InputIterator's \c value_type must be convertible to \c OutputIterator's \c value_type.
* \tparam OutputIterator must be a model of <a href="http://www.sgi.com/tech/stl/OutputIterator.html">Output Iterator</a>.
*
* The following code snippet demonstrates how to use \p copy
* to copy from one range to another.
*
* \code
* #include <thrust/copy.h>
* #include <thrust/device_vector.h>
* ...
*
* thrust::device_vector<int> vec0(100);
* thrust::device_vector<int> vec1(100);
* ...
*
* thrust::copy(vec0.begin(), vec0.end(),
* vec1.begin());
*
* // vec1 is now a copy of vec0
* \endcode
*/
template<typename InputIterator, typename OutputIterator>
OutputIterator copy(InputIterator first,
InputIterator last,
OutputIterator result);
/*! \p copy_n copies elements from the range <tt>[first, first + n)</tt> to the range
* <tt>[result, result + n)</tt>. That is, it performs the assignments <tt>*result = *first, *(result + 1) = *(first + 1)</tt>,
* and so on. Generally, for every integer \c i from \c 0 to \c n, \p copy
* performs the assignment *(\p result + \c i) = *(\p first + \c i). Unlike
* \c std::copy_n, \p copy_n offers no guarantee on order of operation. As a result,
* calling \p copy_n with overlapping source and destination ranges has undefined
* behavior.
*
* The return value is \p result + \p n.
*
* \param first The beginning of the range to copy.
* \param n The number of elements to copy.
* \param result The beginning destination range.
* \return The end of the destination range.
*
* \tparam InputIterator must be a model of <a href="http://www.sgi.com/tech/stl/InputIterator.html">Input Iterator</a> and \c InputIterator's \c value_type must be convertible to \c OutputIterator's \c value_type.
* \tparam Size is an integral type.
* \tparam OutputIterator must be a model of <a href="http://www.sgi.com/tech/stl/OutputIterator.html">Output Iterator</a>.
*
* The following code snippet demonstrates how to use \p copy
* to copy from one range to another.
*
* \code
* #include <thrust/copy.h>
* #include <thrust/device_vector.h>
* ...
* size_t n = 100;
* thrust::device_vector<int> vec0(n);
* thrust::device_vector<int> vec1(n);
* ...
* thrust::copy_n(vec0.begin(), n, vec1.begin());
*
* // vec1 is now a copy of vec0
* \endcode
*
* \see http://www.sgi.com/tech/stl/copy_n.html
* \see thrust::copy
*/
template<typename InputIterator, typename Size, typename OutputIterator>
OutputIterator copy_n(InputIterator first,
Size n,
OutputIterator result);
/*! \} // end copying
*/
/*! \addtogroup stream_compaction
* \{
*/
/*! This version of \p copy_if copies elements from the range <tt>[first,last)</tt>
* to a range beginning at \ presult, except that any element which causes \p pred
* to be \p pred to be \c false is not copied.
*
* More precisely, for every integer \c n such that <tt>0 <= n < last-first</tt>,
* \p copy_if performs the assignment <tt>*result = *(first+n)</tt> and \p result
* is advanced one position if <tt>pred(*(first+n))</tt>. Otherwise, no assignment
* occurs and \p result is not advanced.
*
* \param first The beginning of the sequence from which to copy.
* \param last The end of the sequence from which to copy.
* \param result The beginning of the sequence into which to copy.
* \param pred The predicate to test on every value of the range <tt>[first, last)</tt>.
* \return <tt>result + n</tt>, where \c n is equal to the number of times \p pred
* evaluated to \c true in the range <tt>[first, last)</tt>.
*
* \tparam InputIterator is a model of <a href="http://www.sgi.com/tech/stl/InputIterator.html">Input Iterator</a>,
* and \p InputIterator's \c value_type is convertible to \p Predicate's \c argument_type.
* \tparam OutputIterator is a model of <a href="http://www.sgi.com/tech/stl/OutputIterator.html">Output Iterator</a>.
* \tparam Predicate is a model of <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>.
*
* The following code snippet demonstrates how to use \p copy_if to perform stream compaction
* to copy even numbers to an output range.
*
* \code
* #include <thrust/copy.h>
* ...
* struct is_even
* {
* __host__ __device__
* bool operator()(const int x)
* {
* return (x % 2) == 0;
* }
* };
* ...
* const int N = 6;
* int V[N] = {-2, 0, -1, 0, 1, 2};
* int result[4];
*
* thrust::copy_if(V, V + N, result, is_even());
*
* // V remains {-2, 0, -1, 0, 1, 2}
* // result is now {-2, 0, 0, 2}
* \endcode
*
* \see \c remove_copy_if
*/
template<typename InputIterator,
typename OutputIterator,
typename Predicate>
OutputIterator copy_if(InputIterator first,
InputIterator last,
OutputIterator result,
Predicate pred);
/*! This version of \p copy_if copies elements from the range <tt>[first,last)</tt>
* to a range beginning at \p result, except that any element whose corresponding stencil
* element causes \p pred to be \c false is not copied.
*
* More precisely, for every integer \c n such that <tt>0 <= n < last-first</tt>,
* \p copy_if performs the assignment <tt>*result = *(first+n)</tt> and \p result
* is advanced one position if <tt>pred(*(stencil+n))</tt>. Otherwise, no assignment
* occurs and \p result is not advanced.
*
* \param first The beginning of the sequence from which to copy.
* \param last The end of the sequence from which to copy.
* \param stencil The beginning of the stencil sequence.
* \param result The beginning of the sequence into which to copy.
* \param pred The predicate to test on every value of the range <tt>[stencil, stencil + (last-first))</tt>.
* \return <tt>result + n</tt>, where \c n is equal to the number of times \p pred
* evaluated to \c true in the range <tt>[stencil, stencil + (last-first))</tt>.
*
* \tparam InputIterator1 is a model of <a href="http://www.sgi.com/tech/stl/InputIterator.html">Input Iterator</a>.
* \tparam InputIterator2 is a model of <a href="http://www.sgi.com/tech/stl/InputIterator.html">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 href="http://www.sgi.com/tech/stl/OutputIterator">Output Iterator</a>.
* \tparam Predicate is a model of <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>.
*
* The following code snippet demonstrates how to use \p copy_if to perform stream compaction
* to copy numbers to an output range when corresponding stencil elements are even:
*
* \code
* #include <thrust/copy.h>
* ...
* struct is_even
* {
* __host__ __device__
* bool operator()(const int x)
* {
* return (x % 2) == 0;
* }
* };
* ...
* int N = 6;
* int data[N] = { 0, 1, 2, 3, 4, 5};
* int stencil[N] = {-2, 0, -1, 0, 1, 2};
* int result[4];
*
* thrust::copy_if(data, data + N, stencil, result, is_even());
*
* // data remains = { 0, 1, 2, 3, 4, 5};
* // stencil remains = {-2, 0, -1, 0, 1, 2};
* // result is now { 0, 1, 3, 5}
* \endcode
*
* \see \c remove_copy_if
*/
template<typename InputIterator1,
typename InputIterator2,
typename OutputIterator,
typename Predicate>
OutputIterator copy_if(InputIterator1 first,
InputIterator1 last,
InputIterator2 stencil,
OutputIterator result,
Predicate pred);
/*! \} // end stream_compaction
*/
} // end namespace thrust
#include <thrust/detail/copy.h>
#include <thrust/detail/copy_if.h>