3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Function min_element</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute">
8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.algorithm.min_element_hpp" title="Header <boost/compute/algorithm/min_element.hpp>">
9 <link rel="prev" href="merge.html" title="Function merge">
10 <link rel="next" href="minmax_element.html" title="Function minmax_element">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="merge.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.min_element_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="minmax_element.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.compute.min_element"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Function min_element</span></h2>
29 <p>boost::compute::min_element</p>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.algorithm.min_element_hpp" title="Header <boost/compute/algorithm/min_element.hpp>">boost/compute/algorithm/min_element.hpp</a>>
35 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">,</span> <span class="keyword">typename</span> Compare<span class="special">></span>
36 <span class="identifier">InputIterator</span>
37 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span> <span class="identifier">Compare</span> compare<span class="special">,</span>
38 <span class="identifier">command_queue</span> <span class="special">&</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
39 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> InputIterator<span class="special">></span>
40 <span class="identifier">InputIterator</span>
41 <span class="identifier">min_element</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">,</span>
42 <span class="identifier">command_queue</span> <span class="special">&</span> queue <span class="special">=</span> <span class="identifier">system</span><span class="special">::</span><span class="identifier">default_queue</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
43 <div class="refsect1">
44 <a name="idm46113332667504"></a><h2>Description</h2>
45 <p>Returns an iterator pointing to the element in range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>) with the minimum value.</p>
47 For example, to find <code class="computeroutput">int2</code> value with minimum first component in given vector: </p>
48 <pre class="programlisting"><span class="comment">// comparison function object</span>
49 <span class="identifier">BOOST_COMPUTE_FUNCTION</span><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> <span class="identifier">compare_first</span><span class="special">,</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">int2_</span> <span class="special">&</span><span class="identifier">a</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">int2_</span> <span class="special">&</span><span class="identifier">b</span><span class="special">)</span><span class="special">,</span>
50 <span class="special">{</span>
51 <span class="keyword">return</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">x</span> <span class="special"><</span> <span class="identifier">b</span><span class="special">.</span><span class="identifier">x</span><span class="special">;</span>
52 <span class="special">}</span><span class="special">)</span><span class="special">;</span>
54 <span class="comment">// create vector</span>
55 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">uint2_</span><span class="special">></span> <span class="identifier">data</span> <span class="special">=</span> <span class="special">...</span>
57 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">uint2_</span><span class="special">></span><span class="special">::</span><span class="identifier">iterator</span> <span class="identifier">min</span> <span class="special">=</span>
58 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">min_element</span><span class="special">(</span><span class="identifier">data</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">data</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">compare_first</span><span class="special">,</span> <span class="identifier">queue</span><span class="special">)</span><span class="special">;</span>
60 <p>Space complexity on CPUs: \Omega(1)<br>
61 Space complexity on GPUs: \Omega(N)</p>
62 <p><span class="bold"><strong>See Also:</strong></span></p>
68 <div class="variablelist"><table border="0" class="variablelist compact">
70 <col align="left" valign="top">
74 <td><p><span class="term">Parameters:</span></p></td>
75 <td><div class="variablelist"><table border="0" class="variablelist compact">
77 <col align="left" valign="top">
82 <td><p><span class="term"><code class="computeroutput">compare</code></span></p></td>
83 <td><p>comparison function object which returns true if the first argument is less than (i.e. is ordered before) the second. </p></td>
86 <td><p><span class="term"><code class="computeroutput">first</code></span></p></td>
87 <td><p>first element in the input range </p></td>
90 <td><p><span class="term"><code class="computeroutput">last</code></span></p></td>
91 <td><p>last element in the input range </p></td>
94 <td><p><span class="term"><code class="computeroutput">queue</code></span></p></td>
95 <td><p>command queue to perform the operation</p></td>
103 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
104 <td align="left"></td>
105 <td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p>
106 Distributed under the Boost Software License, Version 1.0. (See accompanying
107 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
112 <div class="spirit-nav">
113 <a accesskey="p" href="merge.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.algorithm.min_element_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="minmax_element.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>