boost_mpl/doc/refmanual/reverse-fold.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
<title>The MPL Reference Manual: reverse_fold</title>
<link rel="stylesheet" href="../style.css" type="text/css" />
</head>
<body class="docframe refmanual">
<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./iter-fold.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse-iter-fold.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iter-fold.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse-iter-fold.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iteration-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./algorithms.html" class="navigation-link">Algorithms</a> / <a href="./iteration-algorithms.html" class="navigation-link">Iteration Algorithms</a> / <a href="./reverse-fold.html" class="navigation-link">reverse_fold</a></td>
</tr></table><div class="header-separator"></div>
<div class="section" id="reverse-fold">
<h1><a class="toc-backref" href="./iteration-algorithms.html#id399" name="reverse-fold">reverse_fold</a></h1>
<div class="section" id="reverse-synopsis">
<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
<pre class="literal-block">
template&lt;
      typename Sequence
    , typename State
    , typename BackwardOp
    , typename ForwardOp = _1
    &gt;
struct <a href="./reverse-fold.html" class="identifier">reverse_fold</a>
{
    typedef <em>unspecified</em> type;
};
</pre>
</div>
<div class="section" id="reverse-description">
<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
<p>Returns the result of the successive application of binary <tt class="literal"><span class="pre">BackwardOp</span></tt> to the 
result of the previous <tt class="literal"><span class="pre">BackwardOp</span></tt> invocation (<tt class="literal"><span class="pre">State</span></tt> if it's the first call) 
and every element in the range [<tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;Sequence&gt;::type</span></tt>, <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;Sequence&gt;::type</span></tt>) in 
reverse order. If <tt class="literal"><span class="pre">ForwardOp</span></tt> is provided, then it is applied on forward 
traversal to form the result that is passed to the first <tt class="literal"><span class="pre">BackwardOp</span></tt> call.</p>
</div>
<div class="section" id="reverse-header">
<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
<pre class="literal-block">
#include &lt;<a href="../../../../boost/mpl/reverse_fold.hpp" class="header">boost/mpl/reverse_fold.hpp</a>&gt;
</pre>
</div>
<div class="section" id="reverse-parameters">
<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
</div>
<div class="section" id="iteration-reverse-parameters">
<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
<table border="1" class="table">
<colgroup>
<col width="16%" />
<col width="33%" />
<col width="51%" />
</colgroup>
<thead valign="bottom">
<tr><th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
<td><a class="reference" href="./forward-sequence.html">Forward Sequence</a></td>
<td>A sequence to iterate.</td>
</tr>
<tr><td><tt class="literal"><span class="pre">State</span></tt></td>
<td>Any type</td>
<td>The initial state for the first <tt class="literal"><span class="pre">BackwardOp</span></tt>
/ <tt class="literal"><span class="pre">ForwardOp</span></tt> application.</td>
</tr>
<tr><td><tt class="literal"><span class="pre">BackwardOp</span></tt></td>
<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
<td>The operation to be executed on backward
traversal.</td>
</tr>
<tr><td><tt class="literal"><span class="pre">ForwardOp</span></tt></td>
<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
<td>The operation to be executed on forward
traversal.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="reverse-expression-semantics">
<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
<p>For any <a class="reference" href="./forward-sequence.html">Forward Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a> <tt class="literal"><span class="pre">backward_op</span></tt> and <tt class="literal"><span class="pre">forward_op</span></tt>, 
and arbitrary type <tt class="literal"><span class="pre">state</span></tt>:</p>
<pre class="literal-block">
typedef <a href="./reverse-fold.html" class="identifier">reverse_fold</a>&lt; s,state,backward_op &gt;::type t; 
</pre>
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">A type</td>
</tr>
<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
<pre class="last literal-block">
typedef <a href="./reverse-iter-fold.html" class="identifier">reverse_iter_fold</a>&lt; 
      s
    , state
    , <a href="./apply.html" class="identifier">apply</a>&lt;backward_op,_1,<a href="./deref.html" class="identifier">deref</a>&lt;_2&gt; &gt;
    &gt;::type t; 
</pre>
</td>
</tr>
</tbody>
</table>
<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<pre class="literal-block">
typedef <a href="./reverse-fold.html" class="identifier">reverse_fold</a>&lt; s,state,backward_op,forward_op &gt;::type t; 
</pre>
<table class="field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">A type.</td>
</tr>
<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
<pre class="last literal-block">
typedef <a href="./reverse-fold.html" class="identifier">reverse_fold</a>&lt;
      Sequence
    , <a href="./fold.html" class="identifier">fold</a>&lt;s,state,forward_op&gt;::type
    , backward_op
    &gt;::type t;        
</pre>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="reverse-complexity">
<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
<p>Linear. Exactly <tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span></tt> applications of <tt class="literal"><span class="pre">backward_op</span></tt> and <tt class="literal"><span class="pre">forward_op</span></tt>.</p>
</div>
<div class="section" id="reverse-example">
<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
<p>Remove negative elements from a sequence <a class="footnote-reference" href="#reverse-fold-note" id="id93" name="id93">[2]</a>.</p>
<pre class="literal-block">
typedef <a href="./list-c.html" class="identifier">list_c</a>&lt;int,5,-1,0,-7,-2,0,-5,4&gt; numbers;
typedef <a href="./list-c.html" class="identifier">list_c</a>&lt;int,-1,-7,-2,-5&gt; negatives;
typedef <a href="./reverse-fold.html" class="identifier">reverse_fold</a>&lt;
      numbers
    , <a href="./list-c.html" class="identifier">list_c</a>&lt;int&gt;
    , <a href="./if.html" class="identifier">if_</a>&lt; <a href="./less.html" class="identifier">less</a>&lt; _2,<a href="./int.html" class="identifier">int_</a>&lt;0&gt; &gt;, <a href="./push-front.html" class="identifier">push_front</a>&lt;_1,_2,&gt;, _1 &gt;
    &gt;::type result;

<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./equal.html" class="identifier">equal</a>&lt; negatives,result > ));
</pre>
<table class="footnote" frame="void" id="reverse-fold-note" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id93" name="reverse-fold-note">[2]</a></td><td>See <tt class="literal"><span class="pre"><a href="./remove-if.html" class="identifier">remove_if</a></span></tt> for a more compact way to do this.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="reverse-see-also">
<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
<p><a class="reference" href="./algorithms.html">Algorithms</a>, <a class="refentry reference" href="./fold.html"><tt class="refentry literal"><span class="pre">fold</span></tt></a>, <a class="refentry reference" href="./reverse-iter-fold.html"><tt class="refentry literal"><span class="pre">reverse_iter_fold</span></tt></a>, <a class="refentry reference" href="./iter-fold.html"><tt class="refentry literal"><span class="pre">iter_fold</span></tt></a></p>
<!-- modtime: November 13, 2004 18:32:22 +0000 -->
<!-- Algorithms/Iteration Algorithms//reverse_iter_fold -->
</div>
</div>

<div class="footer-separator"></div>
<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./iter-fold.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse-iter-fold.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iter-fold.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse-iter-fold.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iteration-algorithms.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
</tr></table></body>
</html>