feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
f27ed26e44e30c00512cd59de941a94d5dfb454c
boost_fusion/doc/html/fusion/algorithm.html

126 lines
10 KiB
HTML
Raw Normal View History

Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<html>
<head>
corrected reverse_view [SVN r58299]
2009-12-11 21:01:22 +00:00
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<title>Algorithm</title>
Rebuild fusion documentation. [SVN r63626]
2010-07-04 19:20:50 +00:00
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
corrected reverse_view [SVN r58299]
2009-12-11 21:01:22 +00:00
<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
documentation update [SVN r61202]
2010-04-11 15:01:17 +00:00
<link rel="prev" href="adapted/define_assoc_tpl_struct.html" title="BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT">
Added docs for copy [SVN r72929]
2011-07-06 18:16:56 +00:00
<link rel="next" href="algorithm/auxiliary.html" title="Auxiliary">
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
pair doc fix [SVN r47527]
2008-07-17 23:59:22 +00:00
<td align="center"><a href="../../../../../index.html">Home</a></td>
Rebuild fusion documentation. [SVN r63626]
2010-07-04 19:20:50 +00:00
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
pair doc fix [SVN r47527]
2008-07-17 23:59:22 +00:00
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
Added docs for copy [SVN r72929]
2011-07-06 18:16:56 +00:00
<a accesskey="p" href="adapted/define_assoc_tpl_struct.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm/auxiliary.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
</div>
documentation update - fixes #4281 [SVN r62398]
2010-06-03 08:29:23 +00:00
<div class="section">
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="fusion.algorithm"></a><a class="link" href="algorithm.html" title="Algorithm">Algorithm</a>
</h2></div></div></div>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<div class="toc"><dl>
Added docs for copy [SVN r72929]
2011-07-06 18:16:56 +00:00
<dt><span class="section"><a href="algorithm/auxiliary.html">Auxiliary</a></span></dt>
<dd><dl><dt><span class="section"><a href="algorithm/auxiliary/functions.html">Functions</a></span></dt></dl></dd>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<dt><span class="section"><a href="algorithm/iteration.html">Iteration</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="algorithm/iteration/functions.html">Functions</a></span></dt>
<dt><span class="section"><a href="algorithm/iteration/metafunctions.html">Metafunctions</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="algorithm/query.html">Query</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="algorithm/query/functions.html">Functions</a></span></dt>
<dt><span class="section"><a href="algorithm/query/metafunctions.html">Metafunctions</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="algorithm/transformation.html">Transformation</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="algorithm/transformation/functions.html">Functions</a></span></dt>
<dt><span class="section"><a href="algorithm/transformation/metafunctions.html">Metafunctions</a></span></dt>
</dl></dd>
</dl></div>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a name="fusion.algorithm.lazy_evaluation"></a><h4>
make single_view random access [SVN r72977]
2011-07-08 19:42:35 +00:00
<a name="fusion.algorithm.lazy_evaluation-heading"></a>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a class="link" href="algorithm.html#fusion.algorithm.lazy_evaluation">Lazy Evaluation</a>
</h4>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<p>
Unlike <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>, Fusion
make single_view random access [SVN r72977]
2011-07-08 19:42:35 +00:00
algorithms are lazy<sup>[<a name="id1025231" href="#ftn.id1025231" class="footnote">10</a>]</sup> and non sequence-type preserving <sup>[<a name="id1025259" href="#ftn.id1025259" class="footnote">11</a>]</sup>. This is by design. Runtime efficiency is given a high priority.
Like <a href="http://www.boost.org/libs/mpl/index.html" target="_top">MPL</a>, and
unlike <a href="http://en.wikipedia.org/wiki/Standard_Template_Library" target="_top">STL</a>,
fusion algorithms are mostly functional in nature such that algorithms are
non mutating (no side effects). However, due to the high cost of returning
full sequences such as vectors and lists, <span class="emphasis"><em>Views</em></span> are returned
from Fusion algorithms instead. For example, the <a class="link" href="algorithm/transformation/functions/transform.html" title="transform"><code class="computeroutput"><span class="identifier">transform</span></code></a> algorithm does not actually
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
return a transformed version of the original sequence. <a class="link" href="algorithm/transformation/functions/transform.html" title="transform"><code class="computeroutput"><span class="identifier">transform</span></code></a> returns a <a class="link" href="view/transform_view.html" title="transform_view"><code class="computeroutput"><span class="identifier">transform_view</span></code></a>. This view holds a
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
reference to the original sequence plus the transform function. Iteration over
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
the <a class="link" href="view/transform_view.html" title="transform_view"><code class="computeroutput"><span class="identifier">transform_view</span></code></a>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
will apply the transform function over the sequence elements on demand. This
<span class="emphasis"><em>lazy</em></span> evaluation scheme allows us to chain as many algorithms
as we want without incurring a high runtime penalty.
</p>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a name="fusion.algorithm.sequence_extension"></a><h4>
make single_view random access [SVN r72977]
2011-07-08 19:42:35 +00:00
<a name="fusion.algorithm.sequence_extension-heading"></a>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a class="link" href="algorithm.html#fusion.algorithm.sequence_extension">Sequence Extension</a>
</h4>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<p>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
The <span class="emphasis"><em>lazy</em></span> evaluation scheme where <a class="link" href="algorithm.html" title="Algorithm">Algorithms</a>
return <a class="link" href="view.html" title="View">Views</a> also allows operations such
as <a class="link" href="algorithm/transformation/functions/push_back.html" title="push_back"><code class="computeroutput"><span class="identifier">push_back</span></code></a> to be totally generic. In
Fusion, <a class="link" href="algorithm/transformation/functions/push_back.html" title="push_back"><code class="computeroutput"><span class="identifier">push_back</span></code></a> is actually a generic algorithm
that works on all sequences. Given an input sequence <code class="computeroutput"><span class="identifier">s</span></code>
and a value <code class="computeroutput"><span class="identifier">x</span></code>, Fusion's <a class="link" href="algorithm/transformation/functions/push_back.html" title="push_back"><code class="computeroutput"><span class="identifier">push_back</span></code></a> algorithm simply returns
a <a class="link" href="view/joint_view.html" title="joint_view"><code class="computeroutput"><span class="identifier">joint_view</span></code></a>:
a view that holds a reference to the original sequence <code class="computeroutput"><span class="identifier">s</span></code>
and the value <code class="computeroutput"><span class="identifier">x</span></code>. Functions
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
that were once sequence specific and need to be implemented N times over N
different sequences are now implemented only once. That is to say that Fusion
Added docs for copy [SVN r72930]
2011-07-06 18:29:02 +00:00
sequences are cheaply extensible.
</p>
<p>
To regain the original sequence, <a class="link" href="container/conversion/functions.html" title="Functions">Conversion</a>
added reverse_fold/iter_fold/reverse_iter_fold (2) (fixes #1623) [SVN r63083]
2010-06-18 17:23:20 +00:00
functions are provided. You may use one of the <a class="link" href="container/conversion/functions.html" title="Functions">Conversion</a>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
functions to convert back to the original sequence type.
</p>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a name="fusion.algorithm.header"></a><h4>
make single_view random access [SVN r72977]
2011-07-08 19:42:35 +00:00
<a name="fusion.algorithm.header-heading"></a>
Fusion: added nview and friends, docs and tests [SVN r56377]
2009-09-25 00:21:53 +00:00
<a class="link" href="algorithm.html#fusion.algorithm.header">Header</a>
</h4>
updates functional module: only two unfused variants, now [SVN r51381]
2009-02-22 06:27:12 +00:00
<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">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
<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">include</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
Added docs for copy [SVN r72930]
2011-07-06 18:29:02 +00:00
<div class="footnotes">
<br><hr width="100" align="left">
make single_view random access [SVN r72977]
2011-07-08 19:42:35 +00:00
<div class="footnote"><p><sup>[<a name="ftn.id1025231" href="#id1025231" class="para">10</a>] </sup>
Except for some special cases such as <a class="link" href="algorithm/iteration/functions/for_each.html" title="for_each"><code class="computeroutput"><span class="identifier">for_each</span></code></a> and <a class="link" href="algorithm/auxiliary/functions/copy.html" title="copy"><code class="computeroutput"><span class="identifier">copy</span></code></a> which are inherently imperative
algorithms.
</p></div>
<div class="footnote"><p><sup>[<a name="ftn.id1025259" href="#id1025259" class="para">11</a>] </sup>
What does that mean? It means that when you operate on a sequence through
a Fusion algorithm that returns a sequence, the sequence returned may not
be of the same class as the original
</p></div>
Added docs for copy [SVN r72930]
2011-07-06 18:29:02 +00:00
</div>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
corrected reverse_view [SVN r58299]
2009-12-11 21:01:22 +00:00
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2007 Joel de Guzman, Dan Marsden, Tobias
added copyright and license info for each page. [SVN r40863]
2007-11-07 02:12:28 +00:00
Schwinger<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
refresh docs [SVN r41080]
2007-11-14 10:17:09 +00:00
</p>
</div></td>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
</tr></table>
<hr>
<div class="spirit-nav">
Added docs for copy [SVN r72929]
2011-07-06 18:16:56 +00:00
<a accesskey="p" href="adapted/define_assoc_tpl_struct.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm/auxiliary.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
Regenerating/reorganizing docs [SVN r40832]
2007-11-06 12:13:52 +00:00
</div>
</body>
</html>
Copy Permalink