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

   1 <html>
   2         <head>
   3                 <title>BOOST_PP_SEQ_PUSH_FRONT</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_SEQ_PUSH_FRONT</b> macro pushes an element onto the beginning
   9                         of a <i>seq</i>.
  10                 </div>
  11                 <h4>
  12                         Usage
  13                 </h4>
  14                 <div class="code">
  15                         <b>BOOST_PP_SEQ_PUSH_FRONT</b>(<i>seq</i>, <i>elem</i>)
  16                 </div>
  17                 <h4>
  18                         Arguments
  19                 </h4>
  20                 <dl>
  21                         <dt>seq</dt>
  22                         <dd>
  23                                 The <i>seq</i> onto which <i>elem</i> is pushed.
  24                         </dd>
  25                         <dt>elem</dt>
  26                         <dd>
  27                                 The element to push onto the beginning of <i>seq</i>.
  28                         </dd>
  29                 </dl>
  30                 <h4>
  31                         Remarks
  32                 </h4>
  33                 <div>
  34                         This macro returns <i>seq</i> after prepending <i>elem</i>.&nbsp;
  35                 </div>
  36                 <div>
  37                         This macro is an explicit form of directly prepending an element.&nbsp; In
  38                         other words, <b>BOOST_PP_SEQ_PUSH_FRONT</b>(<i>seq</i>, <i>x</i>) is equivalent
  39                         to (<i>x</i>)<i>seq</i>.
  40                 </div>
  41                 <h4>
  42                         See Also
  43                 </h4>
  44                 <ul>
  45                         <li>
  46                                 <a href="seq_push_back.html">BOOST_PP_SEQ_PUSH_BACK</a></li>
  47                 </ul>
  48                 <h4>
  49                         Requirements
  50                 </h4>
  51                 <div>
  52                         <b>Header:</b> &nbsp;<a href="../headers/seq/push_front.html">&lt;boost/preprocessor/seq/push_front.hpp&gt;</a>
  53                 </div>
  54                 <h4>
  55                         Sample Code
  56                 </h4>
  57                 <div>
  58                         <pre>
  59 #include &lt;<a href="../headers/seq/push_front.html">boost/preprocessor/seq/push_front.hpp</a>&gt;
  60
  61 #define SEQ (b)(c)
  62
  63 <a href="seq_push_front.html">BOOST_PP_SEQ_PUSH_FRONT</a>(SEQ, a) // expands to (a)(b)(c)
  64 </pre>
  65                 </div>
  66         <hr size="1">
  67         <div style="margin-left: 0px;">
  68                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  69                 </br><i>© Copyright Paul Mensonides 2002</i>
  70         </div>
  71         <div style="margin-left: 0px;">
  72                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  73                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  74                 copy at <a href=
  75                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  76         </div>
  77         </body>
  78 </html>