adds documentation for functional module

[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

View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Intrinsics</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="../sequences.html" title="Sequences">
<link rel="prev" href="adapted/boost__variant.html" title="boost::variant">
@ -27,7 +27,34 @@
<a name="fusion.sequences.intrinsics"></a><a href="intrinsics.html" title="Intrinsics">Intrinsics</a></h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="intrinsics/functions.html">Functions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="intrinsics/functions/begin.html">begin</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/end.html">end</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/empty.html">empty</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/front.html">front</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/back.html">back</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/size.html">size</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/at.html">at</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/at_c.html">at_c</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/has_key.html">has_key</a></span></dt>
<dt><span class="section"><a href="intrinsics/functions/at_key.html">at_key</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="intrinsics/metafunctions.html">Metafunctions</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="intrinsics/metafunctions/begin.html">begin</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/end.html">end</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/empty.html">empty</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/front.html">front</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/back.html">back</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/size.html">size</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/at.html">at</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/at_c.html">at_c</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/value_at.html">value_at</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/value_at_c.html">value_at_c</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/has_key.html">has_key</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/at_key.html">at_key</a></span></dt>
<dt><span class="section"><a href="intrinsics/metafunctions/value_at_key.html">value_at_key</a></span></dt>
</dl></dd>
</dl></div>
<p>
Intrinsics form the essential interface of Fusion <span class="underline">_sequence</span>_s.
@ -36,11 +63,11 @@
Intrinsic functions, unlike <a href="../algorithms.html" title="Algorithms">Algorithms</a>,
are not generic across the full <a href="../sequences.html" title="Sequences">Sequence</a>
repertoire. They need to be implemented for each Fusion <a href="../sequences.html" title="Sequences">Sequence</a>
<sup>[<a name="id505587" href="#ftn.id505587">5</a>]</sup>
<sup>[<a name="id1003590" href="#ftn.id1003590">5</a>]</sup>
.
</p>
<a name="fusion.sequences.intrinsics.header"></a><h4>
<a name="id505606"></a>
<a name="id1003608"></a>
<a href="intrinsics.html#fusion.sequences.intrinsics.header">Header</a>
</h4>
<pre class="programlisting">
@ -48,7 +75,7 @@
</pre>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id505587" href="#id505587">5</a>] </sup>
<div class="footnote"><p><sup>[<a name="ftn.id1003590" href="#id1003590">5</a>] </sup>
In practice, many of intrinsic functions have default implementations
that will work in majority of cases
</p></div>