Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/equal.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 8.0 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: equal</title>
8<link rel="stylesheet" href="../style.css" type="text/css" />
9</head>
10<body class="docframe refmanual">
11<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./max-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./transformation-algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./max-element.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
12<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./querying-algorithms.html" class="navigation-link">Querying Algorithms</a> / <a href="./equal.html" class="navigation-link">equal</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="equal">
15<h1><a class="toc-backref" href="./querying-algorithms.html#id412" name="equal">equal</a></h1>
16<div class="section" id="equal-synopsis">
17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
18<pre class="literal-block">
19template&lt;
20      typename Seq1
21    , typename Seq2
22    , typename Pred = is_same&lt;_1,_2&gt;
23    &gt;
24struct <a href="./equal.html" class="identifier">equal</a>
25{
26    typedef <em>unspecified</em> type;
27};
28</pre>
29</div>
30<div class="section" id="equal-description">
31<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
32<p>Returns a true-valued <a class="reference" href="./integral-constant.html">Integral Constant</a> if the two sequences <tt class="literal"><span class="pre">Seq1</span></tt> 
33and <tt class="literal"><span class="pre">Seq2</span></tt> are identical when compared element-by-element.</p>
34</div>
35<div class="section" id="equal-header">
36<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
37<pre class="literal-block">
38#include &lt;<a href="../../../../boost/mpl/equal.hpp" class="header">boost/mpl/equal.hpp</a>&gt;
39</pre>
40</div>
41<div class="section" id="equal-parameters">
42<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
43<table border="1" class="table">
44<colgroup>
45<col width="22%" />
46<col width="36%" />
47<col width="41%" />
48</colgroup>
49<thead valign="bottom">
50<tr><th>Parameter</th>
51<th>Requirement</th>
52<th>Description</th>
53</tr>
54</thead>
55<tbody valign="top">
56<tr><td><tt class="literal"><span class="pre">Seq1</span></tt>, <tt class="literal"><span class="pre">Seq2</span></tt></td>
57<td><a class="reference" href="./forward-sequence.html">Forward Sequence</a></td>
58<td>Sequences to compare.</td>
59</tr>
60<tr><td><tt class="literal"><span class="pre">Pred</span></tt></td>
61<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
62<td>A comparison criterion.</td>
63</tr>
64</tbody>
65</table>
66</div>
67<div class="section" id="equal-expression-semantics">
68<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
69<p>For any <a class="reference" href="./forward-sequence.html">Forward Sequence</a>s <tt class="literal"><span class="pre">s1</span></tt> and <tt class="literal"><span class="pre">s2</span></tt> and a binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">pred</span></tt>:</p>
70<pre class="literal-block">
71typedef <a href="./equal.html" class="identifier">equal</a>&lt;s1,s2,pred&gt;::type c;
72</pre>
73<table class="field-list" frame="void" rules="none">
74<col class="field-name" />
75<col class="field-body" />
76<tbody valign="top">
77<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference" href="./integral-constant.html">Integral Constant</a></td>
78</tr>
79<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">true</span></tt> is and only if <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s1&gt;::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s2&gt;::value</span></tt> 
80and for every iterator <tt class="literal"><span class="pre">i</span></tt> in [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s1&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s1&gt;::type</span></tt>) <tt class="literal"><span class="pre"><a href="./deref.html" class="identifier">deref</a>&lt;i&gt;::type</span></tt> is identical to</p>
81<pre class="last literal-block">
82<a href="./advance.html" class="identifier">advance</a>&lt; <a href="./begin.html" class="identifier">begin</a>&lt;s2&gt;::type, <a href="./distance.html" class="identifier">distance</a>&lt; <a href="./begin.html" class="identifier">begin</a>&lt;s1&gt;::type,i &gt;::type &gt;::type
83</pre>
84</td>
85</tr>
86</tbody>
87</table>
88</div>
89<div class="section" id="equal-complexity">
90<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
91<p>Linear. At most <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s1&gt;::value</span></tt> comparisons.</p>
92</div>
93<div class="section" id="equal-example">
94<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
95<pre class="literal-block">
96typedef <a href="./vector.html" class="identifier">vector</a>&lt;char,int,unsigned,long,unsigned long&gt; s1;
97typedef <a href="./list.html" class="identifier">list</a>&lt;char,int,unsigned,long,unsigned long&gt; s2;
98
99<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt;s1,s2&gt; ));
100</pre>
101</div>
102<div class="section" id="equal-see-also">
103<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
104<p><a class="reference" href="./querying-algorithms.html">Querying Algorithms</a>, <a class="refentry reference" href="./find.html"><tt class="refentry literal"><span class="pre">find</span></tt></a>, <a class="refentry reference" href="./find-if.html"><tt class="refentry literal"><span class="pre">find_if</span></tt></a></p>
105<!-- modtime: November 10, 2004 04:42:44 +0000 -->
106</div>
107</div>
108
109<div class="footer-separator"></div>
110<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./max-element.html" class="navigation-link">Prev</a>&nbsp;<a href="./transformation-algorithms.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./max-element.html" class="navigation-link">Back</a>&nbsp;Along</span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./querying-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
111</tr></table></body>
112</html>
Note: See TracBrowser for help on using the repository browser.