Files
preprocessor/docs.1/ref/dec.html
Paul Mensonides cdc4be5256 initial revision
[SVN r15198]
2002-09-08 09:40:56 +00:00

45 lines
1.3 KiB
HTML

<html>
<head>
<title>BOOST_PP_DEC</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_DEC</b> macro expands to one less than its argument.
</div>
<h4>Usage</h4>
<div class="code">
<b>BOOST_PP_DEC</b>(<i>x</i>)
</div>
<h4>Arguments</h4>
<dl>
<dt>x</dt>
<dd>
The value to be decremented.&nbsp;
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
</dd>
</dl>
<h4>Remarks</h4>
<div>
If <i>x</i> is <i>0</i>, the result is saturated to <i>0</i>.
</div>
<h4>See Also</h4>
<ul>
<li><a href="inc.html">BOOST_PP_INC</a></li>
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
</ul>
<h4>Requirements</h4>
<div>
<b>Header:</b> &nbsp;<a href="../headers/arithmetic/dec.hpp.html">&lt;boost/preprocessor/arithmetic/dec.hpp&gt;</a>
</div>
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
<div id="sample"><pre>
#include &lt;boost/preprocessor/arithmetic/dec.hpp&gt;
BOOST_PP_DEC(BOOST_PP_DEC(6)) // expands to 4
BOOST_PP_DEC(0) // expands to 0
<pre></div>
</body>
</html>