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

92
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="../../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="../support.html" title="Support">
<link rel="prev" href="deduce_sequence.html" title="deduce_sequence">
@ -26,18 +26,18 @@
<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="id456933"></a>
<a name="id908289"></a>
<a href="pair.html#fusion.support.pair.description">Description</a>
</h4>
<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="../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>,
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>,
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="id457033"></a>
<a name="id908377"></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="id457475"></a>
<a name="id926243"></a>
<a href="pair.html#fusion.support.pair.template_parameters">Template parameters</a>
</h4>
<div class="informaltable"><table class="table">
@ -88,36 +88,36 @@
<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>
Fusion pair type
</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>
Fusion pairs
</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>
Arbitrary types
</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>
Value of type <tt class="computeroutput"><span class="identifier">S</span></tt>
Value of type <code class="computeroutput"><span class="identifier">S</span></code>
</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>
Output stream
</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>
Input stream
</dd>
</dl>
</div>
<a name="fusion.support.pair.expression_semantics"></a><h4>
<a name="id457695"></a>
<a name="id926437"></a>
<a href="pair.html#fusion.support.pair.expression_semantics">Expression Semantics</a>
</h4>
<div class="informaltable"><table class="table">
@ -131,81 +131,81 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></tt></td>
<td><code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">first_type</span></code></td>
<td>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>.
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>.
</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></tt></td>
<td><code class="computeroutput"><span class="identifier">P</span><span class="special">::</span><span class="identifier">second_type</span></code></td>
<td>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>.
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>.
</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">P</span><span class="special">()</span></tt></td>
<td><code class="computeroutput"><span class="identifier">P</span><span class="special">()</span></code></td>
<td>Default
construction.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>Construct
a pair given value for the second type, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
a pair given value for the second type, <code class="computeroutput"><span class="identifier">s</span></code>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></tt></td>
<td><code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">p2</span><span class="special">)</span></code></td>
<td>Copy
constructs a pair from another pair, <tt class="computeroutput"><span class="identifier">p2</span></tt>.</td>
constructs a pair from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></tt></td>
<td><code class="computeroutput"><span class="identifier">p</span> <span class="special">=</span>
<span class="identifier">p2</span></code></td>
<td>Assigns
a pair, p1, from another pair, <tt class="computeroutput"><span class="identifier">p2</span></tt>.</td>
a pair, p1, from another pair, <code class="computeroutput"><span class="identifier">p2</span></code>.</td>
</tr>
<tr>
<td>make_pair&lt;F&gt;(s)</td>
<td>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>
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>
</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">o</span> <span class="special">&lt;&lt;</span>
<span class="identifier">p</span></tt></td>
<td>Output <tt class="computeroutput"><span class="identifier">p</span></tt> to output stream, <tt class="computeroutput"><span class="identifier">o</span></tt>.</td>
<td><code class="computeroutput"><span class="identifier">o</span> <span class="special">&lt;&lt;</span>
<span class="identifier">p</span></code></td>
<td>Output <code class="computeroutput"><span class="identifier">p</span></code> to output stream, <code class="computeroutput"><span class="identifier">o</span></code>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">i</span> <span class="special">&gt;&gt;</span>
<span class="identifier">p</span></tt></td>
<td>Input <tt class="computeroutput"><span class="identifier">p</span></tt> from input stream, <tt class="computeroutput"><span class="identifier">i</span></tt>.</td>
<td><code class="computeroutput"><span class="identifier">i</span> <span class="special">&gt;&gt;</span>
<span class="identifier">p</span></code></td>
<td>Input <code class="computeroutput"><span class="identifier">p</span></code> from input stream, <code class="computeroutput"><span class="identifier">i</span></code>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></tt></td>
<td><code class="computeroutput"><span class="identifier">p</span> <span class="special">==</span>
<span class="identifier">p2</span></code></td>
<td>Tests two
pairs for equality.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></tt></td>
<td><code class="computeroutput"><span class="identifier">p</span> <span class="special">!=</span>
<span class="identifier">p2</span></code></td>
<td>Tests two
pairs for inequality.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.support.pair.header"></a><h4>
<a name="id458254"></a>
<a name="id926931"></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="id458346"></a>
<a name="id927011"></a>
<a href="pair.html#fusion.support.pair.example">Example</a>
</h4>
<pre class="programlisting">