• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Function template iequals</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_hpp" title="Header &lt;boost/algorithm/string/predicate.hpp&gt;">
10<link rel="prev" href="equals.html" title="Function equals">
11<link rel="next" href="lexicographical_compare.html" title="Function lexicographical_compare">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="equals.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lexicographical_compare.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.algorithm.iequals"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Function template iequals</span></h2>
30<p>boost::algorithm::iequals — 'Equals' predicate ( case insensitive ) </p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_hpp" title="Header &lt;boost/algorithm/string/predicate.hpp&gt;">boost/algorithm/string/predicate.hpp</a>&gt;
34
35</span>
36<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">&gt;</span>
37  <span class="keyword">bool</span> <span class="identifier">iequals</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&amp;</span> Input<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Range2T</span> <span class="special">&amp;</span> Test<span class="special">,</span>
38               <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&amp;</span> Loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
39<div class="refsect1">
40<a name="id-1.3.3.9.16.12.4"></a><h2>Description</h2>
41<p>This predicate holds when the test container is equal to the input container i.e. all elements in both containers are same. Elements are compared case insensitively.</p>
42<p>
43
44</p>
45<div class="note"><table border="0" summary="Note">
46<tr>
47<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
48<th align="left">Note</th>
49</tr>
50<tr><td align="left" valign="top"><p>This is a two-way version of <code class="computeroutput">std::equal</code> algorithm</p></td></tr>
51</table></div>
52<p>
53</p>
54<div class="note"><table border="0" summary="Note">
55<tr>
56<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
57<th align="left">Note</th>
58</tr>
59<tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr>
60</table></div>
61<p>
62</p>
63<div class="variablelist"><table border="0" class="variablelist compact">
64<colgroup>
65<col align="left" valign="top">
66<col>
67</colgroup>
68<tbody>
69<tr>
70<td><p><span class="term">Parameters:</span></p></td>
71<td><div class="variablelist"><table border="0" class="variablelist compact">
72<colgroup>
73<col align="left" valign="top">
74<col>
75</colgroup>
76<tbody>
77<tr>
78<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
79<td><p>An input sequence </p></td>
80</tr>
81<tr>
82<td><p><span class="term"><code class="computeroutput">Loc</code></span></p></td>
83<td><p>A locale used for case insensitive comparison </p></td>
84</tr>
85<tr>
86<td><p><span class="term"><code class="computeroutput">Test</code></span></p></td>
87<td><p>A test sequence </p></td>
88</tr>
89</tbody>
90</table></div></td>
91</tr>
92<tr>
93<td><p><span class="term">Returns:</span></p></td>
94<td><p>The result of the test</p></td>
95</tr>
96</tbody>
97</table></div>
98</div>
99</div>
100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
101<td align="left"></td>
102<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
103                Software License, Version 1.0. (See accompanying file
104                <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
105            </p>
106</div></td>
107</tr></table>
108<hr>
109<div class="spirit-nav">
110<a accesskey="p" href="equals.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lexicographical_compare.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
111</div>
112</body>
113</html>
114