Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/max-element.html @ 12

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

added boost
File size: 8.3 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<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: max_element</title>
8<link rel="stylesheet" href="../style.css" type="text/css" />
9</head>
10<body class="docframe refmanual">
11<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Back</a>&nbsp;<a href="./equal.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>
12<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="./max-element.html" class="navigation-link">max_element</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="max-element">
15<h1><a class="toc-backref" href="./querying-algorithms.html#id411" name="max-element">max_element</a></h1>
16<div class="section" id="max-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename Sequence
21    , typename Pred = <a href="./less.html" class="identifier">less</a>&lt;_1,_2&gt;
22    &gt;
23struct <a href="./max-element.html" class="identifier">max_element</a>
24{
25    typedef <em>unspecified</em> type;
26};
27</pre>
28</div>
29<div class="section" id="max-description">
30<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
31<p>Returns an iterator to the largest element in <tt class="literal"><span class="pre">Sequence</span></tt>.</p>
32</div>
33<div class="section" id="max-header">
34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
35<pre class="literal-block">
36#include &lt;<a href="../../../../boost/mpl/max_element.hpp" class="header">boost/mpl/max_element.hpp</a>&gt;
37</pre>
38</div>
39<div class="section" id="max-parameters">
40<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
41<table border="1" class="table">
42<colgroup>
43<col width="19%" />
44<col width="38%" />
45<col width="43%" />
46</colgroup>
47<thead valign="bottom">
48<tr><th>Parameter</th>
49<th>Requirement</th>
50<th>Description</th>
51</tr>
52</thead>
53<tbody valign="top">
54<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
55<td><a class="reference" href="./forward-sequence.html">Forward Sequence</a></td>
56<td>A sequence to be searched.</td>
57</tr>
58<tr><td><tt class="literal"><span class="pre">Pred</span></tt></td>
59<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
60<td>A comparison criteria.</td>
61</tr>
62</tbody>
63</table>
64</div>
65<div class="section" id="max-expression-semantics">
66<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
67<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>
68<pre class="literal-block">
69typedef <a href="./max-element.html" class="identifier">max_element</a>&lt;s,pred&gt;::type i;
70</pre>
71<table class="field-list" frame="void" rules="none">
72<col class="field-name" />
73<col class="field-body" />
74<tbody valign="top">
75<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>
76</tr>
77<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> 
78in [<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>
79<pre class="last literal-block">
80<a href="./apply.html" class="identifier">apply</a>&lt; pred, <a href="./deref.html" class="identifier">deref</a>&lt;i&gt;::type, <a href="./deref.html" class="identifier">deref</a>&lt;j&gt;::type &gt;::type::value == false
81</pre>
82</td>
83</tr>
84</tbody>
85</table>
86</div>
87<div class="section" id="max-complexity">
88<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
89<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> 
90comparisons.</p>
91</div>
92<div class="section" id="max-example">
93<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
94<pre class="literal-block">
95typedef <a href="./vector.html" class="identifier">vector</a>&lt;bool,char[50],long,double&gt; types;
96typedef <a href="./max-element.html" class="identifier">max_element</a>&lt;
97      <a href="./transform-view.html" class="identifier">transform_view</a>&lt; types,<a href="./sizeof.html" class="identifier">sizeof_</a>&lt;_1&gt; &gt;
98    &gt;::type iter;
99
100<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, char[50]> ));
101</pre>
102</div>
103<div class="section" id="max-see-also">
104<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
105<p><a class="reference" href="./querying-algorithms.html">Querying Algorithms</a>, <a class="refentry reference" href="./min-element.html"><tt class="refentry literal"><span class="pre">min_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>
106<!-- modtime: November 10, 2004 04:37:54 +0000 -->
107<!-- Algorithms/Querying Algorithms//equal |100 -->
108</div>
109</div>
110
111<div class="footer-separator"></div>
112<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./equal.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./min-element.html" class="navigation-link">Back</a>&nbsp;<a href="./equal.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>
113</tr></table></body>
114</html>
Note: See TracBrowser for help on using the repository browser.