3 <title>BOOST_PP_SUB
</title>
4 <link rel=
"stylesheet" type=
"text/css" href=
"../styles.css">
7 <div style=
"margin-left: 0px;">
8 The
<b>BOOST_PP_SUB
</b> macro expands to the difference between its arguments.
12 <b>BOOST_PP_SUB
</b>(
<i>x
</i>,
<i>y
</i>)
18 The minuend of the operation.
19 Valid values range from
<i>0</i> to
<b>BOOST_PP_LIMIT_MAG
</b>.
23 The subtrahend of the operation.
24 Valid values range from
<i>0</i> to
<b>BOOST_PP_LIMIT_MAG
</b>.
29 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>.
32 Previously, this macro could not be used inside
<b>BOOST_PP_WHILE
</b>.
33 There is no longer any such restriction.
34 It is more efficient, however, to use
<b>BOOST_PP_SUB_D
</b> in such a situation.
38 <li><a href=
"limit_mag.html">BOOST_PP_LIMIT_MAG
</a></li>
39 <li><a href=
"sub_d.html">BOOST_PP_SUB_D
</a></li>
43 <b>Header:
</b> <a href=
"../headers/arithmetic/sub.html"><boost/preprocessor/arithmetic/sub.hpp
></a>
47 #include
<<a href=
"../headers/arithmetic/sub.html">boost/preprocessor/arithmetic/sub.hpp
</a>>
49 <a href=
"sub.html">BOOST_PP_SUB
</a>(
4,
3) // expands to
1
52 <div style=
"margin-left: 0px;">
53 <i>© Copyright
<a href=
"http://www.housemarque.com" target=
"_top">Housemarque Oy
</a> 2002</i>
54 </br><i>© Copyright Paul Mensonides
2002</i>
56 <div style=
"margin-left: 0px;">
57 <p><small>Distributed under the Boost Software License, Version
1.0. (See
58 accompanying file
<a href=
"../../../../LICENSE_1_0.txt">LICENSE_1_0.txt
</a> or
60 "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt
</a>)
</small></p>