Boost_1_39_0/libs/preprocessor/doc/ref/seq_remove.html

   1 <html>
   2         <head>
   3                 <title>BOOST_PP_SEQ_REMOVE</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_REMOVE</b> macro removes an element from a <i>seq</i>.
   9                 </div>
  10                 <h4>
  11                         Usage
  12                 </h4>
  13                 <div class="code">
  14                         <b>BOOST_PP_SEQ_REMOVE</b>(<i>seq</i>, <i>i</i>)
  15                 </div>
  16                 <h4>
  17                         Arguments
  18                 </h4>
  19                 <dl>
  20                         <dt>seq</dt>
  21                         <dd>
  22                                 The <i>seq</i> from which an element is to be removed.
  23                         </dd>
  24                         <dt>i</dt>
  25                         <dd>
  26                                 The zero-based position in <i>seq</i> of the element to be removed.&nbsp; Valid
  27                                 values range from <i>0</i> to <b>BOOST_PP_SEQ_SIZE</b>(<i>seq</i>) - <i>1</i>.
  28                         </dd>
  29                 </dl>
  30                 <h4>
  31                         Remarks
  32                 </h4>
  33                 <div>
  34                         This macro returns <i>seq</i> after removing the element at index <i>i</i>.
  35                 </div>
  36                 <h4>
  37                         Requirements
  38                 </h4>
  39                 <div>
  40                         <b>Header:</b> &nbsp;<a href="../headers/seq/remove.html">&lt;boost/preprocessor/seq/remove.hpp&gt;</a>
  41                 </div>
  42                 <h4>
  43                         Sample Code
  44                 </h4>
  45                 <div>
  46                         <pre>
  47 #include &lt;<a href="../headers/seq/remove.html">boost/preprocessor/seq/remove.hpp</a>&gt;
  48
  49 #define SEQ (a)(b)(x)(c)
  50
  51 <a href="seq_remove.html">BOOST_PP_SEQ_REMOVE</a>(SEQ, 2) // expands to (a)(b)(c)
  52 </pre>
  53                 </div>
  54         <hr size="1">
  55         <div style="margin-left: 0px;">
  56                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  57                 </br><i>© Copyright Paul Mensonides 2002</i>
  58         </div>
  59         <div style="margin-left: 0px;">
  60                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  61                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  62                 copy at <a href=
  63                 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  64         </div>
  65         </body>
  66 </html>