feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

adds documentation for functional module

Browse Source 
[SVN r36959]
This commit is contained in:
Tobias Schwinger
2007-02-15 23:11:24 +00:00
parent 67f0df4958
commit ca6f831b96
247 changed files with 8675 additions and 3833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/html/fusion/tuples/class_template_tuple.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class template tuple</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../tuples.html" title="Tuples">
<link rel="prev" href="../tuples.html" title="Tuples">
@ -44,11 +44,11 @@
beyond that required by TR1.
</p>
<p>
Currently tuple is basically a synonym for <a href="../sequences/containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>, although this may be changed
Currently tuple is basically a synonym for <a href="../sequences/containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a>, although this may be changed
in future releases of fusion.
</p>
<a name="fusion.tuples.class_template_tuple.synopsis"></a><h4>
<a name="id602788"></a>
<a name="id1175401"></a>
<a href="class_template_tuple.html#fusion.tuples.class_template_tuple.synopsis">Synopsis</a>
</h4>
<pre class="programlisting">
@ -60,7 +60,7 @@
<span class="keyword">class</span> <span class="identifier">tuple</span><span class="special">;</span>
</pre>
<a name="fusion.tuples.class_template_tuple.header"></a><h4>
<a name="id602923"></a>
<a name="id1175520"></a>
<a href="class_template_tuple.html#fusion.tuples.class_template_tuple.header">Header</a>
</h4>
<pre class="programlisting">

56
doc/html/fusion/tuples/class_template_tuple/construction.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Construction</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
<link rel="prev" href="../class_template_tuple.html" title="Class template tuple">
@ -27,7 +27,7 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.tuples.class_template_tuple.construction"></a><a href="construction.html" title="Construction">Construction</a></h4></div></div></div>
<a name="fusion.tuples.class_template_tuple.construction.description"></a><h5>
<a name="id603015"></a>
<a name="id1175601"></a>
<a href="construction.html#fusion.tuples.class_template_tuple.construction.description">Description</a>
</h5>
<p>
@ -38,33 +38,33 @@
in this section.
</p>
<a name="fusion.tuples.class_template_tuple.construction.specification"></a><h5>
<a name="id603054"></a>
<a name="id1175636"></a>
<a href="construction.html#fusion.tuples.class_template_tuple.construction.specification">Specification</a>
</h5>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">T1</span>
<span class="special">...</span> <span class="identifier">TN</span></tt>,
<tt class="computeroutput"><span class="identifier">U1</span> <span class="special">...</span>
<span class="identifier">UN</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">T1</span>
<span class="special">...</span> <span class="identifier">TN</span></code>,
<code class="computeroutput"><span class="identifier">U1</span> <span class="special">...</span>
<span class="identifier">UN</span></code></span></dt>
<dd>
Tuple element types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">P1</span>
<span class="special">...</span> <span class="identifier">PN</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">P1</span>
<span class="special">...</span> <span class="identifier">PN</span></code></span></dt>
<dd>
Parameter types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">Ti</span></tt>,
<tt class="computeroutput"><span class="identifier">Ui</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Ti</span></code>,
<code class="computeroutput"><span class="identifier">Ui</span></code></span></dt>
<dd>
The type of the <tt class="computeroutput"><span class="identifier">i</span></tt>th element
The type of the <code class="computeroutput"><span class="identifier">i</span></code>th element
of a tuple
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">Pi</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Pi</span></code></span></dt>
<dd>
The type of the <tt class="computeroutput"><span class="identifier">i</span></tt>th parameter
The type of the <code class="computeroutput"><span class="identifier">i</span></code>th parameter
</dd>
</dl>
</div>
@ -72,48 +72,48 @@
<span class="identifier">tuple</span><span class="special">();</span>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: Each <tt class="computeroutput"><span class="identifier">Ti</span></tt>
<span class="bold"><strong>Requirements</strong></span>: Each <code class="computeroutput"><span class="identifier">Ti</span></code>
is default constructable.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Default initializes each element
<span class="bold"><strong>Semantics</strong></span>: Default initializes each element
of the tuple.
</p>
<pre class="programlisting">
<span class="identifier">tuple</span><span class="special">(</span><span class="identifier">P1</span><span class="special">,</span><span class="identifier">P2</span><span class="special">,...,</span><span class="identifier">PN</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: Each <tt class="computeroutput"><span class="identifier">Pi</span></tt>
is <tt class="computeroutput"><span class="identifier">Ti</span></tt> if <tt class="computeroutput"><span class="identifier">Ti</span></tt> is a reference type, <tt class="computeroutput"><span class="keyword">const</span> <span class="identifier">Ti</span><span class="special">&amp;</span></tt> otherwise.
<span class="bold"><strong>Requirements</strong></span>: Each <code class="computeroutput"><span class="identifier">Pi</span></code>
is <code class="computeroutput"><span class="identifier">Ti</span></code> if <code class="computeroutput"><span class="identifier">Ti</span></code> is a reference type, <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">Ti</span><span class="special">&amp;</span></code> otherwise.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Copy initializes each element
<span class="bold"><strong>Semantics</strong></span>: Copy initializes each element
with the corresponding parameter.
</p>
<pre class="programlisting">
<span class="identifier">tuple</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">tuple</span><span class="special">&amp;</span> <span class="identifier">t</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: Each <tt class="computeroutput"><span class="identifier">Ti</span></tt>
<span class="bold"><strong>Requirements</strong></span>: Each <code class="computeroutput"><span class="identifier">Ti</span></code>
should be copy constructable.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Copy constructs each element
of <tt class="computeroutput"><span class="special">*</span><span class="keyword">this</span></tt>
with the corresponding element of <tt class="computeroutput"><span class="identifier">t</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Copy constructs each element
of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
with the corresponding element of <code class="computeroutput"><span class="identifier">t</span></code>.
</p>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span><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>
<span class="identifier">tuple</span><span class="special">(</span><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">t</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: Each <tt class="computeroutput"><span class="identifier">Ti</span></tt>
shall be constructible from the corresponding <tt class="computeroutput"><span class="identifier">Ui</span></tt>.
<span class="bold"><strong>Requirements</strong></span>: Each <code class="computeroutput"><span class="identifier">Ti</span></code>
shall be constructible from the corresponding <code class="computeroutput"><span class="identifier">Ui</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Constructs each element of
<tt class="computeroutput"><span class="special">*</span><span class="keyword">this</span></tt>
with the corresponding element of <tt class="computeroutput"><span class="identifier">t</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Constructs each element of
<code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
with the corresponding element of <code class="computeroutput"><span class="identifier">t</span></code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

40
doc/html/fusion/tuples/class_template_tuple/element_access.html
View File

@ -4,7 +4,7 @@
<title>Element
access</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
<link rel="prev" href="tuple_helper_classes.html" title="Tuple
@ -31,16 +31,16 @@
access">Element
access</a></h4></div></div></div>
<a name="fusion.tuples.class_template_tuple.element_access.description"></a><h5>
<a name="id604789"></a>
<a name="id1177178"></a>
<a href="element_access.html#fusion.tuples.class_template_tuple.element_access.description">Description</a>
</h5>
<p>
The <a href="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2002/n1403.pdf" target="_top">TR1
Tuple</a> provides the <tt class="computeroutput"><span class="identifier">get</span></tt>
Tuple</a> provides the <code class="computeroutput"><span class="identifier">get</span></code>
function to provide access to it's elements by zero based numeric index.
</p>
<a name="fusion.tuples.class_template_tuple.element_access.specification"></a><h5>
<a name="id604834"></a>
<a name="id1177217"></a>
<a href="element_access.html#fusion.tuples.class_template_tuple.element_access.specification">Specification</a>
</h5>
<pre class="programlisting">
@ -48,38 +48,38 @@
<span class="identifier">RJ</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">t</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Requires</b></span>: <tt class="computeroutput"><span class="number">0</span>
<span class="bold"><strong>Requires</strong></span>: <code class="computeroutput"><span class="number">0</span>
<span class="special">&lt;</span> <span class="identifier">I</span>
<span class="special">&lt;=</span> <span class="identifier">N</span></tt>.
The program is ill formed if <tt class="computeroutput"><span class="identifier">I</span></tt>
is out of bounds. <tt class="computeroutput"><span class="identifier">T</span></tt> is
any fusion sequence type, including <tt class="computeroutput"><span class="identifier">tuple</span></tt>.
<span class="special">&lt;=</span> <span class="identifier">N</span></code>.
The program is ill formed if <code class="computeroutput"><span class="identifier">I</span></code>
is out of bounds. <code class="computeroutput"><span class="identifier">T</span></code> is
any fusion sequence type, including <code class="computeroutput"><span class="identifier">tuple</span></code>.
</p>
<p>
<span class="bold"><b>Return type</b></span>: <tt class="computeroutput"><span class="identifier">RJ</span></tt>
is equivalent to <tt class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/at_c.html" title="at_c"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_c</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
<span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="identifier">RJ</span></code>
is equivalent to <code class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/at_c.html" title="at_c"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_c</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
<p>
<span class="bold"><b>Returns</b></span>: A reference to the <tt class="computeroutput"><span class="identifier">I</span></tt>th element of <tt class="computeroutput"><span class="identifier">T</span></tt>.
<span class="bold"><strong>Returns</strong></span>: A reference to the <code class="computeroutput"><span class="identifier">I</span></code>th element of <code class="computeroutput"><span class="identifier">T</span></code>.
</p>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">int</span> <span class="identifier">I</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">PJ</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">t</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Requires</b></span>: <tt class="computeroutput"><span class="number">0</span>
<span class="bold"><strong>Requires</strong></span>: <code class="computeroutput"><span class="number">0</span>
<span class="special">&lt;</span> <span class="identifier">I</span>
<span class="special">&lt;=</span> <span class="identifier">N</span></tt>.
The program is ill formed if <tt class="computeroutput"><span class="identifier">I</span></tt>
is out of bounds. <tt class="computeroutput"><span class="identifier">T</span></tt> is
any fusion sequence type, including <tt class="computeroutput"><span class="identifier">tuple</span></tt>.
<span class="special">&lt;=</span> <span class="identifier">N</span></code>.
The program is ill formed if <code class="computeroutput"><span class="identifier">I</span></code>
is out of bounds. <code class="computeroutput"><span class="identifier">T</span></code> is
any fusion sequence type, including <code class="computeroutput"><span class="identifier">tuple</span></code>.
</p>
<p>
<span class="bold"><b>Return type</b></span>: <tt class="computeroutput"><span class="identifier">PJ</span></tt>
is equivalent to <tt class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/at_c.html" title="at_c"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_c</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
<span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="identifier">PJ</span></code>
is equivalent to <code class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/at_c.html" title="at_c"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_c</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
<p>
<span class="bold"><b>Returns</b></span>: A const reference to the <tt class="computeroutput"><span class="identifier">I</span></tt>th element of <tt class="computeroutput"><span class="identifier">T</span></tt>.
<span class="bold"><strong>Returns</strong></span>: A const reference to the <code class="computeroutput"><span class="identifier">I</span></code>th element of <code class="computeroutput"><span class="identifier">T</span></code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

132
doc/html/fusion/tuples/class_template_tuple/relational_operators.html
View File

@ -4,7 +4,7 @@
<title>Relational
operators</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
<link rel="prev" href="element_access.html" title="Element
@ -30,7 +30,7 @@
operators">Relational
operators</a></h4></div></div></div>
<a name="fusion.tuples.class_template_tuple.relational_operators.description"></a><h5>
<a name="id605387"></a>
<a name="id1177703"></a>
<a href="relational_operators.html#fusion.tuples.class_template_tuple.relational_operators.description">Description</a>
</h5>
<p>
@ -38,33 +38,33 @@
Tuple</a> provides the standard boolean relational operators.
</p>
<a name="fusion.tuples.class_template_tuple.relational_operators.specification"></a><h5>
<a name="id605423"></a>
<a name="id1177736"></a>
<a href="relational_operators.html#fusion.tuples.class_template_tuple.relational_operators.specification">Specification</a>
</h5>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">T1</span>
<span class="special">...</span> <span class="identifier">TN</span></tt>,
<tt class="computeroutput"><span class="identifier">U1</span> <span class="special">...</span>
<span class="identifier">UN</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">T1</span>
<span class="special">...</span> <span class="identifier">TN</span></code>,
<code class="computeroutput"><span class="identifier">U1</span> <span class="special">...</span>
<span class="identifier">UN</span></code></span></dt>
<dd>
Tuple element types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">P1</span>
<span class="special">...</span> <span class="identifier">PN</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">P1</span>
<span class="special">...</span> <span class="identifier">PN</span></code></span></dt>
<dd>
Parameter types
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">Ti</span></tt>,
<tt class="computeroutput"><span class="identifier">Ui</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Ti</span></code>,
<code class="computeroutput"><span class="identifier">Ui</span></code></span></dt>
<dd>
The type of the <tt class="computeroutput"><span class="identifier">i</span></tt>th element
The type of the <code class="computeroutput"><span class="identifier">i</span></code>th element
of a tuple
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">Pi</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">Pi</span></code></span></dt>
<dd>
The type of the <tt class="computeroutput"><span class="identifier">i</span></tt>th parameter
The type of the <code class="computeroutput"><span class="identifier">i</span></code>th parameter
</dd>
</dl>
</div>
@ -76,23 +76,23 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns <tt class="computeroutput"><span class="keyword">true</span></tt>
if and only if <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
for all <tt class="computeroutput"><span class="identifier">i</span></tt>. For any 2 zero
length tuples <tt class="computeroutput"><span class="identifier">e</span></tt> and <tt class="computeroutput"><span class="identifier">f</span></tt>, <tt class="computeroutput"><span class="identifier">e</span>
<span class="special">==</span> <span class="identifier">f</span></tt>
returns <tt class="computeroutput"><span class="keyword">true</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="keyword">true</span></code>
if and only if <code class="computeroutput"><a 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 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>
for all <code class="computeroutput"><span class="identifier">i</span></code>. For any 2 zero
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>
<span class="special">==</span> <span class="identifier">f</span></code>
returns <code class="computeroutput"><span class="keyword">true</span></code>.
</p>
<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>
@ -102,18 +102,18 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the lexicographical
comparison of between <tt class="computeroutput"><span class="identifier">lhs</span></tt>
and <tt class="computeroutput"><span class="identifier">rhs</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Returns the lexicographical
comparison of between <code class="computeroutput"><span class="identifier">lhs</span></code>
and <code class="computeroutput"><span class="identifier">rhs</span></code>.
</p>
<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>
@ -123,16 +123,16 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns <tt class="computeroutput"><span class="special">!(</span><span class="identifier">lhs</span> <span class="special">==</span> <span class="identifier">rhs</span><span class="special">)</span></tt>.
<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>.
</p>
<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>
@ -142,16 +142,16 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns <tt 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></tt>
<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>
</p>
<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>
@ -161,17 +161,17 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns <tt class="computeroutput"><span class="identifier">rhs</span>
<span class="special">&lt;</span> <span class="identifier">lhs</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Returns <code class="computeroutput"><span class="identifier">rhs</span>
<span class="special">&lt;</span> <span class="identifier">lhs</span></code>.
</p>
<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>
@ -181,16 +181,16 @@
<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>
</pre>
<p>
<span class="bold"><b>Requirements</b></span>: For all <tt class="computeroutput"><span class="identifier">i</span></tt>,
<tt class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requirements</strong></span>: For all <code class="computeroutput"><span class="identifier">i</span></code>,
<code class="computeroutput"><span class="number">1</span> <span class="special">&lt;=</span>
<span class="identifier">i</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt>, <tt class="computeroutput"><a href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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 href="element_access.html" title="Element
access"><tt class="computeroutput"><span class="identifier">get</span></tt></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></tt>
is a valid expression returning a type that is convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="identifier">N</span></code>, <code class="computeroutput"><a 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 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>
is a valid expression returning a type that is convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns <tt 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></tt>.
<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>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

26
doc/html/fusion/tuples/class_template_tuple/tuple_creation_functions.html
View File

@ -4,7 +4,7 @@
<title>Tuple
creation functions</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
<link rel="prev" href="construction.html" title="Construction">
@ -30,17 +30,17 @@
creation functions">Tuple
creation functions</a></h4></div></div></div>
<a name="fusion.tuples.class_template_tuple.tuple_creation_functions.description"></a><h5>
<a name="id603697"></a>
<a name="id1176205"></a>
<a href="tuple_creation_functions.html#fusion.tuples.class_template_tuple.tuple_creation_functions.description">Description</a>
</h5>
<p>
TR1 describes 2 utility functions for creating <span class="underline">_tr1</span><span class="underline">tuple</span>_s. <tt class="computeroutput"><span class="identifier">make_tuple</span></tt>
builds a tuple out of it's argument list, and <tt class="computeroutput"><span class="identifier">tie</span></tt>
TR1 describes 2 utility functions for creating <span class="underline">_tr1</span><span class="underline">tuple</span>_s. <code class="computeroutput"><span class="identifier">make_tuple</span></code>
builds a tuple out of it's argument list, and <code class="computeroutput"><span class="identifier">tie</span></code>
builds a tuple of references to it's arguments. The details of these creation
functions are described in this section.
</p>
<a name="fusion.tuples.class_template_tuple.tuple_creation_functions.specification"></a><h5>
<a name="id603760"></a>
<a name="id1176260"></a>
<a href="tuple_creation_functions.html#fusion.tuples.class_template_tuple.tuple_creation_functions.specification">Specification</a>
</h5>
<pre class="programlisting">
@ -48,22 +48,22 @@
<span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">V1</span><span class="special">,</span> <span class="identifier">V2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">VN</span><span class="special">&gt;</span> <span class="identifier">make_tuple</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T1</span><span class="special">&amp;</span> <span class="identifier">t1</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T2</span><span class="special">&amp;</span> <span class="identifier">t2</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">const</span> <span class="identifier">TN</span><span class="special">&amp;</span> <span class="identifier">tn</span><span class="special">);</span>
</pre>
<p>
Where <tt class="computeroutput"><span class="identifier">Vi</span></tt> is <tt class="computeroutput"><span class="identifier">X</span><span class="special">&amp;</span></tt>
if the cv-unqualified type <tt class="computeroutput"><span class="identifier">Ti</span></tt>
is <tt class="computeroutput"><span class="identifier">reference_wrapper</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">&gt;</span></tt>,
otherwise <tt class="computeroutput"><span class="identifier">Vi</span></tt> is <tt class="computeroutput"><span class="identifier">Ti</span></tt>.
Where <code class="computeroutput"><span class="identifier">Vi</span></code> is <code class="computeroutput"><span class="identifier">X</span><span class="special">&amp;</span></code>
if the cv-unqualified type <code class="computeroutput"><span class="identifier">Ti</span></code>
is <code class="computeroutput"><span class="identifier">reference_wrapper</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">&gt;</span></code>,
otherwise <code class="computeroutput"><span class="identifier">Vi</span></code> is <code class="computeroutput"><span class="identifier">Ti</span></code>.
</p>
<p>
<span class="bold"><b>Returns</b></span>: <tt class="computeroutput"><span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">V1</span><span class="special">,</span> <span class="identifier">V2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">VN</span><span class="special">&gt;(</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">)</span></tt>
<span class="bold"><strong>Returns</strong></span>: <code class="computeroutput"><span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">V1</span><span class="special">,</span> <span class="identifier">V2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">VN</span><span class="special">&gt;(</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">)</span></code>
</p>
<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">&gt;</span>
<span class="identifier">tuple</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">&amp;,</span> <span class="identifier">T2</span><span class="special">&amp;,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&amp;&gt;</span> <span class="identifier">tie</span><span class="special">(</span><span class="identifier">T1</span><span class="special">&amp;</span> <span class="identifier">t1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">&amp;</span> <span class="identifier">t2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">&amp;</span> <span class="identifier">tn</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Returns</b></span>: tuple&lt;T1&amp;, T2&amp;, ...,
TN&amp;&gt;(t1, t2, ..., tN). When argument <tt class="computeroutput"><span class="identifier">ti</span></tt>
is <tt class="computeroutput"><span class="identifier">ignore</span></tt>, assigning any
<span class="bold"><strong>Returns</strong></span>: tuple&lt;T1&amp;, T2&amp;, ...,
TN&amp;&gt;(t1, t2, ..., tN). When argument <code class="computeroutput"><span class="identifier">ti</span></code>
is <code class="computeroutput"><span class="identifier">ignore</span></code>, assigning any
value to the corresponding tuple element has has no effect.
</p>
</div>

31
doc/html/fusion/tuples/class_template_tuple/tuple_helper_classes.html
View File

@ -4,7 +4,7 @@
<title>Tuple
helper classes</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../class_template_tuple.html" title="Class template tuple">
<link rel="prev" href="tuple_creation_functions.html" title="Tuple
@ -31,7 +31,7 @@
helper classes">Tuple
helper classes</a></h4></div></div></div>
<a name="fusion.tuples.class_template_tuple.tuple_helper_classes.description"></a><h5>
<a name="id604403"></a>
<a name="id1176830"></a>
<a href="tuple_helper_classes.html#fusion.tuples.class_template_tuple.tuple_helper_classes.description">Description</a>
</h5>
<p>
@ -40,37 +40,38 @@
tuple size, and the element types.
</p>
<a name="fusion.tuples.class_template_tuple.tuple_helper_classes.specification"></a><h5>
<a name="id604440"></a>
<a name="id1176863"></a>
<a href="tuple_helper_classes.html#fusion.tuples.class_template_tuple.tuple_helper_classes.specification">Specification</a>
</h5>
<pre class="programlisting">
<span class="identifier">tuple_size</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span>
</pre>
<p>
<span class="bold"><b>Requires</b></span>: <tt class="computeroutput"><span class="identifier">T</span></tt>
is any fusion sequence type, including <tt class="computeroutput"><span class="identifier">tuple</span></tt>.
<span class="bold"><strong>Requires</strong></span>: <code class="computeroutput"><span class="identifier">T</span></code>
is any fusion sequence type, including <code class="computeroutput"><span class="identifier">tuple</span></code>.
</p>
<p>
<span class="bold"><b>Type</b></span>: MPL Integral Constant
<span class="bold"><strong>Type</strong></span>: <a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Integral Constant</a>
</p>
<p>
<span class="bold"><b>Value</b></span>: The number of elements in the sequence.
Equivalent to <tt class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/size.html" title="size"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">size</span></tt></a><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
<span class="bold"><strong>Value</strong></span>: The number of elements in the sequence.
Equivalent to <code class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/size.html" title="size"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">size</span></code></a><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
<pre class="programlisting">
<span class="identifier">tuple_element</span><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<span class="bold"><b>Requires</b></span>: <tt class="computeroutput"><span class="identifier">T</span></tt>
is any fusion sequence type, including <tt class="computeroutput"><span class="identifier">tuple</span></tt>.
<tt class="computeroutput"><span class="number">0</span> <span class="special">&lt;=</span>
<span class="bold"><strong>Requires</strong></span>: <code class="computeroutput"><span class="identifier">T</span></code>
is any fusion sequence type, including <code class="computeroutput"><span class="identifier">tuple</span></code>.
<code class="computeroutput"><span class="number">0</span> <span class="special">&lt;=</span>
<span class="identifier">I</span> <span class="special">&lt;</span>
<span class="identifier">N</span></tt> or the program is ill formed.
<span class="identifier">N</span></code> or the program is ill formed.
</p>
<p>
<span class="bold"><b>Value</b></span>: The type of the <tt class="computeroutput"><span class="identifier">I</span></tt>th
element of <tt class="computeroutput"><span class="identifier">T</span></tt>. Equivalent
to <tt class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/value_at.html" title="value_at"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
<span class="bold"><strong>Value</strong></span>: The type of the <code class="computeroutput"><span class="identifier">I</span></code>th
element of <code class="computeroutput"><span class="identifier">T</span></code>. Equivalent
to <code class="computeroutput"><a href="../../sequences/intrinsics/metafunctions/value_at.html" title="value_at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

45
doc/html/fusion/tuples/pairs.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Pairs</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../tuples.html" title="Tuples">
<link rel="prev" href="class_template_tuple/relational_operators.html" title="Relational
@ -27,46 +27,47 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.tuples.pairs"></a><a href="pairs.html" title="Pairs">Pairs</a></h3></div></div></div>
<a name="fusion.tuples.pairs.description"></a><h4>
<a name="id608618"></a>
<a name="id1180350"></a>
<a href="pairs.html#fusion.tuples.pairs.description">Description</a>
</h4>
<p>
The <a href="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2002/n1403.pdf" target="_top">TR1
Tuple</a> interface is specified to provide uniform access to <tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt>
Tuple</a> interface is specified to provide uniform access to <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code>
as if it were a 2 element tuple.
</p>
<a name="fusion.tuples.pairs.specification"></a><h4>
<a name="id608672"></a>
<a name="id1180400"></a>
<a href="pairs.html#fusion.tuples.pairs.specification">Specification</a>
</h4>
<pre class="programlisting">
<span class="identifier">tuple_size</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">&gt;</span> <span class="special">&gt;::</span><span class="identifier">value</span>
</pre>
<p>
<span class="bold"><b>Type</b></span>: An MPL Integral Constant
<span class="bold"><strong>Type</strong></span>: An <a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
Integral Constant</a>
</p>
<p>
<span class="bold"><b>Value</b></span>: Returns 2, the number of elements
<span class="bold"><strong>Value</strong></span>: Returns 2, the number of elements
in a pair.
</p>
<pre class="programlisting">
<span class="identifier">tuple_element</span><span class="special">&lt;</span><span class="number">0</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">&gt;</span> <span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<span class="bold"><b>Type</b></span>: <tt class="computeroutput"><span class="identifier">T1</span></tt>
<span class="bold"><strong>Type</strong></span>: <code class="computeroutput"><span class="identifier">T1</span></code>
</p>
<p>
<span class="bold"><b>Value</b></span>: Returns the type of the first element
<span class="bold"><strong>Value</strong></span>: Returns the type of the first element
of the pair
</p>
<pre class="programlisting">
<span class="identifier">tuple_element</span><span class="special">&lt;</span><span class="number">1</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">&gt;</span> <span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<span class="bold"><b>Type</b></span>: <tt class="computeroutput"><span class="identifier">T2</span></tt>
<span class="bold"><strong>Type</strong></span>: <code class="computeroutput"><span class="identifier">T2</span></code>
</p>
<p>
<span class="bold"><b>Value</b></span>: Returns thetype of the second element
<span class="bold"><strong>Value</strong></span>: Returns thetype of the second element
of the pair
</p>
<pre class="programlisting">
@ -77,21 +78,21 @@
<span class="keyword">const</span> <span class="identifier">P</span><span class="special">&amp;</span> <span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">&gt;&amp;</span> <span class="identifier">pr</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Type</b></span>: If <tt class="computeroutput"><span class="identifier">I</span>
<span class="special">==</span> <span class="number">0</span></tt>
<tt class="computeroutput"><span class="identifier">P</span></tt> is <tt class="computeroutput"><span class="identifier">T1</span></tt>,
else if <tt class="computeroutput"><span class="identifier">I</span> <span class="special">==</span>
<span class="number">1</span></tt> <tt class="computeroutput"><span class="identifier">P</span></tt>
is <tt class="computeroutput"><span class="identifier">T2</span></tt> else the program is
<span class="bold"><strong>Type</strong></span>: If <code class="computeroutput"><span class="identifier">I</span>
<span class="special">==</span> <span class="number">0</span></code>
<code class="computeroutput"><span class="identifier">P</span></code> is <code class="computeroutput"><span class="identifier">T1</span></code>,
else if <code class="computeroutput"><span class="identifier">I</span> <span class="special">==</span>
<span class="number">1</span></code> <code class="computeroutput"><span class="identifier">P</span></code>
is <code class="computeroutput"><span class="identifier">T2</span></code> else the program is
ill-formed.
</p>
<p>
<span class="bold"><b>Returns: <tt class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">first</span></tt>
if <tt class="computeroutput"><span class="identifier">I</span> <span class="special">==</span>
<span class="number">0</span></tt> else <tt class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">second</span></tt>.</b></span>[*Returns:
<tt class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">first</span></tt> if <tt class="computeroutput"><span class="identifier">I</span>
<span class="special">==</span> <span class="number">0</span></tt>
else <tt class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">second</span></tt>.
<span class="bold"><strong>Returns: <code class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">first</span></code>
if <code class="computeroutput"><span class="identifier">I</span> <span class="special">==</span>
<span class="number">0</span></code> else <code class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">second</span></code>.</strong></span>[*Returns:
<code class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">first</span></code> if <code class="computeroutput"><span class="identifier">I</span>
<span class="special">==</span> <span class="number">0</span></code>
else <code class="computeroutput"><span class="identifier">pr</span><span class="special">.</span><span class="identifier">second</span></code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>