Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/min-element.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 8.5 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: min_element</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./upper-bound.html" class="navigation-link">Prev</a>&nbsp;<a href="./max-element.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./upper-bound.html" class="navigation-link">Back</a>&nbsp;<a href="./max-element.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
15<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./querying-algorithms.html" class="navigation-link">Querying Algorithms</a> / <a href="./min-element.html" class="navigation-link">min_element</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="min-element">
18<h1><a class="toc-backref" href="./querying-algorithms.html#id410" name="min-element">min_element</a></h1>
19<div class="section" id="min-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename Sequence
24    , typename Pred = <a href="./less.html" class="identifier">less</a>&lt;_1,_2&gt;
25    &gt;
26struct <a href="./min-element.html" class="identifier">min_element</a>
27{
28    typedef <em>unspecified</em> type;
29};
30</pre>
31</div>
32<div class="section" id="min-description">
33<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
34<p>Returns an iterator to the smallest element in <tt class="literal"><span class="pre">Sequence</span></tt>.</p>
35</div>
36<div class="section" id="min-header">
37<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
38<pre class="literal-block">
39#include &lt;<a href="../../../../boost/mpl/min_element.hpp" class="header">boost/mpl/min_element.hpp</a>&gt;
40</pre>
41</div>
42<div class="section" id="min-parameters">
43<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
44<table border="1" class="table">
45<colgroup>
46<col width="19%" />
47<col width="38%" />
48<col width="43%" />
49</colgroup>
50<thead valign="bottom">
51<tr><th>Parameter</th>
52<th>Requirement</th>
53<th>Description</th>
54</tr>
55</thead>
56<tbody valign="top">
57<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
58<td><a class="reference" href="./forward-sequence.html">Forward Sequence</a></td>
59<td>A sequence to be searched.</td>
60</tr>
61<tr><td><tt class="literal"><span class="pre">Pred</span></tt></td>
62<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
63<td>A comparison criteria.</td>
64</tr>
65</tbody>
66</table>
67</div>
68<div class="section" id="min-expression-semantics">
69<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
70<p>For any <a class="reference" href="./forward-sequence.html">Forward Sequence</a> <tt class="literal"><span class="pre">s</span></tt> and binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">pred</span></tt>:</p>
71<pre class="literal-block">
72typedef <a href="./min-element.html" class="identifier">min_element</a>&lt;s,pred&gt;::type i;
73</pre>
74<table class="field-list" frame="void" rules="none">
75<col class="field-name" />
76<col class="field-body" />
77<tbody valign="top">
78<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./forward-iterator.html">Forward Iterator</a>.</td>
79</tr>
80<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">i</span></tt> is the first iterator in [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>) such that for every iterator <tt class="literal"><span class="pre">j</span></tt> 
81in [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>),</p>
82<pre class="last literal-block">
83<a href="./apply.html" class="identifier">apply</a>&lt; pred, <a href="./deref.html" class="identifier">deref</a>&lt;j&gt;::type, <a href="./deref.html" class="identifier">deref</a>&lt;i&gt;::type &gt;::type::value == false
84</pre>
85</td>
86</tr>
87</tbody>
88</table>
89</div>
90<div class="section" id="min-complexity">
91<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
92<p>Linear. Zero comparisons if <tt class="literal"><span class="pre">s</span></tt> is empty, otherwise exactly <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>
93comparisons.</p>
94</div>
95<div class="section" id="min-example">
96<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
97<pre class="literal-block">
98typedef <a href="./vector.html" class="identifier">vector</a>&lt;bool,char[50],long,double&gt; types;
99typedef <a href="./min-element.html" class="identifier">min_element</a>&lt;
100      <a href="./transform-view.html" class="identifier">transform_view</a>&lt; types,<a href="./sizeof.html" class="identifier">sizeof_</a>&lt;_1&gt; &gt;
101    &gt;::type iter;
102
103<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./deref.html" class="identifier">deref</a>&lt;iter::base&gt;::type, bool&gt; ));
104</pre>
105</div>
106<div class="section" id="min-see-also">
107<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
108<p><a class="reference" href="./querying-algorithms.html">Querying Algorithms</a>, <a class="refentry reference" href="./max-element.html"><tt class="refentry literal"><span class="pre">max_element</span></tt></a>, <a class="refentry reference" href="./find-if.html"><tt class="refentry literal"><span class="pre">find_if</span></tt></a>, <a class="refentry reference" href="./upper-bound.html"><tt class="refentry literal"><span class="pre">upper_bound</span></tt></a>, <a class="refentry reference" href="./find.html"><tt class="refentry literal"><span class="pre">find</span></tt></a></p>
109<!-- modtime: November 10, 2004 04:37:28 +0000 -->
110<!-- Algorithms/Querying Algorithms//max_element |90 -->
111</div>
112</div>
113
114<div class="footer-separator"></div>
115<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./upper-bound.html" class="navigation-link">Prev</a>&nbsp;<a href="./max-element.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./upper-bound.html" class="navigation-link">Back</a>&nbsp;<a href="./max-element.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
116</tr></table></body>
117</html>
Note: See TracBrowser for help on using the repository browser.