feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
0acc783f19e82f92baebd81387e783c771276a82
boost_fusion/doc/html/fusion/sequence/operator/comparison/equal.html

156 lines
9.6 KiB
HTML
Raw Normal View History

Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>equal</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../comparison.html" title="Comparison">
<link rel="prev" href="../comparison.html" title="Comparison">
<link rel="next" href="not_equal.html" title="not
equal">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../../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>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../comparison.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../comparison.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="not_equal.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequence.operator.comparison.equal"></a><a href="equal.html" title="equal">equal</a></h5></div></div></div>
<a name="fusion.sequence.operator.comparison.equal.description"></a><h6>
<a name="id518600"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.description">Description</a>
</h6>
<p>
Compare two sequences for equality.
</p>
<a name="fusion.sequence.operator.comparison.equal.synopsis"></a><h6>
<a name="id518632"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Seq1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Seq2</span><span class="special">&gt;</span>
<span class="keyword">bool</span>
<span class="keyword">operator</span><span class="special">==(</span><span class="identifier">Seq1</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">Seq2</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
</pre>
<a name="fusion.sequence.operator.comparison.equal.parameters"></a><h6>
<a name="id518786"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">a</span><span class="special">,</span>
<span class="identifier">b</span></tt>
</p>
</td>
<td>
<p>
Instances of <a href="../../../sequence.html" title="Sequence">Sequence</a>
</p>
</td>
<td>
<p>
<a href="../../../sequence.html" title="Sequence">Sequence</a>(s) to compare
</p>
</td>
</tr></tbody>
</table></div>
<a name="fusion.sequence.operator.comparison.equal.expression_semantics"></a><h6>
<a name="id518918"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting">
<span class="identifier">a</span> <span class="special">==</span> <span class="identifier">b</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: <tt class="computeroutput"><span class="keyword">bool</span></tt>
</p>
<p>
<span class="bold"><b>Requirements</b></span>:
</p>
<p>
For each element, <tt class="computeroutput"><span class="identifier">e1</span></tt>,
in sequence <tt class="computeroutput"><span class="identifier">a</span></tt>, and for
each element, <tt class="computeroutput"><span class="identifier">e2</span></tt>, in
sequence <tt class="computeroutput"><span class="identifier">b</span></tt>, <tt class="computeroutput"><span class="identifier">a</span> <span class="special">==</span> <span class="identifier">b</span></tt> is a valid expression returning a
type that is convertible to bool.
</p>
<p>
An attempt to compare two Sequences of different lengths results in a
compile time error.
</p>
<p>
<span class="bold"><b>Semantics</b></span>:
</p>
<p>
For each element, <tt class="computeroutput"><span class="identifier">e1</span></tt>,
in sequence <tt class="computeroutput"><span class="identifier">a</span></tt>, and for
each element, <tt class="computeroutput"><span class="identifier">e2</span></tt>, in
sequence <tt class="computeroutput"><span class="identifier">b</span></tt>, <tt class="computeroutput"><span class="identifier">e1</span> <span class="special">==</span> <span class="identifier">e2</span></tt> returns true. For any 2 zero length
<span class="underline">_sequence</span>_s, e and f, e == f returns
true.
</p>
<a name="fusion.sequence.operator.comparison.equal.header"></a><h6>
<a name="id519180"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">comparison</span><span class="special">/</span><span class="identifier">equal_to</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">equal_to</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequence.operator.comparison.equal.example"></a><h6>
<a name="id519351"></a>
<a href="equal.html#fusion.sequence.operator.comparison.equal.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v1</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="char">'a'</span><span class="special">);</span>
<a href="../../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v2</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="char">'a'</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">v1</span> <span class="special">==</span> <span class="identifier">v2</span><span class="special">);</span>
</pre>
</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 <20> 2001-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../comparison.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../comparison.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="not_equal.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Copy Permalink