doc/html/equals.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function equals</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="string_algo/reference.html#id1144873" title="Header &lt;boost/algorithm/string/predicate.hpp&gt;">
<link rel="prev" href="icontains.html" title="Function template icontains">
<link rel="next" href="iequals.html" title="Function template iequals">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="icontains.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id1144873"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="iequals.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="equals"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function equals</span></h2>
<p>boost::algorithm::equals &#8212; 'Equals' predicate </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Range1T, <span class="bold"><strong>typename</strong></span> Range2T, <span class="bold"><strong>typename</strong></span> PredicateT&gt; 
  <span class="type"><span class="bold"><strong>bool</strong></span></span> equals(<span class="bold"><strong>const</strong></span> Range1T &amp; Input, <span class="bold"><strong>const</strong></span> Range2T &amp; Test, PredicateT Comp);
<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Range1T, <span class="bold"><strong>typename</strong></span> Range2T&gt; 
  <span class="type"><span class="bold"><strong>bool</strong></span></span> equals(<span class="bold"><strong>const</strong></span> Range1T &amp; Input, <span class="bold"><strong>const</strong></span> Range2T &amp; Test);</pre></div>
<div class="refsect1" lang="en">
<a name="id1327427"></a><h2>Description</h2>
<p>This predicate holds when the test container is equal to the input container i.e. all elements in both containers are same. When the optional predicate is specified, it is used for character-wise comparison.</p>
<p></p>
<div class="variablelist">
<p class="title"><b>Parameters</b></p>
<dl>
<dt><span class="term">Comp</span></dt>
<dd><p>An element comparison predicate </p></dd>
<dt><span class="term">Input</span></dt>
<dd><p>An input sequence </p></dd>
<dt><span class="term">Test</span></dt>
<dd><p>A test sequence </p></dd>
</dl>
</div>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:

    The result of the test<br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Notes</span></b>:

    This is a two-way version of <code class="computeroutput">std::equal</code>  algorithm<p>This function provides the strong exception-safety guarantee </p></p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="icontains.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#id1144873"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="iequals.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>