2002-10-03 22:13:37 +00:00
< html >
2011-06-26 13:07:20 +00:00
< head >
< title > BOOST_PP_TUPLE_EAT< / title >
2002-10-03 22:13:37 +00:00
< link rel = "stylesheet" type = "text/css" href = "../styles.css" >
2011-06-26 13:07:20 +00:00
< / head >
< body >
< div style = "margin-left: 0px;" >
The < b > BOOST_PP_TUPLE_EAT< / b > macro expands to a macro that eats a < i > tuple< / i > .
2002-10-03 22:13:37 +00:00
< / div >
< h4 > Usage< / h4 >
< div class = "code" >
2011-06-26 13:07:20 +00:00
< b > BOOST_PP_TUPLE_EAT< / b > (< i > size< / i > )< br >
< br >
or< br >
< br >
2013-04-14 01:46:09 +00:00
< b > BOOST_PP_TUPLE_EAT< / b > (< i > size< / i > ) < a href = "../topics/variadic_macros.html#VNotation" target = "_self" > < sup > (v)< / sup > < / a > < b > < / b > < br >
2011-06-26 13:07:20 +00:00
< / div >
2002-10-03 22:13:37 +00:00
< h4 > Arguments< / h4 >
< dl >
< dt > size< / dt >
< dd >
The size of the < i > tuple< / i > to be eaten.
2011-06-26 13:07:20 +00:00
Valid < i > tuple< / i > sizes range from < i > 1< / i > to < b > BOOST_PP_LIMIT_TUPLE< / b > .
2002-10-03 22:13:37 +00:00
< / dd >
< / dl >
< h4 > Remarks< / h4 >
< div >
2011-06-26 13:07:20 +00:00
The < i > size< / i > argument must be the actual size of the < i > tuple< / i > in the non-variadic version. < br >
2013-04-14 01:46:09 +00:00
< br > For the variadic version < a href = "../topics/variadic_macros.html#VNotation" target = "_self" > < sup > (v)< / sup > < / a > the
2011-06-26 13:07:20 +00:00
size may be left out
completely so that the macro can be invoked as BOOST_PP_TUPLE_EAT(); you may get a warning from some compilers, but the
functionality will still work. If you specify a size in the variadic
version, it will be ignored, but the warning from some compilers will
not occur.< br >
< / div >
2002-10-03 22:13:37 +00:00
< h4 > See Also< / h4 >
< ul >
< li > < a href = "limit_tuple.html" > BOOST_PP_LIMIT_TUPLE< / a > < / li >
< / ul >
< h4 > Requirements< / h4 >
< div >
2004-10-11 06:58:45 +00:00
< b > Header:< / b > < a href = "../headers/tuple/eat.html" > < boost/preprocessor/tuple/eat.hpp> < / a >
2002-10-03 22:13:37 +00:00
< / div >
< h4 > Sample Code< / h4 >
2013-04-14 01:46:09 +00:00
< div > < pre > #include < < a href = "../headers/control/if.html" > boost/preprocessor/control/if.hpp< / a > > < br > #include < < a href = "../headers/tuple/eat.html" > boost/preprocessor/tuple/eat.hpp< / a > > < br > < br > #define OP(a, b) (a b)< br > < br > #define MACRO(n) < a href = "if.html" > BOOST_PP_IF< / a > (n, OP, < a href = "tuple_eat.html" > BOOST_PP_TUPLE_EAT< / a > (2))(1, 2)< br > < br > // or for the variadic version < a href = "../topics/variadic_macros.html#VNotation" target = "_self" > < sup > (v)< / sup > < / a > < br > < br > #define MACRO(n) < a href = "if.html" > BOOST_PP_IF< / a > (n, OP, < a href = "file:///C:/Programming/VersionControl/sandbox/variadics/libs/preprocessor/doc/ref/tuple_eat.html" > BOOST_PP_TUPLE_EAT< / a > ())(1, 2)< br > < br > MACRO(0) // expands to nothing< br > MACRO(1) // expands to (1, 2)< br > < / pre > < / div >
2006-07-23 20:45:18 +00:00
< hr size = "1" >
< div style = "margin-left: 0px;" >
< i > <EFBFBD> Copyright < a href = "http://www.housemarque.com" target = "_top" > Housemarque Oy< / a > 2002< / i >
2011-06-26 13:07:20 +00:00
< br > < i > <EFBFBD> Copyright Paul Mensonides 2002< br >
2013-04-14 01:46:09 +00:00
< / i > < i > <EFBFBD> Copyright Edward Diener 2011,2013< / i > < br >
2006-07-23 20:45:18 +00:00
< / div >
< div style = "margin-left: 0px;" >
< p > < small > Distributed under the Boost Software License, Version 1.0. (See
2006-07-26 01:19:35 +00:00
accompanying file < a href = "../../../../LICENSE_1_0.txt" > LICENSE_1_0.txt< / a > or
2011-06-26 13:07:20 +00:00
copy at < a href = "http://www.boost.org/LICENSE_1_0.txt" > www.boost.org/LICENSE_1_0.txt< / a > )< / small > < / p >
2006-07-23 20:45:18 +00:00
< / div >
2011-06-26 13:07:20 +00:00
< / body >
< / html >
