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

documentation update

Browse Source 
[SVN r61187]
This commit is contained in:
Christopher Schmidt
2010-04-10 18:55:44 +00:00
parent 83db52797b
commit 2f8b22dd93
269 changed files with 9704 additions and 8917 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>pair</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
<link rel="up" href="../support.html" title="Support">
<link rel="prev" href="deduce_sequence.html" title="deduce_sequence">
@ -27,7 +27,7 @@
<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="id568532"></a>
<a name="id667113"></a>
<a class="link" href="pair.html#fusion.support.pair.description">Description</a>
</h5>
<p>
@ -37,7 +37,7 @@
the first type does not have data. It is used as elements in <a class="link" href="../container/map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a>s, for example.
</p>
<a name="fusion.support.pair.synopsis"></a><h5>
<a name="id568600"></a>
<a name="id667180"></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>
@ -60,7 +60,7 @@
<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><h5>
<a name="id568896"></a>
<a name="id667477"></a>
<a class="link" href="pair.html#fusion.support.pair.template_parameters">Template parameters</a>
</h5>
<div class="informaltable"><table class="table">
@ -70,39 +70,39 @@
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
First
</p>
<p>
First
</p>
</td>
<td>
<p>
The first type. This is purely a type. No data is held.
</p>
<p>
The first type. This is purely a type. No data is held.
</p>
</td>
</tr>
<tr>
<td>
<p>
Second
</p>
<p>
Second
</p>
</td>
<td>
<p>
The second type. This contains data.
</p>
<p>
The second type. This contains data.
</p>
</td>
</tr>
</tbody>
@ -112,34 +112,32 @@
<dl>
<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"><code class="computeroutput"><span class="identifier">p</span></code>,
<code class="computeroutput"><span class="identifier">p2</span></code></span></dt>
Fusion pair type
</p></dd>
<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"><code class="computeroutput"><span class="identifier">F</span></code>,
<code class="computeroutput"><span class="identifier">S</span></code></span></dt>
Fusion pairs
</p></dd>
<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>
Arbitrary types
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd><p>
Value of type <code class="computeroutput"><span class="identifier">S</span></code>
</p></dd>
Value of type <code class="computeroutput"><span class="identifier">S</span></code>
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">o</span></code></span></dt>
<dd><p>
Output stream
</p></dd>
Output stream
</p></dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">i</span></code></span></dt>
<dd><p>
Input stream
</p></dd>
Input stream
</p></dd>
</dl>
</div>
<a name="fusion.support.pair.expression_semantics"></a><h5>
<a name="id570479"></a>
<a name="id668798"></a>
<a class="link" href="pair.html#fusion.support.pair.expression_semantics">Expression Semantics</a>
</h5>
<div class="informaltable"><table class="table">
@ -149,184 +147,184 @@
</colgroup>
<thead><tr>
<th>
<p>
Expression
</p>
<p>
Expression
</p>
</th>
<th>
<p>
Semantics
</p>
<p>
Semantics
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></code>
</p>
<p>
<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, <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>
<p>
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>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></code>
</p>
<p>
<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, <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>
<p>
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>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">()</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">()</span></code>
</p>
</td>
<td>
<p>
Default construction.
</p>
<p>
Default construction.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</p>
<p>
<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, <code class="computeroutput"><span class="identifier">s</span></code>.
</p>
<p>
Construct a pair given value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></code>
</p>
<p>
<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, <code class="computeroutput"><span class="identifier">p2</span></code>.
</p>
<p>
Copy constructs a pair from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span><span class="special">.</span><span class="identifier">second</span></code>
</p>
<p>
<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 <code class="computeroutput"><span class="identifier">p1</span></code>.
</p>
<p>
Get the data from <code class="computeroutput"><span class="identifier">p1</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></code>
</p>
</td>
<td>
<p>
Assigns a pair, <code class="computeroutput"><span class="identifier">p1</span></code>,
from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
</p>
<p>
Assigns a pair, <code class="computeroutput"><span class="identifier">p1</span></code>,
from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
make_pair&lt;F&gt;(s)
</p>
<p>
make_pair&lt;F&gt;(s)
</p>
</td>
<td>
<p>
Make a pair given the first type, <code class="computeroutput"><span class="identifier">F</span></code>,
and a value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.
The second type assumes the type of <code class="computeroutput"><span class="identifier">s</span></code>
</p>
<p>
Make a pair given the first type, <code class="computeroutput"><span class="identifier">F</span></code>,
and a value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.
The second type assumes the type of <code class="computeroutput"><span class="identifier">s</span></code>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">o</span> <span class="special">&lt;&lt;</span>
<span class="identifier">p</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">o</span> <span class="special">&lt;&lt;</span>
<span class="identifier">p</span></code>
</p>
</td>
<td>
<p>
Output <code class="computeroutput"><span class="identifier">p</span></code> to output
stream, <code class="computeroutput"><span class="identifier">o</span></code>.
</p>
<p>
Output <code class="computeroutput"><span class="identifier">p</span></code> to output
stream, <code class="computeroutput"><span class="identifier">o</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">i</span> <span class="special">&gt;&gt;</span>
<span class="identifier">p</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">i</span> <span class="special">&gt;&gt;</span>
<span class="identifier">p</span></code>
</p>
</td>
<td>
<p>
Input <code class="computeroutput"><span class="identifier">p</span></code> from input
stream, <code class="computeroutput"><span class="identifier">i</span></code>.
</p>
<p>
Input <code class="computeroutput"><span class="identifier">p</span></code> from input
stream, <code class="computeroutput"><span class="identifier">i</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></code>
</p>
</td>
<td>
<p>
Tests two pairs for equality.
</p>
<p>
Tests two pairs for equality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></code>
</p>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></code>
</p>
</td>
<td>
<p>
Tests two pairs for inequality.
</p>
<p>
Tests two pairs for inequality.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.support.pair.header"></a><h5>
<a name="id571066"></a>
<a name="id669401"></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><h5>
<a name="id571174"></a>
<a name="id669509"></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>