mirror of
https://github.com/boostorg/preprocessor.git
synced 2025-07-29 19:57:14 +02:00
set -> seq
[SVN r16152]
This commit is contained in:
81
doc/ref/seq_fold_right.html
Normal file
81
doc/ref/seq_fold_right.html
Normal file
@ -0,0 +1,81 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_SEQ_FOLD_RIGHT</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_SEQ_FOLD_RIGHT</b> macro folds (or accumulates) the elements of
|
||||
a <i>seq</i> right-to-left.
|
||||
</div>
|
||||
<h4>
|
||||
Usage
|
||||
</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_SEQ_FOLD_RIGHT</b>(<i>op</i>, <i>state</i>, <i>seq</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>seq</i>--each time returning a new <i>state</i>.
|
||||
This operation is expanded by <b>BOOST_PP_SEQ_FOLD_RIGHT</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>2</i>),
|
||||
<i>1</i>), <i>0</i>)
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
For maximum efficiency, <b>BOOST_PP_SEQ_FOLD_RIGHT</b> can be reentered with <b>BOOST_PP_SEQ_FOLD_RIGHT_<i>s</i></b>.
|
||||
</div>
|
||||
<h4>
|
||||
See Also
|
||||
</h4>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="seq_fold_right_s.html">BOOST_PP_SEQ_FOLD_RIGHT_<i>s</i></a></li>
|
||||
</ul>
|
||||
<h4>
|
||||
Requirements
|
||||
</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/seq/fold_right.hpp.html"><boost/preprocessor/seq/fold_right.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/seq/elem.hpp.html">boost/preprocessor/seq/elem.hpp</a>>
|
||||
#include <<a href="../headers/seq/fold_right.hpp.html">boost/preprocessor/seq/fold_right.hpp</a>>
|
||||
#include <<a href="../headers/seq/pop_back.hpp.html">boost/preprocessor/seq/pop_back.hpp</a>>
|
||||
|
||||
#define SEQ (t)(s)(o)(o)(b)
|
||||
|
||||
#define OP(s, state, x) <a href="cat.html">BOOST_PP_CAT</a>(state, x)
|
||||
|
||||
<a href="seq_fold_right.html">BOOST_PP_SEQ_FOLD_RIGHT</a>(OP, <a href="seq_elem.html">BOOST_PP_SEQ_ELEM</a>(4, SEQ), <a href="seq_pop_back.html">BOOST_PP_SEQ_POP_BACK</a>(SEQ)) // expands to boost
|
||||
</pre>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user