feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
74d062d2da7bb1a4e6e1a6f2577209b4d17d0b51
boost_fusion/doc/html/fusion/sequences/operators/comparison/equal.html
Tobias Schwinger ca6f831b96 adds documentation for functional module 
[SVN r36959]
2007-02-15 23:11:24 +00:00

133 lines
8.6 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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.68.1">
<link rel="start" href="../../../../index.html" title="Chapter 1. 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%">
<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>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../comparison.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../comparison.html"><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="not_equal.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.operators.comparison.equal"></a><a href="equal.html" title="equal">equal</a></h5></div></div></div>
<a name="fusion.sequences.operators.comparison.equal.description"></a><h6>
<a name="id1075563"></a>
<a href="equal.html#fusion.sequences.operators.comparison.equal.description">Description</a>
</h6>
<p>
Compare two sequences for equality.
</p>
<a name="fusion.sequences.operators.comparison.equal.synopsis"></a><h6>
<a name="id1075592"></a>
<a href="equal.html#fusion.sequences.operators.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.sequences.operators.comparison.equal.parameters"></a><h6>
<a name="id1075727"></a>
<a href="equal.html#fusion.sequences.operators.comparison.equal.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><code class="computeroutput"><span class="identifier">a</span><span class="special">,</span>
<span class="identifier">b</span></code></td>
<td>Instances
of <a href="../../../sequences.html" title="Sequences">Sequence</a>
</td>
<td>
<span class="underline">_sequence</span>_s to compare</td>
</tr></tbody>
</table></div>
<a name="fusion.sequences.operators.comparison.equal.expression_semantics"></a><h6>
<a name="id1075820"></a>
<a href="equal.html#fusion.sequences.operators.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"><strong>Return type</strong></span>: <code class="computeroutput"><span class="keyword">bool</span></code>
</p>
<p>
<span class="bold"><strong>Requirements</strong></span>:
</p>
<p>
For each element, <code class="computeroutput"><span class="identifier">e1</span></code>,
in sequence <code class="computeroutput"><span class="identifier">a</span></code>, and for
each element, <code class="computeroutput"><span class="identifier">e2</span></code>, in
sequence <code class="computeroutput"><span class="identifier">b</span></code>, <code class="computeroutput"><span class="identifier">a</span> <span class="special">==</span> <span class="identifier">b</span></code> 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"><strong>Semantics</strong></span>:
</p>
<p>
For each element, <code class="computeroutput"><span class="identifier">e1</span></code>,
in sequence <code class="computeroutput"><span class="identifier">a</span></code>, and for
each element, <code class="computeroutput"><span class="identifier">e2</span></code>, in
sequence <code class="computeroutput"><span class="identifier">b</span></code>, <code class="computeroutput"><span class="identifier">e1</span> <span class="special">==</span> <span class="identifier">e2</span></code> returns true. For any 2 zero length
<span class="underline">_sequence</span>_s, e and f, e == f returns
true.
</p>
<a name="fusion.sequences.operators.comparison.equal.header"></a><h6>
<a name="id1075827"></a>
<a href="equal.html#fusion.sequences.operators.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>
</pre>
<a name="fusion.sequences.operators.comparison.equal.example"></a><h6>
<a name="id1076126"></a>
<a href="equal.html#fusion.sequences.operators.comparison.equal.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></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="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></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 © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../comparison.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../comparison.html"><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="not_equal.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
View Git Blame Copy Permalink