vector_fold.hpp
Go to the documentation of this file.
1 /*!
2  * \brief Algorithm to reduce a vector to a scalar value
3  *
4  * \author O. Krause
5  * \date 2016
6  *
7  *
8  * \par Copyright 1995-2015 Shark Development Team
9  *
10  * <BR><HR>
11  * This file is part of Shark.
12  * <http://image.diku.dk/shark/>
13  *
14  * Shark is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU Lesser General Public License as published
16  * by the Free Software Foundation, either version 3 of the License, or
17  * (at your option) any later version.
18  *
19  * Shark is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with Shark. If not, see <http://www.gnu.org/licenses/>.
26  *
27  */
28 #ifndef REMORA_KERNELS_VECTOR_FOLD_HPP
29 #define REMORA_KERNELS_VECTOR_FOLD_HPP
30 
31 #include "../detail/traits.hpp"
32 #include "default/vector_fold.hpp"
33 #ifdef REMORA_USE_GPU
34 #include "gpu/vector_fold.hpp"
35 #endif
36 
37 namespace remora{namespace kernels {
38 
39 
40 ///\brief Appliuees F in any order to the elements of v and a given initial value.
41 ///
42 /// result is the same as value = f(v_1,f(v_2,...f(v_n,value))) assuming f is commutative
43 /// and associative.
44 template<class F, class V, class Device>
45 void vector_fold(vector_expression<V, Device> const& v, typename F::result_type& value) {
46  typedef typename V::evaluation_category::tag TagV;
47  bindings::vector_fold<F>(v(), value, TagV());
48 }
49 
50 }}
51 #endif