• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3	<title>BOOST_PP_REPEAT_FROM_TO_D</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_FROM_TO_D</b> macro represents a fast horizontal repetition construct.&nbsp;
9		It reenters <b>BOOST_PP_WHILE</b> with maximum efficiency.
10	</div>
11	<h4>Usage</h4>
12		<div class="code">
13			<b>BOOST_PP_REPEAT_FROM_TO_D</b>(<i>d</i>, <i>first</i>, <i>last</i>, <i>macro</i>, <i>data</i>)
14		</div>
15	<h4>Arguments</h4>
16		<dl>
17			<dt>d</dt>
18			<dd>
19				The next available <b>BOOST_PP_WHILE</b> iteration.
20			</dd>
21			<dt>first</dt>
22			<dd>
23				The lower bound of the repetition.&nbsp;
24				Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
25			</dd>
26			<dt>last</dt>
27			<dd>
28				The upper bound of the repetition.
29				Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
30			</dd>
31			<dt>macro</dt>
32			<dd>
33				A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).&nbsp;
34				This macro is expanded by <b>BOOST_PP_REPEAT</b> with the next available repetition depth,
35				the current repetition number, and the auxiliary <i>data</i> argument.&nbsp;
36			</dd>
37			<dt>data</dt>
38			<dd>
39				Auxiliary data passed to <i>macro</i>.
40			</dd>
41		</dl>
42	<h4>Remarks</h4>
43		<div>
44			This macro expands to the sequence:
45			<div>
46				<i>macro</i>(<i>z</i>, <i>first</i>, <i>data</i>) <i>macro</i>(<i>z</i>, <i>first</i> + <i>1</i>, <i>data</i>) ... <i>macro</i>(<i>z</i>, <i>last</i> - <i>1</i>, <i>data</i>)
47			</div>
48		</div>
49		<div>
50			The number of repetitions (i.e. <i>last</i> - <i>first</i>) must not exceed <b>BOOST_PP_LIMIT_REPEAT</b>.
51		</div>
52		<div>
53			The <i>z</i> value that is passed to <i>macro</i> represents the next available repetition dimension.&nbsp;
54			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>.&nbsp;
55			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.
56		</div>
57		<div>
58			To directly use this <i>z</i> value, rather than simply passing it to another macro, see <b>BOOST_PP_REPEAT_FROM_TO_D_<i>z</i></b>.
59		</div>
60	<h4>See Also</h4>
61		<ul>
62			<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
63			<li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
64			<li><a href="repeat_from_to.html">BOOST_PP_REPEAT_FROM_TO</a></li>
65			<li><a href="repeat_from_to_d_z.html">BOOST_PP_REPEAT_FROM_TO_D_<i>z</i></a></li>
66		</ul>
67	<h4>Requirements</h4>
68		<div>
69			<b>Header:</b> &nbsp;<a href="../headers/repetition/repeat_from_to.html">&lt;boost/preprocessor/repetition/repeat_from_to.hpp&gt;</a>
70		</div>
71	<hr size="1">
72	<div style="margin-left: 0px;">
73		<i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
74		</br><i>� Copyright Paul Mensonides 2002</i>
75	</div>
76	<div style="margin-left: 0px;">
77		<p><small>Distributed under the Boost Software License, Version 1.0. (See
78		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
79		copy at <a href=
80		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
81	</div>
82</body>
83</html>
84