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

Doc updates

Browse Source 
[SVN r39468]
This commit is contained in:
Joel de Guzman
2007-09-22 01:05:29 +00:00
parent 6344096709
commit 1f2087092f
253 changed files with 6680 additions and 5824 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,41 +3,41 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>pair</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<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">
<link rel="next" href="../iterators.html" title="Iterators">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<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="../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</table>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="deduce_sequence.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../iterators.html"><img src="../../images/next.png" alt="Next"></a>
<a accesskey="p" href="deduce_sequence.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../iterators.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</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="id931964"></a>
<a name="id465407"></a>
<a href="pair.html#fusion.support.pair.description">Description</a>
</h4>
<p>
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 href="../sequences/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 href="../sequences/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>,
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="../sequences/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="../sequences/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>,
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="id932056"></a>
<a name="id465512"></a>
<a href="pair.html#fusion.support.pair.synopsis">Synopsis</a>
</h4>
<pre class="programlisting">
@ -61,7 +61,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><h4>
<a name="id932447"></a>
<a name="id465954"></a>
<a href="pair.html#fusion.support.pair.template_parameters">Template parameters</a>
</h4>
<div class="informaltable"><table class="table">
@ -111,36 +111,36 @@
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><code class="computeroutput"><span class="identifier">P</span></code></span></dt>
<dd>
Fusion pair type
</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>
Fusion pairs
</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>
Arbitrary types
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd>
Value of type <code class="computeroutput"><span class="identifier">S</span></code>
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">o</span></code></span></dt>
<dd>
Output stream
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">i</span></code></span></dt>
<dd>
Input stream
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">P</span></tt></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>
<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>
<dd><p>
Arbitrary types
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd><p>
Value of type <tt class="computeroutput"><span class="identifier">S</span></tt>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">o</span></tt></span></dt>
<dd><p>
Output stream
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">i</span></tt></span></dt>
<dd><p>
Input stream
</p></dd>
</dl>
</div>
<a name="fusion.support.pair.expression_semantics"></a><h4>
<a name="id932676"></a>
<a name="id466235"></a>
<a href="pair.html#fusion.support.pair.expression_semantics">Expression Semantics</a>
</h4>
<div class="informaltable"><table class="table">
@ -164,33 +164,33 @@
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></code>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></tt>
</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>.
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>.
</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>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></tt>
</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>.
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>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">P</span><span class="special">()</span></code>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">()</span></tt>
</p>
</td>
<td>
@ -202,37 +202,37 @@
<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>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
</p>
</td>
<td>
<p>
Construct a pair given value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.
Construct a pair given value for the second type, <tt class="computeroutput"><span class="identifier">s</span></tt>.
</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>
<tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></tt>
</p>
</td>
<td>
<p>
Copy constructs a pair from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
Copy constructs a pair from another pair, <tt class="computeroutput"><span class="identifier">p2</span></tt>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></code>
<tt class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></tt>
</p>
</td>
<td>
<p>
Assigns a pair, p1, from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.
Assigns a pair, p1, from another pair, <tt class="computeroutput"><span class="identifier">p2</span></tt>.
</p>
</td>
</tr>
@ -244,45 +244,45 @@
</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>
Make a pair given the first type, <tt class="computeroutput"><span class="identifier">F</span></tt>,
and a value for the second type, <tt class="computeroutput"><span class="identifier">s</span></tt>.
The second type assumes the type of <tt class="computeroutput"><span class="identifier">s</span></tt>
</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>
<tt class="computeroutput"><span class="identifier">o</span> <span class="special">&lt;&lt;</span>
<span class="identifier">p</span></tt>
</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>.
Output <tt class="computeroutput"><span class="identifier">p</span></tt> to output
stream, <tt class="computeroutput"><span class="identifier">o</span></tt>.
</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>
<tt class="computeroutput"><span class="identifier">i</span> <span class="special">&gt;&gt;</span>
<span class="identifier">p</span></tt>
</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>.
Input <tt class="computeroutput"><span class="identifier">p</span></tt> from input
stream, <tt class="computeroutput"><span class="identifier">i</span></tt>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></code>
<tt class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></tt>
</p>
</td>
<td>
@ -294,8 +294,8 @@
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></code>
<tt class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></tt>
</p>
</td>
<td>
@ -307,14 +307,14 @@
</tbody>
</table></div>
<a name="fusion.support.pair.header"></a><h4>
<a name="id933307"></a>
<a name="id466948"></a>
<a href="pair.html#fusion.support.pair.header">Header</a>
</h4>
<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>
</pre>
<a name="fusion.support.pair.example"></a><h4>
<a name="id933389"></a>
<a name="id467042"></a>
<a href="pair.html#fusion.support.pair.example">Example</a>
</h4>
<pre class="programlisting">
@ -331,7 +331,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="deduce_sequence.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../iterators.html"><img src="../../images/next.png" alt="Next"></a>
<a accesskey="p" href="deduce_sequence.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../support.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../iterators.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>