blob: 77d4dd41e3d20d09f7ec733d4bb561d274e30199 [file] [log] [blame]
<HTML>
<HEAD>
<TITLE>equal_to</TITLE>
<LINK REL=StyleSheet HREF="../rw.css" TYPE="text/css" TITLE="Apache stdcxx Stylesheet"></HEAD>
<BODY BGCOLOR=#FFFFFF>
<A HREF="equal-range.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="exception.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>equal_to</H2>
<P><B>Library:</B>&nbsp;&nbsp;<A HREF="2-4.html">General utilities</A></P>
<PRE><HR><B><I>Does not inherit</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">Interface</A></LI>
<LI><A HREF="#sec6">See Also</A></LI>
<LI><A HREF="#sec7">Standards Conformance</A></LI>
</UL>
<A NAME="sec1"><H3>Local Index</H3></A>
No Entries
<A NAME="sec2"><H3>Summary</H3></A>
<P>A binary function object that returns <SAMP>true</SAMP> if its first argument equals its second</P>
<A NAME="sec3"><H3>Synopsis</H3></A>
<PRE>#include &lt;functional&gt;
namespace std {
template &lt;class T&gt;
struct equal_to;
}
</PRE>
<A NAME="sec4"><H3>Description</H3></A>
<P><B><I>equal_to</I></B> is a binary function object. Its <SAMP>operator()</SAMP> returns <SAMP>true</SAMP> if <SAMP>x</SAMP> is equal to <SAMP>y</SAMP>. You can pass an <B><I>equal_to</I></B> object to any algorithm that requires a binary function. For example, the <SAMP><A HREF="find-if.html">find_if()</A></SAMP> algorithm finds the first occurrence of any value from one sequence in another sequence as determined by applying a binary comparison operation. <B><I>equal_to</I></B> would be used in that algorithm in the following manner:</P>
<UL><PRE>
vector&lt;int&gt; vec1;
vector&lt;int&gt; vec2;
vector&lt;int&gt;::iterator iter1;
.
.
.
iter1 = find_if(vec1.begin(), vec1.end(),
vec2.begin(), vec2.end(), <B>equal_to</B>&lt;int&gt;());
</PRE></UL>
<P>After this call to <SAMP><A HREF="find-if.html">find_if()</A></SAMP>, <SAMP>iter1</SAMP> points to the first element in <SAMP>vec1</SAMP> for which <SAMP>equal_to(vec1[n],vec2[n])</SAMP> returned <SAMP>true</SAMP>; or, if there were no matches, <SAMP>iter1</SAMP> points to <SAMP>vec2.end()</SAMP>.</P>
<A NAME="sec5"><H3>Interface</H3></A>
<UL><PRE>namespace std {
template &lt;class T&gt;
struct equal_to : binary_function&lt;T, T, bool&gt; {
bool operator()(const T&amp; x, const T&amp; y) const;
};
}
</PRE></UL>
<A NAME="sec6"><H3>See Also</H3></A>
<P><B><I><A HREF="binary-function.html">binary_function</A></I></B>, <A HREF="functionobjects.html">Function Objects</A></P>
<A NAME="sec7"><H3>Standards Conformance</H3></A>
<P><I>ISO/IEC 14882:1998 -- International Standard for Information Systems -- Programming Language C++, Section 20.3.3</I></P>
<BR>
<HR>
<A HREF="equal-range.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="exception.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>