forked from boostorg/preprocessor
63 lines
2.1 KiB
HTML
63 lines
2.1 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>BOOST_PP_SET_FOLD_LEFT</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div style="margin-left: 0px;">
|
||
|
|
The <b>BOOST_PP_SET_FOLD_LEFT</b> macro folds (or accumulates) the elements of a <i>set</i> left-to-right.
|
||
|
|
</div>
|
||
|
|
<h4>Usage</h4>
|
||
|
|
<div class="code">
|
||
|
|
<b>BOOST_PP_SET_FOLD_LEFT</b>(<i>op</i>, <i>state</i>, <i>set</i>)
|
||
|
|
</div>
|
||
|
|
<h4>Arguments</h4>
|
||
|
|
<dl>
|
||
|
|
<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>set</i>--each time returning a new <i>state</i>.
|
||
|
|
This operation is expanded by <b>BOOST_PP_SET_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>set</dt>
|
||
|
|
<dd>
|
||
|
|
The <i>set</i> to be folded.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<h4>Remarks</h4>
|
||
|
|
<div>
|
||
|
|
For the <i>set</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>
|
||
|
|
<div>
|
||
|
|
For maximum efficiency, <b>BOOST_PP_SET_FOLD_LEFT</b> can be reentered with <b>BOOST_PP_SET_FOLD_LEFT_<i>s</i></b>.
|
||
|
|
</div>
|
||
|
|
<h4>See Also</h4>
|
||
|
|
<ul>
|
||
|
|
<li><a href="set_fold_left_s.html">BOOST_PP_SET_FOLD_LEFT_<i>s</i></a></li>
|
||
|
|
</ul>
|
||
|
|
<h4>Requirements</h4>
|
||
|
|
<div>
|
||
|
|
<b>Header:</b> <a href="../headers/set/fold_left.hpp.html"><boost/preprocessor/set/fold_left.hpp></a>
|
||
|
|
</div>
|
||
|
|
<h4>Sample Code</h4>
|
||
|
|
<div><pre>
|
||
|
|
#include <<a href="../headers/cat.hpp.html">boost/preprocessor/cat.hpp</a>>
|
||
|
|
#include <<a href="../headers/set/fold_left.hpp.html">boost/preprocessor/set/fold_left.hpp</a>>
|
||
|
|
|
||
|
|
#define SET (b)(o)(o)(s)(t)
|
||
|
|
|
||
|
|
#define OP(s, state, x) <a href="cat.html">BOOST_PP_CAT</a>(state, x)
|
||
|
|
|
||
|
|
<a href="set_fold_left.html">BOOST_PP_SET_FOLD_LEFT</a>(OP, <a href="set_head.html">BOOST_PP_SET_HEAD</a>(SET), <a href="set_tail.html">BOOST_PP_SET_TAIL</a>(SET)) // expands to boost
|
||
|
|
</pre></div>
|
||
|
|
</body>
|
||
|
|
</html>
|