forked from boostorg/preprocessor
extended array support
[SVN r15747]
This commit is contained in:
53
doc/ref/array_replace.html
Normal file
53
doc/ref/array_replace.html
Normal file
@ -0,0 +1,53 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_ARRAY_REPLACE</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_ARRAY_REPLACE</b> macro replaces an element in an <i>array</i>.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_ARRAY_REPLACE</b>(<i>array</i>, <i>i</i>, <i>elem</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>array</dt>
|
||||
<dd>
|
||||
An <i>array</i> to replace an element in.
|
||||
</dd>
|
||||
<dt>i</dt>
|
||||
<dd>
|
||||
The zero-based position in <i>array</i> of the element to be replaced.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_ARRAY_SIZE</b>(<i>array</i>) - <i>1</i>.
|
||||
</dd>
|
||||
<dt>elem</dt>
|
||||
<dd>
|
||||
The replacement element.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
This macro uses <b>BOOST_PP_WHILE</b> interally.
|
||||
Therefore, to use the <i>d</i> parameter passed from other macros that use <b>BOOST_PP_WHILE</b>,
|
||||
see <b>BOOST_PP_ARRAY_REPLACE_D</b>.
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="array_replace_d.html">BOOST_PP_ARRAY_REPLACE_D</a></li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/array/replace.hpp.html"><boost/preprocessor/array/replace.hpp></a>
|
||||
</div>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
#include <<a href="../headers/array/replace.hpp.html">boost/preprocessor/array/replace.hpp</a>>
|
||||
|
||||
#define ARRAY (3, (a, x, c))
|
||||
|
||||
<a href="array_replace.html">BOOST_PP_ARRAY_REPLACE</a>(ARRAY, 1, b) // expands to (3, (a, b, c))
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user