]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <html> |
2 | <head> | |
3 | <title>BOOST_PP_REPEAT_3RD</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_REPEAT_3RD</b> macro represents the third dimension of <b>BOOST_PP_REPEAT</b>. | |
9 | </div> | |
10 | <h4>Usage</h4> | |
11 | <div class="code"> | |
12 | <b>BOOST_PP_REPEAT_3RD</b>(<i>count</i>, <i>macro</i>, <i>data</i>) | |
13 | </div> | |
14 | <h4>Arguments</h4> | |
15 | <dl> | |
16 | <dt>count</dt> | |
17 | <dd> | |
18 | The number of repetitious calls to <i>macro</i>. | |
19 | Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>. | |
20 | </dd> | |
21 | <dt>macro</dt> | |
22 | <dd> | |
23 | A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>). | |
24 | This macro is expanded by <b>BOOST_PP_REPEAT_3RD</b> with the next available repetition depth, | |
25 | the current repetition number, and the auxiliary <i>data</i> argument. | |
26 | </dd> | |
27 | <dt>data</dt> | |
28 | <dd> | |
29 | Auxiliary data passed to <i>macro</i>. | |
30 | </dd> | |
31 | </dl> | |
32 | <h4>Remarks</h4> | |
33 | <div> | |
34 | This macro expands to the sequence: | |
35 | <div> | |
36 | <i>macro</i>(<i>z</i>, <i>0</i>, <i>data</i>) <i>macro</i>(<i>z</i>, <i>1</i>, <i>data</i>) ... <i>macro</i>(<i>z</i>, <i>count</i> - <i>1</i>, <i>data</i>) | |
37 | </div> | |
38 | </div> | |
39 | <div> | |
40 | The <i>z</i> value that is passed to <i>macro</i> represents the next available repetition dimension. | |
41 | Other macros that have <b>_Z</b> suffix variants internally use <b>BOOST_PP_REPEAT</b>--for example, <b>BOOST_PP_ENUM_PARAMS</b> and <b>BOOST_PP_ENUM_PARAMS_Z</b>. | |
42 | Using these <b>_Z</b> versions is not strictly necessary, but passing the <i>z</i> value (that is passed to <i>macro</i>) to these macros allows them to reenter <b>BOOST_PP_REPEAT</b> with maximum efficiency. | |
43 | </div> | |
44 | <div> | |
45 | To directly use this <i>z</i> value, rather than simply passing it to another macro, see <b>BOOST_PP_REPEAT_<i>z</i></b>. | |
46 | </div> | |
47 | <div> | |
48 | This macro is deprecated. | |
49 | It only exists for backward compatibility. | |
50 | Use <b>BOOST_PP_REPEAT</b> instead. | |
51 | </div> | |
52 | <h4>See Also</h4> | |
53 | <ul> | |
54 | <li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li> | |
55 | <li><a href="repeat.html">BOOST_PP_REPEAT</a></li> | |
56 | <li><a href="repeat_z.html">BOOST_PP_REPEAT_<i>z</i></a></li> | |
57 | </ul> | |
58 | <h4>Requirements</h4> | |
59 | <div> | |
60 | <b>Header:</b> <a href="../headers/repetition/repeat.html"><boost/preprocessor/repetition/repeat.hpp></a> | |
61 | </div> | |
62 | <h4>Sample Code</h4> | |
63 | <div><pre> | |
64 | #include <<a href="../headers/repetition/repeat.html">boost/preprocessor/repetition/repeat.hpp</a>> | |
65 | ||
66 | #define DECL(z, n, text) text ## n = n; | |
67 | ||
68 | <a href="repeat_3rd.html">BOOST_PP_REPEAT_3RD</a>(5, DECL, int x) | |
69 | </pre></div> | |
70 | <hr size="1"> | |
71 | <div style="margin-left: 0px;"> | |
72 |