libs/preprocessor/doc/ref/tuple_reverse.html

   1 <html>
   2   <head>
   3     <title>BOOST_PP_TUPLE_REVERSE</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_TUPLE_REVERSE</b> macro reverses a <i>tuple</i>.
   9         </div>
  10         <h4>Usage</h4>
  11                 <div class="code">
  12                         <b>BOOST_PP_TUPLE_REVERSE</b>(<i>size</i>, <i>tuple</i>)<br>
  13 <br>
  14 or<br>
  15 <br>
  16 <b>BOOST_PP_TUPLE_REVERSE</b>(<i>...</i>) <sup>(v)</sup><br>
  17
  18                 </div>
  19         <h4>Arguments</h4>
  20                 <dl>
  21                         <dt>size</dt>
  22                         <dd>
  23                                 The size of the <i>tuple</i> to be reversed.&nbsp;
  24                                 Valid <i>tuple</i> sizes range from <i>1</i> to <b>BOOST_PP_LIMIT_TUPLE</b>.&nbsp;
  25                         </dd>
  26                         <dt>tuple</dt>
  27                         <dd>
  28                                 The <i>tuple</i> to be reversed.
  29                         </dd>
  30                 </dl>
  31         <h4>Remarks</h4>
  32                 <div>
  33                         The <i>size</i> argument must be the actual size of the <i>tuple</i>.<br>
  34 <br>
  35 You can
  36 invoke the variadic version <sup>(v)</sup> as BOOST_PP_TUPLE_REVERSE(<i>tuple</i>) or
  37 BOOST_PP_TUPLE_REVERSE(<i>size</i>,<i>tuple</i>).<br>
  38                 </div>
  39         <h4>See Also</h4>
  40                 <ul>
  41                         <li><a href="limit_tuple.html">BOOST_PP_LIMIT_TUPLE</a></li>
  42                 </ul>
  43         <h4>Requirements</h4>
  44                 <div>
  45                         <b>Header:</b> &nbsp;<a href="../headers/tuple/reverse.html">&lt;boost/preprocessor/tuple/reverse.hpp&gt;</a>
  46                 </div>
  47         <h4>Sample Code</h4>
  48 <div><pre>#include &lt;<a href="../headers/tuple/reverse.html">boost/preprocessor/tuple/reverse.hpp</a>&gt;<br><br><a href="tuple_reverse.html">BOOST_PP_TUPLE_REVERSE</a>(3, (x, y, z)) // expands to (z, y, x)<br><br>// or for the variadic version <sup>(v)<br><br></sup><a href="tuple_reverse.html">BOOST_PP_TUPLE_REVERSE</a>((x, y, z)) // expands to (z, y, x)<br></pre></div>
  49         <hr size="1">
  50         <div style="margin-left: 0px;">
  51                 <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
  52                 <br><i>© Copyright Paul Mensonides 2002<br>
  53 </i><i>© Copyright Edward Diener 2011</i><br>
  54         </div>
  55         <div style="margin-left: 0px;">
  56                 <p><small>Distributed under the Boost Software License, Version 1.0. (See
  57                 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  58                 copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  59         </div>
  60   </body>
  61 </html>