mirror of
https://github.com/boostorg/preprocessor.git
synced 2025-07-15 21:42:08 +02:00
54 lines
1.7 KiB
HTML
54 lines
1.7 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>BOOST_PP_SUB</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||
|
|
<script language="javascript" type="text/javascript" src="../scripts.js"></script>
|
||
|
|
</head>
|
||
|
|
<body onload="init('sample');">
|
||
|
|
<div style="margin-left: 0px;">
|
||
|
|
The <b>BOOST_PP_SUB</b> macro expands to the difference between its arguments.
|
||
|
|
</div>
|
||
|
|
<h4>Usage</h4>
|
||
|
|
<div class="code">
|
||
|
|
<b>BOOST_PP_SUB</b>(<i>x</i>, <i>y</i>)
|
||
|
|
</div>
|
||
|
|
<h4>Arguments</h4>
|
||
|
|
<dl>
|
||
|
|
<dt>x</dt>
|
||
|
|
<dd>
|
||
|
|
The minuend of the operation.
|
||
|
|
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||
|
|
</dd>
|
||
|
|
<dt>y</dt>
|
||
|
|
<dd>
|
||
|
|
The subtrahend of the operation.
|
||
|
|
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<h4>Remarks</h4>
|
||
|
|
<div>
|
||
|
|
If the difference between <i>x</i> and <i>y</i> is less than <i>0</i>, the result is saturated to <i>0</i>.
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.
|
||
|
|
There is no longer any such restriction.
|
||
|
|
It is more efficient, however, to use <b>BOOST_PP_SUB_D</b> in such a situation.
|
||
|
|
</div>
|
||
|
|
<h4>See Also</h4>
|
||
|
|
<ul>
|
||
|
|
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
|
||
|
|
<li><a href="sub_d.html">BOOST_PP_SUB_D</a></li>
|
||
|
|
</ul>
|
||
|
|
<h4>Requirements</h4>
|
||
|
|
<div>
|
||
|
|
<b>Header:</b> <a href="../headers/arithmetic/sub.hpp.html"><boost/preprocessor/arithmetic/sub.hpp></a>
|
||
|
|
</div>
|
||
|
|
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
|
||
|
|
<div id="sample"><pre>
|
||
|
|
#include <boost/preprocessor/arithmetic/sub.hpp>
|
||
|
|
|
||
|
|
BOOST_PP_SUB(4, 3) // expands to 1
|
||
|
|
<pre></div>
|
||
|
|
</body>
|
||
|
|
</html>
|