ceph/src/boost/libs/preprocessor/doc/ref/list_fold_left_d.html

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