forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
69
doc/ref/local_limits.html
Normal file
69
doc/ref/local_limits.html
Normal file
@ -0,0 +1,69 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_LOCAL_LIMITS</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_LOCAL_LIMITS</b> macro is a user-defined <i>named external argument</i> used by <b>BOOST_PP_LOCAL_ITERATE</b>.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
#define <b>BOOST_PP_LOCAL_LIMITS</b> (<i>start</i>, <i>finish</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>start</dt>
|
||||
<dd>
|
||||
The lower bound (inclusive) of a <i>local iteration</i>.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
|
||||
</dd>
|
||||
<dt>finish</dt>
|
||||
<dd>
|
||||
The upper bound (inclusive) of a <i>local iteration</i>.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
Note that there is a whitespace character after the macro identifier.
|
||||
</div>
|
||||
<div>
|
||||
This macro must expand to a <i>2</i>-element <i>tuple</i>.
|
||||
The elements of this <i>tuple</i> represent the lower and upper boundaries of a <i>local iteration</i>.
|
||||
Both <i>start</i> and <i>finish</i> are <i>evaluated parameters</i>.
|
||||
This implies that they can include simple arithmetic expressions (such as <i>1</i> + <i>3</i>), etc..
|
||||
</div>
|
||||
<div>
|
||||
This macro is automatically undefined for reuse by a call to <b>BOOST_PP_LOCAL_ITERATE</b>.
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="limit_iteration.html">BOOST_PP_LIMIT_ITERATION</a></li>
|
||||
<li><a href="local_iterate.html">BOOST_PP_LOCAL_ITERATE</a></li>
|
||||
</ul>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
#include <<a href="../headers/iteration/local.hpp.html">boost/preprocessor/iteration/local.hpp</a>>
|
||||
|
||||
template<int> struct sample;
|
||||
|
||||
#define <a href="local_macro.html">BOOST_PP_LOCAL_MACRO</a>(n) \
|
||||
template<> struct sample<n> { \
|
||||
enum { value = n }; \
|
||||
}; \
|
||||
/**/
|
||||
|
||||
#define <a href="local_limits.html">BOOST_PP_LOCAL_LIMITS</a> (1, 5)
|
||||
|
||||
#include <a href="local_iterate.html">BOOST_PP_LOCAL_ITERATE</a>()
|
||||
/* expands to...
|
||||
template<> struct sample<1> { enum { value = 1 }; };
|
||||
template<> struct sample<2> { enum { value = 2 }; };
|
||||
template<> struct sample<3> { enum { value = 3 }; };
|
||||
template<> struct sample<4> { enum { value = 4 }; };
|
||||
template<> struct sample<5> { enum { value = 5 }; };
|
||||
*/
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user