forked from boostorg/fusion
adds documentation for functional module
[SVN r36959]
This commit is contained in:
Tobias Schwinger
@ -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="../metafunctions.html" title="Metafunctions">
|
||||
<link rel="prev" href="size.html" title="size">
|
||||
@ -26,16 +26,16 @@
|
||||
<div class="titlepage"><div><div><h5 class="title">
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at"></a><a href="at.html" title="at">at</a></h5></div></div></div>
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at.description"></a><h6>
|
||||
<a name="id518956"></a>
|
||||
<a name="id1032914"></a>
|
||||
<a href="at.html#fusion.sequences.intrinsics.metafunctions.at.description">Description</a>
|
||||
</h6>
|
||||
<p>
|
||||
Returns the result type of <a href="../functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a>
|
||||
<sup>[<a name="id518993" href="#ftn.id518993">6</a>]</sup>
|
||||
Returns the result type of <a href="../functions/at.html" title="at"><code class="computeroutput"><span class="identifier">at</span></code></a>
|
||||
<sup>[<a name="id1032947" href="#ftn.id1032947">6</a>]</sup>
|
||||
.
|
||||
</p>
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at.synopsis"></a><h6>
|
||||
<a name="id519105"></a>
|
||||
<a name="id1033047"></a>
|
||||
<a href="at.html#fusion.sequences.intrinsics.metafunctions.at.synopsis">Synopsis</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
@ -48,7 +48,7 @@
|
||||
<span class="special">};</span>
|
||||
</pre>
|
||||
<div class="table">
|
||||
<a name="id519221"></a><p class="title"><b>Table<EFBFBD>1.25.<2E>Parameters</b></p>
|
||||
<a name="id1033149"></a><p class="title"><b>Table<EFBFBD>1.25.<2E>Parameters</b></p>
|
||||
<table class="table" summary="Parameters">
|
||||
<colgroup>
|
||||
<col>
|
||||
@ -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>A
|
||||
model of <a href="../../concepts/forward_sequence.html" title="Forward
|
||||
Sequence">Forward
|
||||
@ -71,16 +71,18 @@
|
||||
<td>Argument sequence</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
|
||||
MPL Integral Constant</td>
|
||||
<a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
|
||||
Integral Constant</a>
|
||||
</td>
|
||||
<td>Index of element</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at.expression_semantics"></a><h6>
|
||||
<a name="id519316"></a>
|
||||
<a name="id1033241"></a>
|
||||
<a href="at.html#fusion.sequences.intrinsics.metafunctions.at.expression_semantics">Expression
|
||||
Semantics</a>
|
||||
</h6>
|
||||
@ -88,34 +90,34 @@
|
||||
<span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span><span class="special"><</span><span class="identifier">Seq</span><span class="special">,</span> <span class="identifier">N</span><span class="special">>::</span><span class="identifier">type</span>
|
||||
</pre>
|
||||
<p>
|
||||
<span class="bold"><b>Return type</b></span>: Any type.
|
||||
<span class="bold"><strong>Return type</strong></span>: Any type.
|
||||
</p>
|
||||
<p>
|
||||
<span class="bold"><b>Semantics</b></span>: Returns the result type of
|
||||
using <a href="../functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a> to access the <tt class="computeroutput"><span class="identifier">N</span></tt>th element of <tt class="computeroutput"><span class="identifier">Seq</span></tt>.
|
||||
<span class="bold"><strong>Semantics</strong></span>: Returns the result type of
|
||||
using <a href="../functions/at.html" title="at"><code class="computeroutput"><span class="identifier">at</span></code></a> to access the <code class="computeroutput"><span class="identifier">N</span></code>th element of <code class="computeroutput"><span class="identifier">Seq</span></code>.
|
||||
</p>
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at.header"></a><h6>
|
||||
<a name="id519456"></a>
|
||||
<a name="id1033362"></a>
|
||||
<a href="at.html#fusion.sequences.intrinsics.metafunctions.at.header">Header</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
<span class="preprocessor">#include</span> <span class="special"><</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">></span>
|
||||
</pre>
|
||||
<a name="fusion.sequences.intrinsics.metafunctions.at.example"></a><h6>
|
||||
<a name="id519561"></a>
|
||||
<a name="id1033455"></a>
|
||||
<a href="at.html#fusion.sequences.intrinsics.metafunctions.at.example">Example</a>
|
||||
</h6>
|
||||
<pre class="programlisting">
|
||||
<span class="keyword">typedef</span> <a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">float</span><span class="special">,</span><span class="keyword">char</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span>
|
||||
<span class="identifier">BOOST_MPL_ASSERT</span><span class="special">((</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special"><</span><a href="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"><</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">int_</span><span class="special"><</span><span class="number">1</span><span class="special">></span> <span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">float</span><span class="special">&>));</span>
|
||||
<span class="keyword">typedef</span> <a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">float</span><span class="special">,</span><span class="keyword">char</span><span class="special">></span> <span class="identifier">vec</span><span class="special">;</span>
|
||||
<span class="identifier">BOOST_MPL_ASSERT</span><span class="special">((</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special"><</span><a href="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"><</span><span class="identifier">vec</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">int_</span><span class="special"><</span><span class="number">1</span><span class="special">></span> <span class="special">>::</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">float</span><span class="special">&>));</span>
|
||||
</pre>
|
||||
<div class="footnotes">
|
||||
<br><hr width="100" align="left">
|
||||
<div class="footnote"><p><sup>[<a name="ftn.id518993" href="#id518993">6</a>] </sup>
|
||||
<a href="at.html" title="at"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></tt></a> reflects the actual return
|
||||
type of the function <a href="../functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a>. <span class="underline">_sequence</span>_s
|
||||
typically return references to its elements via the <a href="../functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a> function. If you want
|
||||
to get the actual element type, use <a href="value_at.html" title="value_at"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at</span></tt></a>
|
||||
<div class="footnote"><p><sup>[<a name="ftn.id1032947" href="#id1032947">6</a>] </sup>
|
||||
<a href="at.html" title="at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></code></a> reflects the actual return
|
||||
type of the function <a href="../functions/at.html" title="at"><code class="computeroutput"><span class="identifier">at</span></code></a>. <span class="underline">_sequence</span>_s
|
||||
typically return references to its elements via the <a href="../functions/at.html" title="at"><code class="computeroutput"><span class="identifier">at</span></code></a> function. If you want
|
||||
to get the actual element type, use <a href="value_at.html" title="value_at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">value_at</span></code></a>
|
||||
</p></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user