• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Relational operators</title>
5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../index.html" title="Chapter 1. Fusion 2.2">
8<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
9<link rel="prev" href="element_access.html" title="Element access">
10<link rel="next" href="../pairs.html" title="Pairs">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="element_access.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../class_template_tuple.html"><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="../pairs.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="fusion.tuple.class_template_tuple.relational_operators"></a><a class="link" href="relational_operators.html" title="Relational operators">Relational
28        operators</a>
29</h4></div></div></div>
30<h6>
31<a name="fusion.tuple.class_template_tuple.relational_operators.h0"></a>
32          <span class="phrase"><a name="fusion.tuple.class_template_tuple.relational_operators.description"></a></span><a class="link" href="relational_operators.html#fusion.tuple.class_template_tuple.relational_operators.description">Description</a>
33        </h6>
34<p>
35          The <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2002/n1403.pdf" target="_top">TR1
36          Tuple</a> provides the standard boolean relational operators.
37        </p>
38<h6>
39<a name="fusion.tuple.class_template_tuple.relational_operators.h1"></a>
40          <span class="phrase"><a name="fusion.tuple.class_template_tuple.relational_operators.specification"></a></span><a class="link" href="relational_operators.html#fusion.tuple.class_template_tuple.relational_operators.specification">Specification</a>
41        </h6>
42<div class="variablelist">
43<p class="title"><b>Notation</b></p>
44<dl class="variablelist">
45<dt><span class="term"><code class="computeroutput"><span class="identifier">T1</span> <span class="special">...</span>
46            <span class="identifier">TN</span></code>, <code class="computeroutput"><span class="identifier">U1</span>
47            <span class="special">...</span> <span class="identifier">UN</span></code></span></dt>
48<dd><p>
49                Tuple element types
50              </p></dd>
51<dt><span class="term"><code class="computeroutput"><span class="identifier">P1</span> <span class="special">...</span>
52            <span class="identifier">PN</span></code></span></dt>
53<dd><p>
54                Parameter types
55              </p></dd>
56<dt><span class="term"><code class="computeroutput"><span class="identifier">Ti</span></code>, <code class="computeroutput"><span class="identifier">Ui</span></code></span></dt>
57<dd><p>
58                The type of the <code class="computeroutput"><span class="identifier">i</span></code>th
59                element of a tuple
60              </p></dd>
61<dt><span class="term"><code class="computeroutput"><span class="identifier">Pi</span></code></span></dt>
62<dd><p>
63                The type of the <code class="computeroutput"><span class="identifier">i</span></code>th
64                parameter
65              </p></dd>
66</dl>
67</div>
68<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
69         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
70<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span>
71    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
72    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
73</pre>
74<p>
75          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
76          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
77          <span class="identifier">i</span> <span class="special">&lt;</span>
78          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span> <span class="special">==</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span></code>
79          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
80        </p>
81<p>
82          <span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="keyword">true</span></code>
83          if and only if <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span> <span class="special">==</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span></code>
84          for all <code class="computeroutput"><span class="identifier">i</span></code>. For any 2 zero
85          length tuples <code class="computeroutput"><span class="identifier">e</span></code> and <code class="computeroutput"><span class="identifier">f</span></code>, <code class="computeroutput"><span class="identifier">e</span>
86          <span class="special">==</span> <span class="identifier">f</span></code>
87          returns <code class="computeroutput"><span class="keyword">true</span></code>.
88        </p>
89<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
90         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
91<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">&lt;(</span>
92    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
93    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
94</pre>
95<p>
96          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
97          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
98          <span class="identifier">i</span> <span class="special">&lt;</span>
99          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span> <span class="special">&lt;</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span></code>
100          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
101        </p>
102<p>
103          <span class="bold"><strong>Semantics</strong></span>: Returns the lexicographical
104          comparison of between <code class="computeroutput"><span class="identifier">lhs</span></code>
105          and <code class="computeroutput"><span class="identifier">rhs</span></code>.
106        </p>
107<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
108         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
109<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span>
110    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
111    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
112</pre>
113<p>
114          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
115          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
116          <span class="identifier">i</span> <span class="special">&lt;</span>
117          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span> <span class="special">==</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span></code>
118          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
119        </p>
120<p>
121          <span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="special">!(</span><span class="identifier">lhs</span> <span class="special">==</span> <span class="identifier">rhs</span><span class="special">)</span></code>.
122        </p>
123<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
124         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
125<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">&lt;=(</span>
126    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
127    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
128</pre>
129<p>
130          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
131          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
132          <span class="identifier">i</span> <span class="special">&lt;</span>
133          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">&lt;</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span></code>
134          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
135        </p>
136<p>
137          <span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="special">!(</span><span class="identifier">rhs</span> <span class="special">&lt;</span> <span class="identifier">lhs</span><span class="special">)</span></code>
138        </p>
139<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
140         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
141<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">&gt;(</span>
142    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
143    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
144</pre>
145<p>
146          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
147          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
148          <span class="identifier">i</span> <span class="special">&lt;</span>
149          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">&lt;</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span></code>
150          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
151        </p>
152<p>
153          <span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="identifier">rhs</span>
154          <span class="special">&lt;</span> <span class="identifier">lhs</span></code>.
155        </p>
156<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">,</span>
157         <span class="keyword">typename</span> <span class="identifier">U1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">UN</span><span class="special">&gt;</span>
158<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">&gt;=(</span>
159    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&gt;&amp;</span> <span class="identifier">lhs</span><span class="special">,</span>
160    <span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">UN</span><span class="special">&gt;&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
161</pre>
162<p>
163          <span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
164          <code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
165          <span class="identifier">i</span> <span class="special">&lt;</span>
166          <span class="identifier">N</span></code>, <code class="computeroutput"><a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">lhs</span><span class="special">)</span> <span class="special">&lt;</span> <a class="link" href="element_access.html" title="Element access"><code class="computeroutput"><span class="identifier">get</span></code></a><span class="special">&lt;</span><span class="identifier">i</span><span class="special">&gt;(</span><span class="identifier">rhs</span><span class="special">)</span></code>
167          is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
168        </p>
169<p>
170          <span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="special">!(</span><span class="identifier">lhs</span> <span class="special">&lt;</span> <span class="identifier">rhs</span><span class="special">)</span></code>.
171        </p>
172</div>
173<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
174<td align="left"></td>
175<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
176      Dan Marsden, Tobias Schwinger<p>
177        Distributed under the Boost Software License, Version 1.0. (See accompanying
178        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
179      </p>
180</div></td>
181</tr></table>
182<hr>
183<div class="spirit-nav">
184<a accesskey="p" href="element_access.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../class_template_tuple.html"><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="../pairs.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
185</div>
186</body>
187</html>
188