doc/stdlibref/max-element.html - stdcxx - Git at Google

 <HTML>
 <HEAD>
 <TITLE>max_element()</TITLE>
 <LINK REL=StyleSheet HREF="../rw.css" TYPE="text/css" TITLE="Apache stdcxx Stylesheet"></HEAD>
 <BODY BGCOLOR=#FFFFFF>
 <A HREF="max.html"><IMG SRC="images/bprev.gif" WIDTH=20 HEIGHT=21 ALT="Previous file" BORDER=O></A><A HREF="noframes.html"><IMG SRC="images/btop.gif" WIDTH=56 HEIGHT=21 ALT="Top of Document" BORDER=O></A><A HREF="booktoc.html"><IMG SRC="images/btoc.gif" WIDTH=56 HEIGHT=21 ALT="Contents" BORDER=O></A><A HREF="tindex.html"><IMG SRC="images/bindex.gif" WIDTH=56 HEIGHT=21 ALT="Index page" BORDER=O></A><A HREF="mem-fun.html"><IMG SRC="images/bnext.gif" WIDTH=25 HEIGHT=21 ALT="Next file" BORDER=O></A><DIV CLASS="DOCUMENTNAME"><B>Apache C++ Standard Library Reference Guide</B></DIV>
 <H2>max_element()</H2>
 <P><B>Library:</B>&nbsp;&nbsp;<A HREF="2-9.html">Algorithms</A></P>

 <PRE><HR><B><I>Function</I></B><HR></PRE>

 <UL>
 <LI><A HREF="#sec1">Local Index</A></LI>
 <LI><A HREF="#sec2">Summary</A></LI>
 <LI><A HREF="#sec3">Synopsis</A></LI>
 <LI><A HREF="#sec4">Description</A></LI>
 <LI><A HREF="#sec5">Complexity</A></LI>
 <LI><A HREF="#sec6">Example</A></LI>
 <LI><A HREF="#sec7">See Also</A></LI>
 <LI><A HREF="#sec8">Standards Conformance</A></LI>
 </UL>
 <A NAME="sec1"><H3>Local Index</H3></A>
 No Entries
 <A NAME="sec2"><H3>Summary</H3></A>
 <P>An algorithm that finds the maximum value in a range</P>
 <A NAME="sec3"><H3>Synopsis</H3></A>

 <PRE>#include &lt;algorithm&gt;

 namespace std {
   template &lt;class ForwardIterator&gt;
   ForwardIterator
   max_element(ForwardIterator start, ForwardIterator finish);

   template &lt;class ForwardIterator, class Compare&gt;
   ForwardIterator
   max_element(ForwardIterator start, ForwardIterator finish,
               Compare comp);
 }
 </PRE>
 <A NAME="sec4"><H3>Description</H3></A>
 <P>The <SAMP>max_element()</SAMP> algorithm returns an iterator that denotes the maximum element in a sequence. If the sequence contains more than one copy of the element, the iterator points to its first occurrence. The optional argument <SAMP>comp</SAMP> defines a function object that can be used in place of <SAMP>operator&lt;()</SAMP>.</P>
 <P>Algorithm <SAMP>max_element()</SAMP> returns the first iterator <SAMP>i</SAMP> in the range <SAMP>[start, finish)</SAMP> such that for any iterator <SAMP>j</SAMP> in the same range either of the following conditions hold:</P>
 <P><SAMP>!(*i &lt; *j) </SAMP></P>
 <P>or</P>
 <P><SAMP>comp(*i, *j) == false. </SAMP></P>
 <A NAME="sec5"><H3>Complexity</H3></A>
 <P>Exactly <SAMP>max((finish - start) - 1, 0)</SAMP> applications of the corresponding comparisons are done for <SAMP>max_element()</SAMP>. </P>
 <A NAME="sec6"><H3>Example</H3></A>

 <UL><PRE>//
 //  max_elem.cpp
 //

 #include &lt;algorithm&gt;    // for max_element
 #include &lt;functional&gt;   // for less
 #include &lt;iostream&gt;     // for cout, endl
 #include &lt;vector&gt;       // for vector


 int main ()
 {
     typedef std::vector&lt;int, std::allocator&lt;int&gt; &gt; Vector;
     typedef Vector::iterator                       Iterator;

     const Vector::value_type d1[] = { 1, 3, 5, 32, 64 };
     // Set up vector.
     Vector v1(d1 + 0, d1 + sizeof d1 / sizeof *d1);

     // Find the largest element in the vector.
     Iterator it1 = std::max_element (v1.begin(), v1.end());

     // Find the largest element in the range from
     // the beginning of the vector to the 2nd to last.
     Iterator it2 = std::max_element (v1.begin(), v1.end() - 1,
                                      std::less&lt;int&gt;());

     // Find the smallest element.
     Iterator it3 = std::min_element (v1.begin(), v1.end());

     // Find the smallest value in the range from
     // the beginning of the vector plus 1 to the end.
     Iterator it4 = std::min_element (v1.begin() + 1, v1.end(),
                                      std::less&lt;int&gt;());

     std::cout &lt;&lt; *it1 &lt;&lt; " " &lt;&lt; *it2 &lt;&lt; " "
               &lt;&lt; *it3 &lt;&lt; " " &lt;&lt; *it4 &lt;&lt; std::endl;

     return 0;
 }


 Program Output:
 </PRE></UL>
 <UL><PRE>64 32 1 3
 </PRE></UL>
 <A NAME="sec7"><H3>See Also</H3></A>
 <P><SAMP><A HREF="max.html">max()</A></SAMP>, <SAMP><A HREF="min.html">min()</A></SAMP>, <SAMP><A HREF="min-element.html">min_element()</A></SAMP></P>
 <A NAME="sec8"><H3>Standards Conformance</H3></A>
 <P><I>ISO/IEC 14882:1998 -- International Standard for Information Systems -- Programming Language C++, Section 25.3.7</I></P>

 <BR>
 <HR>
 <A HREF="max.html"><IMG SRC="images/bprev.gif" WIDTH=20 HEIGHT=21 ALT="Previous file" BORDER=O></A><A HREF="noframes.html"><IMG SRC="images/btop.gif" WIDTH=56 HEIGHT=21 ALT="Top of Document" BORDER=O></A><A HREF="booktoc.html"><IMG SRC="images/btoc.gif" WIDTH=56 HEIGHT=21 ALT="Contents" BORDER=O></A><A HREF="tindex.html"><IMG SRC="images/bindex.gif" WIDTH=56 HEIGHT=21 ALT="Index page" BORDER=O></A><A HREF="mem-fun.html"><IMG SRC="images/bnext.gif" WIDTH=20 HEIGHT=21 ALT="Next file" BORDER=O></A>

 <!-- Google Analytics tracking code -->
 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
 </script>
 <script type="text/javascript">
     _uacct = "UA-1775151-1";
     urchinTracker();
 </script>
 <!-- end of Google Analytics tracking code -->

 </BODY>
 </HTML>
	<HTML>
	<HEAD>
	<TITLE>max_element()</TITLE>
	<LINK REL=StyleSheet HREF="../rw.css" TYPE="text/css" TITLE="Apache stdcxx Stylesheet"></HEAD>
	<BODY BGCOLOR=#FFFFFF>
	<A HREF="max.html"><IMG SRC="images/bprev.gif" WIDTH=20 HEIGHT=21 ALT="Previous file" BORDER=O></A><A HREF="noframes.html"><IMG SRC="images/btop.gif" WIDTH=56 HEIGHT=21 ALT="Top of Document" BORDER=O></A><A HREF="booktoc.html"><IMG SRC="images/btoc.gif" WIDTH=56 HEIGHT=21 ALT="Contents" BORDER=O></A><A HREF="tindex.html"><IMG SRC="images/bindex.gif" WIDTH=56 HEIGHT=21 ALT="Index page" BORDER=O></A><A HREF="mem-fun.html"><IMG SRC="images/bnext.gif" WIDTH=25 HEIGHT=21 ALT="Next file" BORDER=O></A><DIV CLASS="DOCUMENTNAME"><B>Apache C++ Standard Library Reference Guide</B></DIV>
	<H2>max_element()</H2>
	<P><B>Library:</B>  <A HREF="2-9.html">Algorithms</A></P>

	<PRE><HR><B><I>Function</I></B><HR></PRE>

	<UL>
	<LI><A HREF="#sec1">Local Index</A></LI>
	<LI><A HREF="#sec2">Summary</A></LI>
	<LI><A HREF="#sec3">Synopsis</A></LI>
	<LI><A HREF="#sec4">Description</A></LI>
	<LI><A HREF="#sec5">Complexity</A></LI>
	<LI><A HREF="#sec6">Example</A></LI>
	<LI><A HREF="#sec7">See Also</A></LI>
	<LI><A HREF="#sec8">Standards Conformance</A></LI>
	</UL>
	<A NAME="sec1"><H3>Local Index</H3></A>
	No Entries
	<A NAME="sec2"><H3>Summary</H3></A>
	<P>An algorithm that finds the maximum value in a range</P>
	<A NAME="sec3"><H3>Synopsis</H3></A>

	<PRE>#include <algorithm>

	namespace std {
	template <class ForwardIterator>
	ForwardIterator
	max_element(ForwardIterator start, ForwardIterator finish);

	template <class ForwardIterator, class Compare>
	ForwardIterator
	max_element(ForwardIterator start, ForwardIterator finish,
	Compare comp);
	}
	</PRE>
	<A NAME="sec4"><H3>Description</H3></A>
	<P>The <SAMP>max_element()</SAMP> algorithm returns an iterator that denotes the maximum element in a sequence. If the sequence contains more than one copy of the element, the iterator points to its first occurrence. The optional argument <SAMP>comp</SAMP> defines a function object that can be used in place of <SAMP>operator<()</SAMP>.</P>
	<P>Algorithm <SAMP>max_element()</SAMP> returns the first iterator <SAMP>i</SAMP> in the range <SAMP>[start, finish)</SAMP> such that for any iterator <SAMP>j</SAMP> in the same range either of the following conditions hold:</P>
	<P><SAMP>!(i < j) </SAMP></P>
	<P>or</P>
	<P><SAMP>comp(i, j) == false. </SAMP></P>
	<A NAME="sec5"><H3>Complexity</H3></A>
	<P>Exactly <SAMP>max((finish - start) - 1, 0)</SAMP> applications of the corresponding comparisons are done for <SAMP>max_element()</SAMP>. </P>
	<A NAME="sec6"><H3>Example</H3></A>

	<UL><PRE>//
	// max_elem.cpp
	//

	#include <algorithm> // for max_element
	#include <functional> // for less
	#include <iostream> // for cout, endl
	#include <vector> // for vector


	int main ()
	{
	typedef std::vector<int, std::allocator<int> > Vector;
	typedef Vector::iterator Iterator;

	const Vector::value_type d1[] = { 1, 3, 5, 32, 64 };
	// Set up vector.
	Vector v1(d1 + 0, d1 + sizeof d1 / sizeof *d1);

	// Find the largest element in the vector.
	Iterator it1 = std::max_element (v1.begin(), v1.end());

	// Find the largest element in the range from
	// the beginning of the vector to the 2nd to last.
	Iterator it2 = std::max_element (v1.begin(), v1.end() - 1,
	std::less<int>());

	// Find the smallest element.
	Iterator it3 = std::min_element (v1.begin(), v1.end());

	// Find the smallest value in the range from
	// the beginning of the vector plus 1 to the end.
	Iterator it4 = std::min_element (v1.begin() + 1, v1.end(),
	std::less<int>());

	std::cout << it1 << " " << it2 << " "
	<< it3 << " " << it4 << std::endl;

	return 0;
	}


	Program Output:
	</PRE></UL>
	<UL><PRE>64 32 1 3
	</PRE></UL>
	<A NAME="sec7"><H3>See Also</H3></A>
	<P><SAMP><A HREF="max.html">max()</A></SAMP>, <SAMP><A HREF="min.html">min()</A></SAMP>, <SAMP><A HREF="min-element.html">min_element()</A></SAMP></P>
	<A NAME="sec8"><H3>Standards Conformance</H3></A>
	<P><I>ISO/IEC 14882:1998 -- International Standard for Information Systems -- Programming Language C++, Section 25.3.7</I></P>

	<BR>
	<HR>
	<A HREF="max.html"><IMG SRC="images/bprev.gif" WIDTH=20 HEIGHT=21 ALT="Previous file" BORDER=O></A><A HREF="noframes.html"><IMG SRC="images/btop.gif" WIDTH=56 HEIGHT=21 ALT="Top of Document" BORDER=O></A><A HREF="booktoc.html"><IMG SRC="images/btoc.gif" WIDTH=56 HEIGHT=21 ALT="Contents" BORDER=O></A><A HREF="tindex.html"><IMG SRC="images/bindex.gif" WIDTH=56 HEIGHT=21 ALT="Index page" BORDER=O></A><A HREF="mem-fun.html"><IMG SRC="images/bnext.gif" WIDTH=20 HEIGHT=21 ALT="Next file" BORDER=O></A>

	<!-- Google Analytics tracking code -->
	<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
	</script>
	<script type="text/javascript">
	_uacct = "UA-1775151-1";
	urchinTracker();
	</script>
	<!-- end of Google Analytics tracking code -->

	</BODY>
	</HTML>