libs/preprocessor/doc/ref/tuple_remove.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

<html>
  <head>
    <meta content="text/html; charset=windows-1252" http-equiv="content-type">
    <title>BOOST_PP_TUPLE_REMOVE</title>
    <link rel="stylesheet" type="text/css" href="../styles.css">
  </head>
  <body>
    <div style="margin-left:  0px;"> The <b>BOOST_PP_TUPLE_REMOVE</b> macro
      removes an element from a <i>tuple</i>.</div>
    <h4>Usage</h4>
    <div class="code"> <b>BOOST_PP_TUPLE_REMOVE</b>(<i>tuple</i>, <i>i</i>) <a
        href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
    <h4>Arguments</h4>
    <dl>
      <dt>tuple</dt>
      <dd> The <i>tuple</i> from which an element is to be removed.</dd>
      <dt>i</dt>
      <dd> The zero-based position in <i>tuple</i> of the element to be
        removed.&nbsp; Valid values range from <i>0</i> to <b>BOOST_PP_TUPLE_SIZE</b>(<i>tuple</i>)
        - <i>1</i>. If <i>tuple</i> has only a single element, it remains
        unchanged since a&nbsp;<i>tuple </i>must have at least one element.</dd>
    </dl>
    <h4>Remarks</h4>
    <div> This macro uses <b>BOOST_PP_WHILE</b> interally.&nbsp; Therefore, to
      use the <i>d</i> parameter passed from other macros that use <b>BOOST_PP_WHILE</b>,
      see <b>BOOST_PP_TUPLE_REMOVE_D</b>.</div>
    <h4>See Also</h4>
    <ul>
      <li><a href="tuple_remove_d.html">BOOST_PP_TUPLE_REMOVE_D</a></li>
    </ul>
    <h4>Requirements</h4>
    <div> <b>Header:</b> &nbsp;<a href="../headers/tuple/remove.html">&lt;boost/preprocessor/tuple/remove.hpp&gt;</a>
    </div>
    <h4>Sample Code</h4>
    <div>
      <pre>#include &lt;<a href="../headers/tuple/remove.html">boost/preprocessor/tuple/remove.hpp</a>&gt;

#define TUPLE (a, b, d)

<a href="tuple_remove.html">BOOST_PP_TUPLE_REMOVE</a>(TUPLE, 2) // expands to (a, b)
</pre></div>
    <hr size="1">
    <div style="margin-left: 0px;"> <i>© Copyright Edward Diener 2013</i> </div>
    <div style="margin-left: 0px;">
      <p><small>Distributed under the Boost Software License, Version 1.0. (See
          accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
          or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
    </div>
  </body>
</html>