feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

Copy generated fusion documentation from trunk.

Browse Source 
[SVN r59021]
This commit is contained in:
Daniel James
2010-01-15 06:35:28 +00:00
parent cda74605fc
commit 3f4d3eb887
263 changed files with 13560 additions and 37050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

287
doc/html/fusion/algorithm/iteration/functions/accumulate.html
View File

@ -3,18 +3,10 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>accumulate</title>
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
<<<<<<< .working
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
=======
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<<<<<<< .working
>>>>>>> .merge-right.r57125
<link rel="home" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
=======
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
>>>>>>> .merge-right.r58299
<link rel="up" href="../functions.html" title="Functions">
<link rel="previous" href="fold.html" title="fold">
<link rel="prev" href="fold.html" title="fold">
<link rel="next" href="for_each.html" title="for_each">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -30,50 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="fold.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="for_each.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage">
<div><div><h5 class="title">
<a name="fusion.algorithm.iteration.functions.accumulate"></a><a href="accumulate.html" title="accumulate">accumulate</a>
</h5></div></div>
<div></div>
</div>
<div class="section" title="accumulate">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.algorithm.iteration.functions.accumulate"></a><a class="link" href="accumulate.html" title="accumulate">accumulate</a>
</h5></div></div></div>
<a name="fusion.algorithm.iteration.functions.accumulate.description"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id537581"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.description">Description</a>
=======
<a name="id789366"></a>
=======
<a name="id751900"></a>
=======
<a name="id744276"></a>
=======
<a name="id767092"></a>
=======
<a name="id755686"></a>
=======
<a name="id752410"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id745856"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.description">Description</a>
>>>>>>> .merge-right.r57125
</h6>
<p>
<<<<<<< .working
For a sequence <tt class="computeroutput"><span class="identifier">Seq</span></tt>, initial
state, and binary function object or function pointer <tt class="computeroutput"><span class="identifier">f</span></tt>,
accumulate repeatedly applies binary <tt class="computeroutput"><span class="identifier">f</span></tt>
to each element of <tt class="computeroutput"><span class="identifier">Seq</span></tt>
and the previous state.
=======
For a sequence <code class="computeroutput"><span class="identifier">seq</span></code>, initial
state <code class="computeroutput"><span class="identifier">initial_state</span></code>,
and binary function object or function pointer <code class="computeroutput"><span class="identifier">f</span></code>,
@ -82,105 +39,46 @@
previous <code class="computeroutput"><span class="identifier">f</span></code> invocation
(<code class="computeroutput"><span class="identifier">inital_state</span></code> if it is
the first call) and each element of <code class="computeroutput"><span class="identifier">seq</span></code>.
>>>>>>> .merge-right.r57125
</p>
<a name="fusion.algorithm.iteration.functions.accumulate.synopsis"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id537658"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.synopsis">Synopsis</a>
=======
<a name="id789441"></a>
=======
<a name="id751975"></a>
=======
<a name="id744350"></a>
=======
<a name="id767166"></a>
=======
<a name="id755761"></a>
=======
<a name="id752484"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id745930"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.synopsis">Synopsis</a>
>>>>>>> .merge-right.r57125
</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">,</span>
<span class="keyword">typename</span> <span class="identifier">State</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">F</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/accumulate.html" title="accumulate"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">accumulate</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">F</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">accumulate</span><span class="special">(</span>
<span class="keyword">typename</span> <a class="link" href="../metafunctions/accumulate.html" title="accumulate"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">accumulate</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">F</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">accumulate</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="identifier">State</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">initial_state</span><span class="special">,</span> <span class="identifier">F</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">f</span><span class="special">);</span>
</pre>
<div class="table">
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id537917"></a><p class="title"><b>Table<EFBFBD>1.34.<2E>Parameters</b></p>
<table class="table" summary="Parameters">
=======
<a name="id789627"></a><p class="title"><b>Table<EFBFBD>1.34.<2E>Parameters</b></p>
=======
<a name="id752184"></a><p class="title"><b>Table<EFBFBD>1.38.<2E>Parameters</b></p>
=======
<a name="id744560"></a><p class="title"><b>Table<EFBFBD>1.38.<2E>Parameters</b></p>
=======
<a name="id767352"></a><p class="title"><b>Table&#160;1.38.&#160;Parameters</b></p>
=======
<a name="id755947"></a><p class="title"><b>Table&#160;1.38.&#160;Parameters</b></p>
=======
<a name="id752670"></a><p class="title"><b>Table&#160;1.38.&#160;Parameters</b></p>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id746116"></a><p class="title"><b>Table&#160;1.38.&#160;Parameters</b></p>
<div class="table-contents"><table class="table" summary="Parameters">
>>>>>>> .merge-right.r57125
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th><p>
<th>
<p>
Parameter
</p></th>
<th><p>
</p>
</th>
<th>
<p>
Requirement
</p></th>
<th><p>
</p>
</th>
<th>
<p>
Description
</p></th>
</p>
</th>
</tr></thead>
<tbody>
<tr>
<<<<<<< .working
<td><p>
<tt class="computeroutput"><span class="identifier">seq</span></tt>
</p></td>
<td><p>
A model of <a href="../../../sequence/concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">eN</span>
<span class="special">....</span><span class="identifier">f</span><span class="special">(</span><span class="identifier">e2</span><span class="special">,</span><span class="identifier">f</span><span class="special">(</span><span class="identifier">e1</span><span class="special">,</span><span class="identifier">initial_state</span><span class="special">)))</span></tt> must be a valid expression for
each element <tt class="computeroutput"><span class="identifier">e1</span></tt>
to <tt class="computeroutput"><span class="identifier">eN</span></tt> in <tt class="computeroutput"><span class="identifier">seq</span></tt>
</p></td>
<td><p>
=======
<td>
<p>
<code class="computeroutput"><span class="identifier">seq</span></code>
@ -197,33 +95,28 @@
</td>
<td>
<p>
>>>>>>> .merge-right.r57125
Operation's argument
</p></td>
</p>
</td>
</tr>
<tr>
<td><p>
<tt class="computeroutput"><span class="identifier">initial_state</span></tt>
</p></td>
<td><p>
<td>
<p>
<code class="computeroutput"><span class="identifier">initial_state</span></code>
</p>
</td>
<td>
<p>
Any type
</p></td>
<td><p>
</p>
</td>
<td>
<p>
Initial state
</p></td>
</p>
</td>
</tr>
<tr>
<<<<<<< .working
<td><p>
<tt class="computeroutput"><span class="identifier">f</span></tt>
</p></td>
<td><p>
<tt class="computeroutput"><a href="http://www.boost.org/libs/utility/utility.htm#result_of" target="_top"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">result_of</span></tt></a><span class="special">&lt;</span><span class="identifier">F</span><span class="special">(</span><span class="identifier">E</span><span class="special">,</span><span class="identifier">S</span><span class="special">)&gt;::</span><span class="identifier">type</span></tt> is the return type of <tt class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">e</span><span class="special">,</span><span class="identifier">s</span><span class="special">)</span></tt>
for each element <tt class="computeroutput"><span class="identifier">e</span></tt>
of type <tt class="computeroutput"><span class="identifier">E</span></tt> in <tt class="computeroutput"><span class="identifier">seq</span></tt>, and current state <tt class="computeroutput"><span class="identifier">s</span></tt> of type <tt class="computeroutput"><span class="identifier">S</span></tt>
</p></td>
<td><p>
=======
<td>
<p>
<code class="computeroutput"><span class="identifier">f</span></code>
@ -240,131 +133,45 @@
</td>
<td>
<p>
>>>>>>> .merge-right.r57125
Operation's argument
</p></td>
</p>
</td>
</tr>
</tbody>
</table>
</table></div>
</div>
<<<<<<< .working
<a name="fusion.algorithm.iteration.functions.accumulate.expression_semantics"></a><h6>
<a name="id538367"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.expression_semantics">Expression
=======
<br class="table-break"><a name="fusion.algorithm.iteration.functions.accumulate.expression_semantics"></a><h6>
<a name="id752970"></a>
<a name="id746416"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.expression_semantics">Expression
>>>>>>> .merge-right.r57125
Semantics</a>
</h6>
<pre class="programlisting"><span class="identifier">accumulate</span><span class="special">(</span><span class="identifier">seq</span><span class="special">,</span> <span class="identifier">initial_state</span><span class="special">,</span> <span class="identifier">f</span><span class="special">);</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>
<<<<<<< .working
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">eN</span> <span class="special">....</span><span class="identifier">f</span><span class="special">(</span><span class="identifier">e2</span><span class="special">,</span><span class="identifier">f</span><span class="special">(</span><span class="identifier">e1</span><span class="special">,</span><span class="identifier">initial_state</span><span class="special">)))</span></tt>
where <tt class="computeroutput"><span class="identifier">e1</span> <span class="special">...</span><span class="identifier">eN</span></tt> are the elements of <tt class="computeroutput"><span class="identifier">seq</span></tt>.
=======
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><span class="identifier">f</span><span class="special">(...</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">f</span><span class="special">(</span><span class="identifier">initial_state</span><span class="special">,</span><span class="identifier">e1</span><span class="special">),</span><span class="identifier">e2</span><span class="special">)</span> <span class="special">...</span><span class="identifier">eN</span><span class="special">)</span></code> where <code class="computeroutput"><span class="identifier">e1</span>
<span class="special">...</span><span class="identifier">eN</span></code>
are the elements of <code class="computeroutput"><span class="identifier">seq</span></code>.
>>>>>>> .merge-right.r57125
</p>
<a name="fusion.algorithm.iteration.functions.accumulate.complexity"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id538575"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.complexity">Complexity</a>
=======
<a name="id790624"></a>
=======
<a name="id752635"></a>
=======
<a name="id745011"></a>
=======
<a name="id767803"></a>
=======
<a name="id756398"></a>
=======
<a name="id753121"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id746568"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.complexity">Complexity</a>
>>>>>>> .merge-right.r57125
</h6>
<p>
Linear, exactly <tt class="computeroutput"><a href="../../../sequence/intrinsic/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">value</span></tt> applications of <tt class="computeroutput"><span class="identifier">f</span></tt>.
Linear, exactly <code class="computeroutput"><a class="link" href="../../../sequence/intrinsic/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">value</span></code> applications of <code class="computeroutput"><span class="identifier">f</span></code>.
</p>
<a name="fusion.algorithm.iteration.functions.accumulate.header"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id538669"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.header">Header</a>
=======
<a name="id790684"></a>
=======
<a name="id752695"></a>
=======
<a name="id745071"></a>
=======
<a name="id767863"></a>
=======
<a name="id756458"></a>
=======
<a name="id753181"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id746628"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.header">Header</a>
>>>>>>> .merge-right.r57125
</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">algorithm</span><span class="special">/</span><span class="identifier">iteration</span><span class="special">/</span><span class="identifier">accumulate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<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">accumulate</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.algorithm.iteration.functions.accumulate.example"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<a name="id538836"></a>
<a href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.example">Example</a>
=======
<a name="id790800"></a>
=======
<a name="id752811"></a>
=======
<a name="id745186"></a>
=======
<a name="id767978"></a>
=======
<a name="id756573"></a>
=======
<a name="id753296"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a name="id746743"></a>
<a class="link" href="accumulate.html#fusion.algorithm.iteration.functions.accumulate.example">Example</a>
>>>>>>> .merge-right.r57125
</h6>
<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">make_string</span>
<span class="special">{</span>
@ -377,8 +184,8 @@
<span class="special">}</span>
<span class="special">};</span>
<span class="special">...</span>
<span class="keyword">const</span> <a href="../../../container/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">&gt;</span> <span class="identifier">vec</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="identifier">assert</span><span class="special">(</span><a href="accumulate.html" title="accumulate"><tt class="computeroutput"><span class="identifier">accumulate</span></tt></a><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="string">""</span><span class="special">),</span> <span class="identifier">make_string</span><span class="special">())</span> <span class="special">==</span> <span class="string">"12"</span><span class="special">);</span>
<span class="keyword">const</span> <a class="link" href="../../../container/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">&gt;</span> <span class="identifier">vec</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="identifier">assert</span><span class="special">(</span><a class="link" href="accumulate.html" title="accumulate"><code class="computeroutput"><span class="identifier">accumulate</span></code></a><span class="special">(</span><span class="identifier">vec</span><span class="special">,</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="string">""</span><span class="special">),</span> <span class="identifier">make_string</span><span class="special">())</span> <span class="special">==</span> <span class="string">"12"</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>