Permalink
Fetching contributors…
Cannot retrieve contributors at this time
129 lines (111 sloc) 4.47 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 reverse.h
* \brief Reverses the order of a range
*/
#pragma once
#include <thrust/detail/config.h>
#include <thrust/detail/dispatchable.h>
namespace thrust
{
template<typename System, typename BidirectionalIterator>
void reverse(thrust::detail::dispatchable_base<System> &system,
BidirectionalIterator first,
BidirectionalIterator last);
template<typename System, typename BidirectionalIterator, typename OutputIterator>
OutputIterator reverse_copy(thrust::detail::dispatchable_base<System> &system,
BidirectionalIterator first,
BidirectionalIterator last,
OutputIterator result);
/*! \addtogroup reordering
* \ingroup algorithms
*/
/*! \p reverse reverses a range. That is: for every <tt>i</tt> such that
* <tt>0 <= i <= (last - first) / 2</tt>, it exchanges <tt>*(first + i)</tt>
* and <tt>*(last - (i + 1))</tt>.
*
* \param first The beginning of the range to reverse.
* \param last The end of the range to reverse.
*
* \tparam BidirectionalIterator is a model of <a href="http://www.sgi.com/tech/stl/BidirectionalIterator.html">Bidirectional Iterator</a> and
* \p BidirectionalIterator is mutable.
*
* The following code snippet demonstrates how to use \p reverse to reverse a
* \p device_vector of integers.
*
* \code
* #include <thrust/reverse.h>
* ...
* const int N = 6;
* int data[N] = {0, 1, 2, 3, 4, 5};
* thrust::device_vector<int> v(data, data + N);
* thrust::reverse(v.begin(), v.end());
* // v is now {5, 4, 3, 2, 1, 0}
* \endcode
*
* \see http://www.sgi.com/tech/stl/reverse.html
* \see \p reverse_copy
* \see \p reverse_iterator
*/
template<typename BidirectionalIterator>
void reverse(BidirectionalIterator first,
BidirectionalIterator last);
/*! \p reverse_copy differs from \ref reverse only in that the reversed range
* is written to a different output range, rather than inplace.
*
* \p reverse_copy copies elements from the range <tt>[first, last)</tt> to the
* range <tt>[result, result + (last - first))</tt> such that the copy is a
* reverse of the original range. Specifically: for every <tt>i</tt> such that
* <tt>0 <= i < (last - first)</tt>, \p reverse_copy performs the assignment
* <tt>*(result + (last - first) - i) = *(first + i)</tt>.
*
* The return value is <tt>result + (last - first))</tt>.
*
* \param first The beginning of the range to reverse.
* \param last The end of the range to reverse.
* \param result The beginning of the output range.
*
* \tparam BidirectionalIterator is a model of <a href="http://www.sgi.com/tech/stl/BidirectionalIterator.html">Bidirectional Iterator</a>,
* and \p BidirectionalIterator's \p value_type is convertible to \p OutputIterator's \p value_type.
* \tparam OutputIterator is 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 reverse_copy to reverse
* an input \p device_vector of integers to an output \p device_vector.
*
* \code
* #include <thrust/reverse.h>
* ...
* const int N = 6;
* int data[N] = {0, 1, 2, 3, 4, 5};
* thrust::device_vector<int> input(data, data + N);
* thrust::device_vector<int> output(N);
* thrust::reverse_copy(v.begin(), v.end(), output.begin());
* // input is still {0, 1, 2, 3, 4, 5}
* // output is now {5, 4, 3, 2, 1, 0}
* \endcode
*
* \see http://www.sgi.com/tech/stl/reverse_copy.html
* \see \p reverse
* \see \p reverse_iterator
*/
template<typename BidirectionalIterator, typename OutputIterator>
OutputIterator reverse_copy(BidirectionalIterator first,
BidirectionalIterator last,
OutputIterator result);
/*! \} // end reordering
*/
} // end thrust
#include <thrust/detail/reverse.inl>