Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/iter-fold.html @ 45

Last change on this file since 45 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 9.8 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: iter_fold</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./fold.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse-fold.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./fold.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse-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>
15<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="./iter-fold.html" class="navigation-link">iter_fold</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="iter-fold">
18<h1><a class="toc-backref" href="./iteration-algorithms.html#id398" name="iter-fold">iter_fold</a></h1>
19<div class="section" id="iter-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename Sequence
24    , typename State
25    , typename ForwardOp
26    &gt;
27struct <a href="./iter-fold.html" class="identifier">iter_fold</a>
28{
29    typedef <em>unspecified</em> type;
30};
31</pre>
32</div>
33<div class="section" id="iter-description">
34<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
35<p>Returns the result of the successive application of binary <tt class="literal"><span class="pre">ForwardOp</span></tt> to the result
36of the previous <tt class="literal"><span class="pre">ForwardOp</span></tt> invocation (<tt class="literal"><span class="pre">State</span></tt> if it's the first call) and each
37iterator 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 order.</p>
38</div>
39<div class="section" id="iter-header">
40<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
41<pre class="literal-block">
42#include &lt;<a href="../../../../boost/mpl/iter_fold.hpp" class="header">boost/mpl/iter_fold.hpp</a>&gt;
43</pre>
44</div>
45<div class="section" id="iter-parameters">
46<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
47<table border="1" class="table">
48<colgroup>
49<col width="15%" />
50<col width="32%" />
51<col width="53%" />
52</colgroup>
53<thead valign="bottom">
54<tr><th>Parameter</th>
55<th>Requirement</th>
56<th>Description</th>
57</tr>
58</thead>
59<tbody valign="top">
60<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
61<td><a class="reference" href="./forward-sequence.html">Forward Sequence</a></td>
62<td>A sequence to iterate.</td>
63</tr>
64<tr><td><tt class="literal"><span class="pre">State</span></tt></td>
65<td>Any type</td>
66<td>The initial state for the first <tt class="literal"><span class="pre">ForwardOp</span></tt>
67application.</td>
68</tr>
69<tr><td><tt class="literal"><span class="pre">ForwardOp</span></tt></td>
70<td>Binary <a class="reference" href="./lambda-expression.html">Lambda Expression</a></td>
71<td>The operation to be executed on forward
72traversal.</td>
73</tr>
74</tbody>
75</table>
76</div>
77<div class="section" id="iter-expression-semantics">
78<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
79<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">op</span></tt>, and an
80arbitrary type <tt class="literal"><span class="pre">state</span></tt>:</p>
81<pre class="literal-block">
82typedef <a href="./iter-fold.html" class="identifier">iter_fold</a>&lt;s,state,op&gt;::type t;
83</pre>
84<table class="field-list" frame="void" rules="none">
85<col class="field-name" />
86<col class="field-body" />
87<tbody valign="top">
88<tr class="field"><th class="field-name">Return type:</th><td class="field-body">A type.</td>
89</tr>
90<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p>
91<pre class="literal-block">
92typedef <a href="./begin.html" class="identifier">begin</a>&lt;Sequence&gt;::type i<sub>1</sub>;
93typedef <a href="./apply.html" class="identifier">apply</a>&lt;op,state,i<sub>1</sub>&gt;::type state<sub>1</sub>;
94typedef <a href="./next.html" class="identifier">next</a>&lt;i<sub>1</sub>&gt;::type i<sub>2</sub>;
95typedef <a href="./apply.html" class="identifier">apply</a>&lt;op,state<sub>1</sub>,i<sub>2</sub>&gt;::type state<sub>2</sub>;
96<em>...</em>
97typedef <a href="./apply.html" class="identifier">apply</a>&lt;op,state<sub>n-1</sub>,i<sub>n</sub>&gt;::type state<sub>n</sub>;
98typedef <a href="./next.html" class="identifier">next</a>&lt;i<sub>n</sub>&gt;::type last;
99typedef state<sub>n</sub> t;
100</pre>
101<p class="last">where <tt class="literal"><span class="pre">n</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span></tt> and <tt class="literal"><span class="pre">last</span></tt> is identical to <tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt>; equivalent
102to <tt class="literal"><span class="pre">typedef</span> <span class="pre">state</span> <span class="pre">t;</span></tt> if <tt class="literal"><span class="pre"><a href="./empty.html" class="identifier">empty</a>&lt;s&gt;::value</span> <span class="pre">==</span> <span class="pre">true</span></tt>.</p>
103</td>
104</tr>
105</tbody>
106</table>
107</div>
108<div class="section" id="iter-complexity">
109<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
110<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">op</span></tt>.</p>
111</div>
112<div class="section" id="iter-example">
113<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
114<pre class="literal-block">
115typedef <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,5,-1,0,7,2,0,-5,4&gt; numbers;
116typedef <a href="./iter-fold.html" class="identifier">iter_fold</a>&lt;
117      numbers
118    , <a href="./begin.html" class="identifier">begin</a>&lt;numbers&gt;::type
119    , <a href="./if.html" class="identifier">if_</a>&lt; <a href="./less.html" class="identifier">less</a>&lt; <a href="./deref.html" class="identifier">deref</a>&lt;_1&gt;, <a href="./deref.html" class="identifier">deref</a>&lt;_2&gt; &gt;,_2,_1 &gt;
120    &gt;::type max_element_iter;
121
122<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./deref.html" class="identifier">deref</a>&lt;max_element_iter&gt;::type::value, ==, 7 );
123</pre>
124</div>
125<div class="section" id="iter-see-also">
126<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
127<p><a class="reference" href="./algorithms.html">Algorithms</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="./fold.html"><tt class="refentry literal"><span class="pre">fold</span></tt></a>, <a class="refentry reference" href="./reverse-fold.html"><tt class="refentry literal"><span class="pre">reverse_fold</span></tt></a>, <a class="refentry reference" href="./copy.html"><tt class="refentry literal"><span class="pre">copy</span></tt></a></p>
128<!-- modtime: November 10, 2004 04:39:19 +0000 -->
129<!-- Algorithms/Iteration Algorithms//reverse_fold -->
130</div>
131</div>
132
133<div class="footer-separator"></div>
134<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./fold.html" class="navigation-link">Prev</a>&nbsp;<a href="./reverse-fold.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./fold.html" class="navigation-link">Back</a>&nbsp;<a href="./reverse-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>
135</tr></table></body>
136</html>
Note: See TracBrowser for help on using the repository browser.