| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed |
| with this work for additional information regarding copyright |
| ownership. The ASF licenses this file to you under the Apache |
| License, Version 2.0 (the License); you may not use this file |
| except in compliance with the License. You may obtain a copy of |
| the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| implied. See the License for the specific language governing |
| permissions and limitations under the License. |
| |
| Copyright 1999-2007 Rogue Wave Software, Inc. |
| --> |
| |
| <HTML> |
| <HEAD> |
| <TITLE>includes()</TITLE> |
| <LINK REL=StyleSheet HREF="../rw.css" TYPE="text/css" TITLE="Apache stdcxx Stylesheet"></HEAD> |
| <BODY BGCOLOR=#FFFFFF> |
| <A HREF="heapoperations.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="indirect-array.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>includes()</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 returns true if every element in one sorted sequence is contained in another sorted sequence</P> |
| <A NAME="sec3"><H3>Synopsis</H3></A> |
| |
| <PRE>#include <algorithm> |
| |
| namespace std { |
| template <class InputIterator1, class InputIterator2> |
| bool includes(InputIterator1 start1, InputIterator1 finish1, |
| InputIterator2 start2, |
| InputIterator2 finish2); |
| |
| template <class InputIterator1, class InputIterator2, |
| class Compare> |
| bool includes(InputIterator1 start1, InputIterator1 finish1, |
| InputIterator2 start2, |
| InputIterator2 finish2, Compare comp); |
| } |
| </PRE> |
| <A NAME="sec4"><H3>Description</H3></A> |
| <P>The <SAMP>includes()</SAMP> algorithm compares two sorted sequences and returns <SAMP>true</SAMP> if every element in the range <SAMP>[start2, finish2)</SAMP> is contained in the range <SAMP>[start1, finish1)</SAMP>. It returns <SAMP>false</SAMP> otherwise. <SAMP>includes()</SAMP> assumes that the sequences are sorted using <SAMP>operator<()</SAMP>, or using the predicate <SAMP>comp</SAMP>.</P> |
| <A NAME="sec5"><H3>Complexity</H3></A> |
| <P>At most <SAMP>((finish1 - start1) + (finish2 - start2)) * 2 - 1</SAMP> comparisons are performed.</P> |
| <A NAME="sec6"><H3>Example</H3></A> |
| |
| <UL><PRE>// |
| // includes.cpp |
| // |
| |
| #include <algorithm> // for includes |
| #include <iostream> // for cout, endl |
| #include <set> // for set |
| |
| |
| |
| int main () |
| { |
| // Typedefs for convenience. |
| typedef std::set<int, std::less<int>, std::allocator<int> > |
| Set; |
| typedef std::ostream_iterator<int, char, |
| std::char_traits<char> > |
| os_iter; |
| |
| int a1[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; |
| int a2[] = { 2, 4, 6, 8, 10, 12 }; |
| int a3[] = { 3, 5, 7, 8 }; |
| |
| // Initialize three sets. |
| Set all (a1, a1 + sizeof a1 / sizeof *a1); |
| Set even (a2, a2 + sizeof a2 / sizeof *a2); |
| Set other (a3, a3 + sizeof a3 / sizeof *a3); |
| |
| // Demonstrate includes. |
| std::cout << "The set: "; |
| std::copy (all.begin (), all.end (), |
| os_iter (std::cout, " ")); |
| |
| bool answer = std::includes (all.begin (), all.end (), |
| other.begin (), other.end ()); |
| |
| std::cout << std::endl |
| << (answer ? "INCLUDES " : "DOES NOT INCLUDE "); |
| std::copy (other.begin (), other.end (), |
| os_iter (std::cout, " ")); |
| |
| answer = std::includes (all.begin (), all.end (), |
| even.begin (), even.end ()); |
| |
| std::cout << ", and" << std::endl |
| << (answer ? "INCLUDES" : "DOES NOT INCLUDE "); |
| |
| std::copy (even.begin (), even.end (), |
| os_iter (std::cout, " ")); |
| |
| std::cout << std::endl << std::endl; |
| |
| return 0; |
| } |
| |
| |
| Program Output: |
| The set: 1 2 3 4 5 6 7 8 9 10 |
| INCLUDES 3 5 7 8 , and |
| DOES NOT INCLUDE 2 4 6 8 10 12 |
| </PRE></UL> |
| <UL><PRE></PRE></UL> |
| <A NAME="sec7"><H3>See Also</H3></A> |
| <P><SAMP><A HREF="set-union.html">set_union()</A></SAMP>, <SAMP><A HREF="set-intersection.html">set_intersection()</A></SAMP>, <SAMP><A HREF="set-difference.html">set_difference()</A></SAMP>, <SAMP><A HREF="set-symmetric-difference.html">set_symmetric_difference()</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.5.1</I></P> |
| |
| <BR> |
| <HR> |
| <A HREF="heapoperations.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="indirect-array.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> |
