• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2  <head>
3    <meta content="text/html; charset=windows-1252" http-equiv="content-type">
4    <title>BOOST_PP_TUPLE_POP_FRONT</title>
5    <link rel="stylesheet" type="text/css" href="../styles.css">
6  </head>
7  <body>
8    <div style="margin-left:  0px;"> The <b>BOOST_PP_TUPLE_POP_FRONT</b> macro
9      pops an element from the beginning of a <i>tuple</i>.</div>
10    <h4>Usage</h4>
11    <div class="code"> <b>BOOST_PP_TUPLE_POP_FRONT</b>(<i>tuple</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
12    <h4>Arguments</h4>
13    <dl>
14      <dt>tuple</dt>
15      <dd> The <i>tuple</i> to pop an element from.</dd>
16    </dl>
17    <h4>Remarks</h4>
18    <div> This macro returns <i>tuple</i> after removing the first
19      element.&nbsp; If <i>tuple</i> has only a single element, it remains
20      unchanged since a&nbsp;<i>tuple </i>must have at least one element.</div>
21    <div> This macro uses <b>BOOST_PP_REPEAT</b> internally.&nbsp; Therefore,
22      to use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>,
23      see <b>BOOST_PP_TUPLE_POP_FRONT_Z</b> </div>
24    <h4>See Also</h4>
25    <ul>
26      <li><a href="tuple_pop_front_z.html">BOOST_PP_TUPLE_POP_FRONT_Z</a></li>
27    </ul>
28    <h4>Requirements</h4>
29    <div> <b>Header:</b> &nbsp;<a href="../headers/tuple/pop_front.html">&lt;boost/preprocessor/tuple/pop_front.hpp&gt;</a>
30    </div>
31    <h4>Sample Code</h4>
32    <div>
33      <pre>#include &lt;<a href="../headers/tuple/pop_front.html">boost/preprocessor/tuple/pop_front.hpp</a>&gt;
34
35#define TUPLE (a, b, c)
36
37<a href="tuple_pop_front.html">BOOST_PP_TUPLE_POP_FRONT</a>(TUPLE) // expands to (b, c)
38</pre></div>
39    <hr size="1">
40    <div style="margin-left: 0px;"> <i>� Copyright Edward Diener 2013</i> </div>
41    <div style="margin-left: 0px;">
42      <p><small>Distributed under the Boost Software License, Version 1.0. (See
43          accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
44          or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
45    </div>
46  </body>
47</html>
48