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

42
doc/html/fusion/sequences/intrinsics/functions/at.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>at</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="../functions.html" title="Functions">
<link rel="prev" href="size.html" title="size">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.at"></a><a href="at.html" title="at">at</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.at.description"></a><h6>
<a name="id510662"></a>
<a name="id1008089"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.description">Description</a>
</h6>
<p>
Returns the N-th element from the beginning of the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.at.synopsis"></a><h6>
<a name="id510694"></a>
<a name="id1008118"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">N</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/at.html" title="at"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/at.html" title="at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">N</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/at.html" title="at"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/at.html" title="at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at.parameters"></a><h6>
<a name="id511025"></a>
<a name="id1008409"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -62,7 +62,7 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
@ -71,7 +71,7 @@
<td>The sequence we wish to investigate.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">N</span></tt></td>
<td><code class="computeroutput"><span class="identifier">N</span></code></td>
<td>An
<a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>
integral constant</td>
@ -81,7 +81,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.at.expression_semantics"></a><h6>
<a name="id511141"></a>
<a name="id1008512"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.expression_semantics">Expression
Semantics</a>
</h6>
@ -89,38 +89,38 @@
<span class="identifier">at</span><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Returns a reference to
the N-th element from the beginning of the sequence <tt class="computeroutput"><span class="identifier">seq</span></tt>
if <tt class="computeroutput"><span class="identifier">seq</span></tt> is mutable and
<tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></tt>, where <tt class="computeroutput"><span class="identifier">e</span></tt>
<span class="bold"><strong>Return type</strong></span>: Returns a reference to
the N-th element from the beginning of the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
<code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
is the N-th element from the beginning of the sequence, is a valid expression.
Else, returns a type convertable to the N-th element from the beginning
of the sequence.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: <tt class="computeroutput"><span class="number">0</span>
<span class="special">&lt;=</span> <span class="identifier">N</span><span class="special">::</span><span class="identifier">value</span> <span class="special">&lt;</span> <a href="size.html" title="size"><tt class="computeroutput"><span class="identifier">size</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
<span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><span class="number">0</span>
<span class="special">&lt;=</span> <span class="identifier">N</span><span class="special">::</span><span class="identifier">value</span> <span class="special">&lt;</span> <a href="size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to
<span class="bold"><strong>Semantics</strong></span>: Equivalent to
</p>
<pre class="programlisting">
<a href="../../../iterators/functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><a href="../../../iterators/functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><a href="begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)))</span>
<a href="../../../iterators/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><a href="../../../iterators/functions/advance.html" title="advance"><code class="computeroutput"><span class="identifier">advance</span></code></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><a href="begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)))</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at.header"></a><h6>
<a name="id511449"></a>
<a name="id1008784"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">at</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at.example"></a><h6>
<a name="id511552"></a>
<a name="id1008874"></a>
<a href="at.html#fusion.sequences.intrinsics.functions.at.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">at</span><span class="special">&lt;</span><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">int_</span><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;</span> <span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">2</span><span class="special">);</span>
</pre>
</div>

42
doc/html/fusion/sequences/intrinsics/functions/at_c.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>at_c</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="../functions.html" title="Functions">
<link rel="prev" href="at.html" title="at">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.at_c"></a><a href="at_c.html" title="at_c">at_c</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.at_c.description"></a><h6>
<a name="id511783"></a>
<a name="id1009079"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.description">Description</a>
</h6>
<p>
Returns the N-th element from the beginning of the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.at_c.synopsis"></a><h6>
<a name="id511814"></a>
<a name="id1009108"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">int</span> <span class="identifier">N</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at_c</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">int</span> <span class="identifier">N</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at_c</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at_c.parameters"></a><h6>
<a name="id512148"></a>
<a name="id1009402"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -62,7 +62,7 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
@ -71,7 +71,7 @@
<td>The sequence we wish to investigate.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">N</span></tt></td>
<td><code class="computeroutput"><span class="identifier">N</span></code></td>
<td>An
integral constant</td>
<td>An index from the beginning of
@ -80,7 +80,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.at_c.expression_semantics"></a><h6>
<a name="id512257"></a>
<a name="id1009499"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.expression_semantics">Expression
Semantics</a>
</h6>
@ -88,39 +88,39 @@
<span class="identifier">at_c</span><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Returns a reference to
the N-th element from the beginning of the sequence <tt class="computeroutput"><span class="identifier">seq</span></tt>
if <tt class="computeroutput"><span class="identifier">seq</span></tt> is mutable and
<tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></tt>, where <tt class="computeroutput"><span class="identifier">e</span></tt>
<span class="bold"><strong>Return type</strong></span>: Returns a reference to
the N-th element from the beginning of the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
<code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
is the N-th element from the beginning of the sequence, is a valid expression.
Else, returns a type convertable to the N-th element from the beginning
of the sequence.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: <tt class="computeroutput"><span class="number">0</span>
<span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><span class="number">0</span>
<span class="special">&lt;=</span> <span class="identifier">N</span>
<span class="special">&lt;</span> <a href="size.html" title="size"><tt class="computeroutput"><span class="identifier">size</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
<span class="special">&lt;</span> <a href="size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to
<span class="bold"><strong>Semantics</strong></span>: Equivalent to
</p>
<pre class="programlisting">
<a href="../../../iterators/functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><a href="../../../iterators/functions/advance.html" title="advance"><tt class="computeroutput"><span class="identifier">advance</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><a href="begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">s</span><span class="special">)))</span>
<a href="../../../iterators/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><a href="../../../iterators/functions/advance.html" title="advance"><code class="computeroutput"><span class="identifier">advance</span></code></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><a href="begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)))</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at_c.header"></a><h6>
<a name="id512556"></a>
<a name="id1009762"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">at_c</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at_c.example"></a><h6>
<a name="id512661"></a>
<a name="id1009855"></a>
<a href="at_c.html#fusion.sequences.intrinsics.functions.at_c.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">at_c</span><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">2</span><span class="special">);</span>
</pre>
</div>

38
doc/html/fusion/sequences/intrinsics/functions/at_key.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>at_key</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="../functions.html" title="Functions">
<link rel="prev" href="has_key.html" title="has_key">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.at_key"></a><a href="at_key.html" title="at_key">at_key</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.at_key.description"></a><h6>
<a name="id513650"></a>
<a name="id1010731"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.description">Description</a>
</h6>
<p>
Returns the element associated with a Key from the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.at_key.synopsis"></a><h6>
<a name="id513682"></a>
<a name="id1010760"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Key</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/at_key.html" title="at_key"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_key</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/at_key.html" title="at_key"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_key</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at_key</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Key</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/at_key.html" title="at_key"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_key</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/at_key.html" title="at_key"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_key</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">at_key</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at_key.parameters"></a><h6>
<a name="id514015"></a>
<a name="id1011053"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -62,7 +62,7 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/associative_sequence.html" title="Associative
Sequence">Associative
@ -71,7 +71,7 @@
<td>The sequence we wish to investigate.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">Key</span></tt></td>
<td><code class="computeroutput"><span class="identifier">Key</span></code></td>
<td>Any
type</td>
<td>The queried key.</td>
@ -79,7 +79,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.at_key.expression_semantics"></a><h6>
<a name="id514123"></a>
<a name="id1011151"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.expression_semantics">Expression
Semantics</a>
</h6>
@ -87,34 +87,34 @@
<span class="identifier">at_key</span><span class="special">&lt;</span><span class="identifier">Key</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Returns a reference to
the element associated with Key from the sequence <tt class="computeroutput"><span class="identifier">seq</span></tt>
if <tt class="computeroutput"><span class="identifier">seq</span></tt> is mutable and
<tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></tt>, where <tt class="computeroutput"><span class="identifier">e</span></tt>
<span class="bold"><strong>Return type</strong></span>: Returns a reference to
the element associated with Key from the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
<code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
is the element associated with Key, is a valid expression. Else, returns
a type convertable to the element associated with Key.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: <tt class="computeroutput"><span class="identifier">has_key</span><span class="special">&lt;</span><span class="identifier">Key</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span></tt>
<span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><span class="identifier">has_key</span><span class="special">&lt;</span><span class="identifier">Key</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the element associated
<span class="bold"><strong>Semantics</strong></span>: Returns the element associated
with Key.
</p>
<a name="fusion.sequences.intrinsics.functions.at_key.header"></a><h6>
<a name="id514322"></a>
<a name="id1011328"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">at_key</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.at_key.example"></a><h6>
<a name="id514428"></a>
<a name="id1011421"></a>
<a href="at_key.html#fusion.sequences.intrinsics.functions.at_key.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">&gt;</span> <span class="identifier">s</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'x'</span><span class="special">,</span> <span class="keyword">true</span><span class="special">);</span>
<a href="../../containers/set.html" title="set"><code class="computeroutput"><span class="identifier">set</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">&gt;</span> <span class="identifier">s</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'x'</span><span class="special">,</span> <span class="keyword">true</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">at_key</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">&gt;(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">==</span> <span class="char">'x'</span><span class="special">);</span>
</pre>
</div>

36
doc/html/fusion/sequences/intrinsics/functions/back.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>back</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="../functions.html" title="Functions">
<link rel="prev" href="front.html" title="front">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.back"></a><a href="back.html" title="back">back</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.back.description"></a><h6>
<a name="id509112"></a>
<a name="id1006716"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.description">Description</a>
</h6>
<p>
Returns the last element in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.back.synopsis"></a><h6>
<a name="id509143"></a>
<a name="id1006744"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/back.html" title="back"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/back.html" title="back"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">back</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/back.html" title="back"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/back.html" title="back"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">back</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.back.parameters"></a><h6>
<a name="id509419"></a>
<a name="id1006987"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,7 +61,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
@ -71,7 +71,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.back.expression_semantics"></a><h6>
<a name="id509505"></a>
<a name="id1007065"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.expression_semantics">Expression
Semantics</a>
</h6>
@ -79,34 +79,34 @@
<span class="identifier">back</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Returns a reference to
the last element in the sequence <tt class="computeroutput"><span class="identifier">seq</span></tt>
if <tt class="computeroutput"><span class="identifier">seq</span></tt> is mutable and
<tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></tt>, where <tt class="computeroutput"><span class="identifier">e</span></tt>
<span class="bold"><strong>Return type</strong></span>: Returns a reference to
the last element in the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
<code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
is the last element in the sequence, is a valid expression. Else, returns
a type convertable to the last element in the sequence.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: <tt class="computeroutput"><a href="empty.html" title="empty"><tt class="computeroutput"><span class="identifier">empty</span></tt></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></tt>
<span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><a href="empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the last element
<span class="bold"><strong>Semantics</strong></span>: Returns the last element
in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.back.header"></a><h6>
<a name="id509694"></a>
<a name="id1007232"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">back</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.back.example"></a><h6>
<a name="id509800"></a>
<a name="id1007325"></a>
<a href="back.html#fusion.sequences.intrinsics.functions.back.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">back</span><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
</pre>
</div>

34
doc/html/fusion/sequences/intrinsics/functions/begin.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>begin</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="../functions.html" title="Functions">
<link rel="prev" href="../functions.html" title="Functions">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.begin"></a><a href="begin.html" title="begin">begin</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.begin.description"></a><h6>
<a name="id505740"></a>
<a name="id1003725"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.description">Description</a>
</h6>
<p>
Returns an iterator pointing to the first element in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.begin.synopsis"></a><h6>
<a name="id505772"></a>
<a name="id1003754"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">begin</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">begin</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.begin.parameters"></a><h6>
<a name="id506048"></a>
<a name="id1003997"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,7 +61,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -72,7 +72,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.begin.expression_semantics"></a><h6>
<a name="id506136"></a>
<a name="id1004077"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.expression_semantics">Expression
Semantics</a>
</h6>
@ -80,41 +80,41 @@
<span class="identifier">begin</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: <a href="../../../iterators/concepts/forward_iterator.html" title="Forward
<span class="bold"><strong>Return type</strong></span>: <a href="../../../iterators/concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> else, <a href="../../../iterators/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> else, <a href="../../../iterators/concepts/random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Access Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns an iterator pointing
<span class="bold"><strong>Semantics</strong></span>: Returns an iterator pointing
to the first element in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.begin.header"></a><h6>
<a name="id506302"></a>
<a name="id1004224"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">begin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.begin.example"></a><h6>
<a name="id506406"></a>
<a name="id1004316"></a>
<a href="begin.html#fusion.sequences.intrinsics.functions.begin.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterators/functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterators/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

32
doc/html/fusion/sequences/intrinsics/functions/empty.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>empty</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="../functions.html" title="Functions">
<link rel="prev" href="end.html" title="end">
@ -26,25 +26,25 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.empty"></a><a href="empty.html" title="empty">empty</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.empty.description"></a><h6>
<a name="id507517"></a>
<a name="id1005301"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.description">Description</a>
</h6>
<p>
Returns a type convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>
that evaluates to <tt class="computeroutput"><span class="keyword">true</span></tt> if
the sequence is empty, else, evaluates to <tt class="computeroutput"><span class="keyword">false</span></tt>.
Returns a type convertible to <code class="computeroutput"><span class="keyword">bool</span></code>
that evaluates to <code class="computeroutput"><span class="keyword">true</span></code> if
the sequence is empty, else, evaluates to <code class="computeroutput"><span class="keyword">false</span></code>.
</p>
<a name="fusion.sequences.intrinsics.functions.empty.synopsis"></a><h6>
<a name="id507580"></a>
<a name="id1005357"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/empty.html" title="empty"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">empty</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/empty.html" title="empty"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">empty</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">empty</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.empty.parameters"></a><h6>
<a name="id507733"></a>
<a name="id1005492"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -59,7 +59,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -69,7 +69,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.empty.expression_semantics"></a><h6>
<a name="id507820"></a>
<a name="id1005572"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.expression_semantics">Expression
Semantics</a>
</h6>
@ -77,25 +77,25 @@
<span class="identifier">empty</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Evaluates to <tt class="computeroutput"><span class="keyword">true</span></tt> if the sequence is empty, else, evaluates
to <tt class="computeroutput"><span class="keyword">false</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Evaluates to <code class="computeroutput"><span class="keyword">true</span></code> if the sequence is empty, else, evaluates
to <code class="computeroutput"><span class="keyword">false</span></code>.
</p>
<a name="fusion.sequences.intrinsics.functions.empty.header"></a><h6>
<a name="id507928"></a>
<a name="id1005579"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">empty</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.empty.example"></a><h6>
<a name="id508033"></a>
<a name="id1005759"></a>
<a href="empty.html#fusion.sequences.intrinsics.functions.empty.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span><span class="special">);</span>
</pre>
</div>

34
doc/html/fusion/sequences/intrinsics/functions/end.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>end</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="../functions.html" title="Functions">
<link rel="prev" href="begin.html" title="begin">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.end"></a><a href="end.html" title="end">end</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.end.description"></a><h6>
<a name="id506621"></a>
<a name="id1004506"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.description">Description</a>
</h6>
<p>
Returns an iterator pointing to one element past the end of the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.end.synopsis"></a><h6>
<a name="id506653"></a>
<a name="id1004535"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/end.html" title="end"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/end.html" title="end"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">end</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/end.html" title="end"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/end.html" title="end"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">end</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">end</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.end.parameters"></a><h6>
<a name="id506928"></a>
<a name="id1004777"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,7 +61,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -72,7 +72,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.end.expression_semantics"></a><h6>
<a name="id507015"></a>
<a name="id1004855"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.expression_semantics">Expression
Semantics</a>
</h6>
@ -80,41 +80,41 @@
<span class="identifier">end</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: <a href="../../../iterators/concepts/forward_iterator.html" title="Forward
<span class="bold"><strong>Return type</strong></span>: <a href="../../../iterators/concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> else, <a href="../../../iterators/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> else, <a href="../../../iterators/concepts/random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
Access Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a href="../../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns an iterator pointing
<span class="bold"><strong>Semantics</strong></span>: Returns an iterator pointing
to one element past the end of the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.end.header"></a><h6>
<a name="id507180"></a>
<a name="id1005002"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">end</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.end.example"></a><h6>
<a name="id507285"></a>
<a name="id1005095"></a>
<a href="end.html#fusion.sequences.intrinsics.functions.end.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterators/functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><a href="../../../iterators/functions/prior.html" title="prior"><tt class="computeroutput"><span class="identifier">prior</span></tt></a><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterators/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><a href="../../../iterators/functions/prior.html" title="prior"><code class="computeroutput"><span class="identifier">prior</span></code></a><span class="special">(</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

36
doc/html/fusion/sequences/intrinsics/functions/front.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>front</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="../functions.html" title="Functions">
<link rel="prev" href="empty.html" title="empty">
@ -26,27 +26,27 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.front"></a><a href="front.html" title="front">front</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.front.description"></a><h6>
<a name="id508229"></a>
<a name="id1005932"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.description">Description</a>
</h6>
<p>
Returns the first element in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.front.synopsis"></a><h6>
<a name="id508259"></a>
<a name="id1005961"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/front.html" title="front"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/front.html" title="front"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">front</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/front.html" title="front"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/front.html" title="front"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">front</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">front</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.front.parameters"></a><h6>
<a name="id508535"></a>
<a name="id1006204"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,7 +61,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -71,7 +71,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.front.expression_semantics"></a><h6>
<a name="id508623"></a>
<a name="id1006283"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.expression_semantics">Expression
Semantics</a>
</h6>
@ -79,34 +79,34 @@
<span class="identifier">front</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Returns a reference to
the first element in the sequence <tt class="computeroutput"><span class="identifier">seq</span></tt>
if <tt class="computeroutput"><span class="identifier">seq</span></tt> is mutable and
<tt class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></tt>, where <tt class="computeroutput"><span class="identifier">e</span></tt>
<span class="bold"><strong>Return type</strong></span>: Returns a reference to
the first element in the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
<code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
<span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
is the first element in the sequence, is a valid expression. Else, returns
a type convertable to the first element in the sequence.
</p>
<p>
<span class="bold"><b>Precondition</b></span>: <tt class="computeroutput"><a href="empty.html" title="empty"><tt class="computeroutput"><span class="identifier">empty</span></tt></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></tt>
<span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><a href="empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the first element
<span class="bold"><strong>Semantics</strong></span>: Returns the first element
in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.front.header"></a><h6>
<a name="id508811"></a>
<a name="id1006450"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">front</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.front.example"></a><h6>
<a name="id508917"></a>
<a name="id1006544"></a>
<a href="front.html#fusion.sequences.intrinsics.functions.front.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">front</span><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
</pre>
</div>

34
doc/html/fusion/sequences/intrinsics/functions/has_key.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>has_key</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="../functions.html" title="Functions">
<link rel="prev" href="at_c.html" title="at_c">
@ -26,26 +26,26 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.has_key"></a><a href="has_key.html" title="has_key">has_key</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.has_key.description"></a><h6>
<a name="id512865"></a>
<a name="id1010037"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.description">Description</a>
</h6>
<p>
Returns a type convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>
that evaluates to <tt class="computeroutput"><span class="keyword">true</span></tt> if
Returns a type convertible to <code class="computeroutput"><span class="keyword">bool</span></code>
that evaluates to <code class="computeroutput"><span class="keyword">true</span></code> if
the sequence contains an element associated with a Key, else, evaluates
to <tt class="computeroutput"><span class="keyword">false</span></tt>.
to <code class="computeroutput"><span class="keyword">false</span></code>.
</p>
<a name="fusion.sequences.intrinsics.functions.has_key.synopsis"></a><h6>
<a name="id512929"></a>
<a name="id1010094"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Key</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/has_key.html" title="has_key"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">has_key</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/has_key.html" title="has_key"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">has_key</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">Key</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">has_key</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.has_key.parameters"></a><h6>
<a name="id513112"></a>
<a name="id1010255"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -61,7 +61,7 @@
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/associative_sequence.html" title="Associative
Sequence">Associative
@ -70,7 +70,7 @@
<td>The sequence we wish to investigate.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">Key</span></tt></td>
<td><code class="computeroutput"><span class="identifier">Key</span></code></td>
<td>Any
type</td>
<td>The queried key.</td>
@ -78,7 +78,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.has_key.expression_semantics"></a><h6>
<a name="id513221"></a>
<a name="id1010352"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.expression_semantics">Expression
Semantics</a>
</h6>
@ -86,25 +86,25 @@
<span class="identifier">has_key</span><span class="special">&lt;</span><span class="identifier">Key</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Evaluates to <tt class="computeroutput"><span class="keyword">true</span></tt> if the sequence contains an element
associated with Key, else, evaluates to <tt class="computeroutput"><span class="keyword">false</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Evaluates to <code class="computeroutput"><span class="keyword">true</span></code> if the sequence contains an element
associated with Key, else, evaluates to <code class="computeroutput"><span class="keyword">false</span></code>.
</p>
<a name="fusion.sequences.intrinsics.functions.has_key.header"></a><h6>
<a name="id513338"></a>
<a name="id1010360"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">has_key</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.has_key.example"></a><h6>
<a name="id513444"></a>
<a name="id1010549"></a>
<a href="has_key.html#fusion.sequences.intrinsics.functions.has_key.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/set.html" title="set"><tt class="computeroutput"><span class="identifier">set</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">&gt;</span> <span class="identifier">s</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'x'</span><span class="special">,</span> <span class="keyword">true</span><span class="special">);</span>
<a href="../../containers/set.html" title="set"><code class="computeroutput"><span class="identifier">set</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">&gt;</span> <span class="identifier">s</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="char">'x'</span><span class="special">,</span> <span class="keyword">true</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">has_key</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">&gt;(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">true</span><span class="special">);</span>
</pre>
</div>

26
doc/html/fusion/sequences/intrinsics/functions/size.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>size</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="../functions.html" title="Functions">
<link rel="prev" href="back.html" title="back">
@ -26,24 +26,24 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.intrinsics.functions.size"></a><a href="size.html" title="size">size</a></h5></div></div></div>
<a name="fusion.sequences.intrinsics.functions.size.description"></a><h6>
<a name="id509995"></a>
<a name="id1007498"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.description">Description</a>
</h6>
<p>
Returns a type convertible to <tt class="computeroutput"><span class="keyword">int</span></tt>
Returns a type convertible to <code class="computeroutput"><span class="keyword">int</span></code>
that evaluates the number of elements in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.size.synopsis"></a><h6>
<a name="id510037"></a>
<a name="id1007536"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../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">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">size</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.size.parameters"></a><h6>
<a name="id510191"></a>
<a name="id1007672"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -58,7 +58,7 @@
<th>Description</th>
</tr></thead>
<tbody><tr>
<td><tt class="computeroutput"><span class="identifier">seq</span></tt></td>
<td><code class="computeroutput"><span class="identifier">seq</span></code></td>
<td>Model
of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
@ -68,7 +68,7 @@
</tr></tbody>
</table></div>
<a name="fusion.sequences.intrinsics.functions.size.expression_semantics"></a><h6>
<a name="id510277"></a>
<a name="id1007749"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.expression_semantics">Expression
Semantics</a>
</h6>
@ -76,25 +76,25 @@
<span class="identifier">size</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">int</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">int</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Returns the number of elements
<span class="bold"><strong>Semantics</strong></span>: Returns the number of elements
in the sequence.
</p>
<a name="fusion.sequences.intrinsics.functions.size.header"></a><h6>
<a name="id510362"></a>
<a name="id1007824"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.header">Header</a>
</h6>
<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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">size</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.intrinsics.functions.size.example"></a><h6>
<a name="id510468"></a>
<a name="id1007917"></a>
<a href="size.html#fusion.sequences.intrinsics.functions.size.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">size</span><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
</pre>
</div>