1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
<html>
<head>
<title>BOOST_PP_SEQ_FOLD_LEFT_s</title>
<link rel="stylesheet" type="text/css" href="../styles.css">
</head>
<body>
<div style="margin-left: 0px;">
The <b>BOOST_PP_SEQ_FOLD_LEFT_<i>s</i></b> macro folds (or accumulates) the
elements of a <i>seq</i> left-to-right. It reenters <b>BOOST_PP_SEQ_FOLD_LEFT</b>
with maximum efficiency.
</div>
<h4>
Usage
</h4>
<div class="code">
<b>BOOST_PP_SEQ_FOLD_LEFT_</b> ## <i>s</i>(<i>op</i>, <i>state</i>, <i>seq</i>)
</div>
<h4>
Arguments
</h4>
<dl>
<dt>s</dt>
<dd>
The next available <b>BOOST_PP_SEQ_FOLD_LEFT</b> fold step.
</dd>
<dt>op</dt>
<dd>
A ternary operation of the form <i>op</i>(<i>s</i>, <i>state</i>, <i>elem</i>).
This macro is called for each element in <i>seq</i>--each time returning a new <i>state</i>.
This operation is expanded by <b>BOOST_PP_SEQ_FOLD_LEFT</b> with the next
available fold step, the current <i>state</i>, and the current element.
</dd>
<dt>state</dt>
<dd>
The initial state of the fold.
</dd>
<dt>seq</dt>
<dd>
The <i>seq</i> to be folded.
</dd>
</dl>
<h4>
Remarks
</h4>
<div>
For the <i>seq</i>, (<i>0</i>)(<i>1</i>)(<i>2</i>), this macro expands to:
<div>
<i>op</i>(<i>s</i>, <i>op</i>(<i>s</i>, <i>op</i>(<i>s</i>, <i>state</i>, <i>0</i>),
<i>1</i>), <i>2</i>)
</div>
</div>
<h4>
See Also
</h4>
<ul>
<li>
<a href="seq_fold_left.html">BOOST_PP_SEQ_FOLD_LEFT</a></li>
</ul>
<h4>
Requirements
</h4>
<div>
<b>Header:</b> <a href="../headers/seq/fold_left.html"><boost/preprocessor/seq/fold_left.hpp></a>
</div>
<h4>
Sample Code
</h4>
<div>
<pre>
#include <<a href="../headers/cat.html">boost/preprocessor/cat.hpp</a>>
#include <<a href="../headers/seq/fold_left.html">boost/preprocessor/seq/fold_left.hpp</a>>
#include <<a href="../headers/seq/seq.html">boost/preprocessor/seq/seq.hpp</a>>
#define S1 (a)(b)(c)
#define S2 (S1)(S1)(S1)
#define OP(s, state, x) state (<a href="seq_fold_left_s.html">BOOST_PP_SEQ_FOLD_LEFT_</a> ## s(OP_2, _, x))
#define OP_2(s, state, x) <a href="cat.html">BOOST_PP_CAT</a>(state, x)
<a href="seq_fold_left.html">BOOST_PP_SEQ_FOLD_LEFT</a>(OP, <a href="seq_nil.html">BOOST_PP_SEQ_NIL</a>, S2)
// expands to (_abc)(_abc)(_abc)
</pre>
</div>
<hr size="1">
<div style="margin-left: 0px;">
<i> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
</br><i> Copyright Paul Mensonides 2002</i>
</div>
<div style="margin-left: 0px;">
<p><small>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</div>
</body>
</html>
|