diff options
Diffstat (limited to 'boost/compute/algorithm/min_element.hpp')
-rw-r--r-- | boost/compute/algorithm/min_element.hpp | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/boost/compute/algorithm/min_element.hpp b/boost/compute/algorithm/min_element.hpp new file mode 100644 index 0000000000..62744efb98 --- /dev/null +++ b/boost/compute/algorithm/min_element.hpp @@ -0,0 +1,74 @@ +//---------------------------------------------------------------------------// +// Copyright (c) 2013 Kyle Lutz <kyle.r.lutz@gmail.com> +// +// Distributed under the Boost Software License, Version 1.0 +// See accompanying file LICENSE_1_0.txt or copy at +// http://www.boost.org/LICENSE_1_0.txt +// +// See http://boostorg.github.com/compute for more information. +//---------------------------------------------------------------------------// + +#ifndef BOOST_COMPUTE_ALGORITHM_MIN_ELEMENT_HPP +#define BOOST_COMPUTE_ALGORITHM_MIN_ELEMENT_HPP + +#include <boost/compute/system.hpp> +#include <boost/compute/command_queue.hpp> +#include <boost/compute/functional.hpp> +#include <boost/compute/algorithm/detail/find_extrema.hpp> + +namespace boost { +namespace compute { + +/// Returns an iterator pointing to the element in range +/// [\p first, \p last) with the minimum value. +/// +/// \param first first element in the input range +/// \param last last element in the input range +/// \param compare comparison function object which returns true if the first +/// argument is less than (i.e. is ordered before) the second. +/// \param queue command queue to perform the operation +/// +/// For example, to find \c int2 value with minimum first component in given vector: +/// \code +/// // comparison function object +/// BOOST_COMPUTE_FUNCTION(bool, compare_first, (const int2_ &a, const int2_ &b), +/// { +/// return a.x < b.x; +/// }); +/// +/// // create vector +/// boost::compute::vector<uint2_> data = ... +/// +/// boost::compute::vector<uint2_>::iterator min = +/// boost::compute::min_element(data.begin(), data.end(), compare_first, queue); +/// \endcode +/// +/// \see max_element() +template<class InputIterator, class Compare> +inline InputIterator +min_element(InputIterator first, + InputIterator last, + Compare compare, + command_queue &queue = system::default_queue()) +{ + return detail::find_extrema(first, last, compare, true, queue); +} + +///\overload +template<class InputIterator> +inline InputIterator +min_element(InputIterator first, + InputIterator last, + command_queue &queue = system::default_queue()) +{ + typedef typename std::iterator_traits<InputIterator>::value_type value_type; + + return ::boost::compute::min_element( + first, last, ::boost::compute::less<value_type>(), queue + ); +} + +} // end compute namespace +} // end boost namespace + +#endif // BOOST_COMPUTE_ALGORITHM_MIN_ELEMENT_HPP |