compute/algorithm/partial_sum.hpp

0001 //---------------------------------------------------------------------------//
0002 // Copyright (c) 2013 Kyle Lutz <kyle.r.lutz@gmail.com>
0003 //
0004 // Distributed under the Boost Software License, Version 1.0
0005 // See accompanying file LICENSE_1_0.txt or copy at
0006 // http://www.boost.org/LICENSE_1_0.txt
0007 //
0008 // See http://boostorg.github.com/compute for more information.
0009 //---------------------------------------------------------------------------//
0010
0011 #ifndef BOOST_COMPUTE_ALGORITHM_PARTIAL_SUM_HPP
0012 #define BOOST_COMPUTE_ALGORITHM_PARTIAL_SUM_HPP
0013
0014 #include <boost/static_assert.hpp>
0015
0016 #include <boost/compute/system.hpp>
0017 #include <boost/compute/command_queue.hpp>
0018 #include <boost/compute/algorithm/inclusive_scan.hpp>
0019 #include <boost/compute/type_traits/is_device_iterator.hpp>
0020
0021 namespace boost {
0022 namespace compute {
0023
0024 /// Calculates the cumulative sum of the elements in the range [\p first,
0025 /// \p last) and writes the resulting values to the range beginning at
0026 /// \p result.
0027 ///
0028 /// Space complexity on GPUs: \Omega(n)<br>
0029 /// Space complexity on GPUs when \p first == \p result: \Omega(2n)<br>
0030 /// Space complexity on CPUs: \Omega(1)
0031 template<class InputIterator, class OutputIterator>
0032 inline OutputIterator
0033 partial_sum(InputIterator first,
0034             InputIterator last,
0035             OutputIterator result,
0036             command_queue &queue = system::default_queue())
0037 {
0038     BOOST_STATIC_ASSERT(is_device_iterator<InputIterator>::value);
0039     BOOST_STATIC_ASSERT(is_device_iterator<OutputIterator>::value);
0040     return ::boost::compute::inclusive_scan(first, last, result, queue);
0041 }
0042
0043 } // end compute namespace
0044 } // end boost namespace
0045
0046 #endif // BOOST_COMPUTE_ALGORITHM_PARTIAL_SUM_HPP