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

Rebuild a lot of documentation.

Browse Source 
[SVN r43650]
This commit is contained in:
Daniel James
2008-03-16 11:38:32 +00:00
parent 9e8d8b1871
commit 813930aee6
257 changed files with 8717 additions and 9036 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
doc/html/fusion/support/pair.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>pair</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../support.html" title="Support">
<link rel="prev" href="deduce_sequence.html" title="deduce_sequence">
@ -12,10 +12,10 @@
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="http://www.boost.org/people/people.htm">People</a></td>
<td align="center"><a href="http://www.boost.org/more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@ -24,22 +24,23 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="fusion.support.pair"></a><a href="pair.html" title="pair">pair</a></h3></div></div></div>
<a name="fusion.support.pair.description"></a><h4>
<a name="id466114"></a>
<a href="pair.html#fusion.support.pair.description">Description</a>
</h4>
<a name="fusion.support.pair"></a><a class="link" href="pair.html" title="pair">pair</a>
</h3></div></div></div>
<a name="fusion.support.pair.description"></a><h5>
<a name="id2643879"></a>
<a class="link" href="pair.html#fusion.support.pair.description">Description</a>
</h5>
<p>
Fusion <tt class="computeroutput"><span class="identifier">pair</span></tt> type is a half
runtime pair. A half runtime pair is similar to a <a href="../adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a>,
but, unlike <a href="../adapted/std__pair.html" title="std::pair"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></tt></a>,
Fusion <code class="computeroutput"><span class="identifier">pair</span></code> type is a half
runtime pair. A half runtime pair is similar to a <a class="link" href="../adapted/std__pair.html" title="std::pair"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></a>,
but, unlike <a class="link" href="../adapted/std__pair.html" title="std::pair"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span></code></a>,
the first type does not have data. It is used as elements in <span class="underline">_map</span>_s,
for example.
</p>
<a name="fusion.support.pair.synopsis"></a><h4>
<a name="id466219"></a>
<a href="pair.html#fusion.support.pair.synopsis">Synopsis</a>
</h4>
<a name="fusion.support.pair.synopsis"></a><h5>
<a name="id2643958"></a>
<a class="link" href="pair.html#fusion.support.pair.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">First</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Second</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">pair</span><span class="special">;</span>
@ -60,10 +61,10 @@
<span class="keyword">typename</span> <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">&lt;</span><span class="identifier">First</span><span class="special">,</span><span class="identifier">Second</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">Second</span> <span class="keyword">const</span> <span class="special">&amp;);</span>
</pre>
<a name="fusion.support.pair.template_parameters"></a><h4>
<a name="id466662"></a>
<a href="pair.html#fusion.support.pair.template_parameters">Template parameters</a>
</h4>
<a name="fusion.support.pair.template_parameters"></a><h5>
<a name="id2644327"></a>
<a class="link" href="pair.html#fusion.support.pair.template_parameters">Template parameters</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@ -111,38 +112,38 @@
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">P</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">P</span></code></span></dt>
<dd><p>
Fusion pair type
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">p</span></tt>,
<tt class="computeroutput"><span class="identifier">p2</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">p</span></code>,
<code class="computeroutput"><span class="identifier">p2</span></code></span></dt>
<dd><p>
Fusion pairs
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">F</span></tt>,
<tt class="computeroutput"><span class="identifier">S</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">F</span></code>,
<code class="computeroutput"><span class="identifier">S</span></code></span></dt>
<dd><p>
Arbitrary types
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd><p>
Value of type <tt class="computeroutput"><span class="identifier">S</span></tt>
Value of type <code class="computeroutput"><span class="identifier">S</span></code>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">o</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">o</span></code></span></dt>
<dd><p>
Output stream
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">i</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">i</span></code></span></dt>
<dd><p>
Input stream
</p></dd>
</dl>
</div>
<a name="fusion.support.pair.expression_semantics"></a><h4>
<a name="id466942"></a>
<a href="pair.html#fusion.support.pair.expression_semantics">Expression Semantics</a>
</h4>
<a name="fusion.support.pair.expression_semantics"></a><h5>
<a name="id2644578"></a>
<a class="link" href="pair.html#fusion.support.pair.expression_semantics">Expression Semantics</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@ -166,13 +167,13 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></tt>
<code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></code>
</p>
</td>
<td>
<p>
The type of the first template parameter, <tt class="computeroutput"><span class="identifier">F</span></tt>,
equivalent to <tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">first</span><span class="special">&lt;</span><span class="identifier">P</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
The type of the first template parameter, <code class="computeroutput"><span class="identifier">F</span></code>,
equivalent to <code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">first</span><span class="special">&lt;</span><span class="identifier">P</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
</td>
<td class="auto-generated"><EFBFBD></td>
@ -180,13 +181,13 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></tt>
<code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></code>
</p>
</td>
<td>
<p>
The type of the second template parameter, <tt class="computeroutput"><span class="identifier">S</span></tt>,
equivalent to <tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">second</span><span class="special">&lt;</span><span class="identifier">P</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>.
The type of the second template parameter, <code class="computeroutput"><span class="identifier">S</span></code>,
equivalent to <code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">second</span><span class="special">&lt;</span><span class="identifier">P</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
</p>
</td>
<td class="auto-generated"><EFBFBD></td>
@ -194,7 +195,7 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">()</span></tt>
<code class="computeroutput"><span class="identifier">P</span><span class="special">()</span></code>
</p>
</td>
<td>
@ -207,12 +208,12 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
<code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Construct a pair given value for the second type, <tt class="computeroutput"><span class="identifier">s</span></tt>.
Construct a pair given value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.
</p>
</td>
<td class="auto-generated"><EFBFBD></td>
@ -220,12 +221,12 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></tt>
<code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Copy constructs a pair from another pair, <tt class="computeroutput"><span class="identifier">p2</span></tt>.
Copy constructs a pair from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
</p>
</td>
<td class="auto-generated"><EFBFBD></td>
@ -233,36 +234,36 @@
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">second</span></tt>
<code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">second</span></code>
</p>
</td>
<td>
<p>
Get the data from <tt class="computeroutput"><span class="identifier">p1</span><span class="special">.]]</span> <span class="special">[[</span></tt>p
= p2<tt class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Assigns</span> <span class="identifier">a</span>
Get the data from <code class="computeroutput"><span class="identifier">p1</span><span class="special">.]]</span> <span class="special">[[</span></code>p
= p2<code class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Assigns</span> <span class="identifier">a</span>
<span class="identifier">pair</span><span class="special">,</span>
</tt>p1<tt class="computeroutput"><span class="special">,</span> <span class="identifier">from</span>
<span class="identifier">another</span> <span class="identifier">pair</span><span class="special">,</span> </tt>p2<tt class="computeroutput"><span class="special">.]]</span>
</code>p1<code class="computeroutput"><span class="special">,</span> <span class="identifier">from</span>
<span class="identifier">another</span> <span class="identifier">pair</span><span class="special">,</span> </code>p2<code class="computeroutput"><span class="special">.]]</span>
<span class="special">[[</span><span class="identifier">make_pair</span><span class="special">&lt;</span><span class="identifier">F</span><span class="special">&gt;(</span><span class="identifier">s</span><span class="special">)]</span> <span class="special">[</span><span class="identifier">Make</span> <span class="identifier">a</span>
<span class="identifier">pair</span> <span class="identifier">given</span>
<span class="identifier">the</span> <span class="identifier">first</span>
<span class="identifier">type</span><span class="special">,</span>
</tt>F<tt class="computeroutput"><span class="special">,</span> <span class="keyword">and</span>
</code>F<code class="computeroutput"><span class="special">,</span> <span class="keyword">and</span>
<span class="identifier">a</span> <span class="identifier">value</span>
<span class="keyword">for</span> <span class="identifier">the</span>
<span class="identifier">second</span> <span class="identifier">type</span><span class="special">,</span> </tt>s<tt class="computeroutput"><span class="special">.</span>
<span class="identifier">second</span> <span class="identifier">type</span><span class="special">,</span> </code>s<code class="computeroutput"><span class="special">.</span>
<span class="identifier">The</span> <span class="identifier">second</span>
<span class="identifier">type</span> <span class="identifier">assumes</span>
<span class="identifier">the</span> <span class="identifier">type</span>
<span class="identifier">of</span> </tt>s<tt class="computeroutput"><span class="special">]]</span>
<span class="special">[[</span></tt>o &lt;&lt; p<tt class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Output</span> </tt>p<tt class="computeroutput"> <span class="identifier">to</span>
<span class="identifier">output</span> <span class="identifier">stream</span><span class="special">,</span> </tt>o<tt class="computeroutput"><span class="special">.]]</span>
<span class="special">[[</span></tt>i &gt;&gt; p<tt class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Input</span> </tt>p<tt class="computeroutput"> <span class="identifier">from</span>
<span class="identifier">input</span> <span class="identifier">stream</span><span class="special">,</span> </tt>i<tt class="computeroutput"><span class="special">.]]</span>
<span class="special">[[</span></tt>p == p2<tt class="computeroutput"><span class="special">]</span>
<span class="identifier">of</span> </code>s<code class="computeroutput"><span class="special">]]</span>
<span class="special">[[</span></code>o &lt;&lt; p<code class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Output</span> </code>p<code class="computeroutput"> <span class="identifier">to</span>
<span class="identifier">output</span> <span class="identifier">stream</span><span class="special">,</span> </code>o<code class="computeroutput"><span class="special">.]]</span>
<span class="special">[[</span></code>i &gt;&gt; p<code class="computeroutput"><span class="special">]</span> <span class="special">[</span><span class="identifier">Input</span> </code>p<code class="computeroutput"> <span class="identifier">from</span>
<span class="identifier">input</span> <span class="identifier">stream</span><span class="special">,</span> </code>i<code class="computeroutput"><span class="special">.]]</span>
<span class="special">[[</span></code>p == p2<code class="computeroutput"><span class="special">]</span>
<span class="special">[</span><span class="identifier">Tests</span>
<span class="identifier">two</span> <span class="identifier">pairs</span>
<span class="keyword">for</span> <span class="identifier">equality</span><span class="special">.]]</span> <span class="special">[[</span></tt>p
<span class="keyword">for</span> <span class="identifier">equality</span><span class="special">.]]</span> <span class="special">[[</span></code>p
!= p2`
</p>
</td>
@ -274,18 +275,18 @@
</tr>
</tbody>
</table></div>
<a name="fusion.support.pair.header"></a><h4>
<a name="id467922"></a>
<a href="pair.html#fusion.support.pair.header">Header</a>
</h4>
<a name="fusion.support.pair.header"></a><h5>
<a name="id2645465"></a>
<a class="link" href="pair.html#fusion.support.pair.header">Header</a>
</h5>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">support</span><span class="special">/</span><span class="identifier">pair</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">pair</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.support.pair.example"></a><h4>
<a name="id468079"></a>
<a href="pair.html#fusion.support.pair.example">Example</a>
</h4>
<a name="fusion.support.pair.example"></a><h5>
<a name="id2645606"></a>
<a class="link" href="pair.html#fusion.support.pair.example">Example</a>
</h5>
<pre class="programlisting">
<span class="identifier">pair</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">p</span><span class="special">(</span><span class="char">'X'</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">p</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>