• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3	<title>BOOST_PP_DEC</title>
4	<link rel="stylesheet" type="text/css" href="../styles.css">
5</head>
6<body>
7	<div style="margin-left:  0px;">
8		The <b>BOOST_PP_DEC</b> macro expands to one less than its argument.
9	</div>
10	<h4>Usage</h4>
11		<div class="code">
12			<b>BOOST_PP_DEC</b>(<i>x</i>)
13		</div>
14	<h4>Arguments</h4>
15		<dl>
16			<dt>x</dt>
17			<dd>
18				The value to be decremented.&nbsp;
19				Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
20			</dd>
21		</dl>
22	<h4>Remarks</h4>
23		<div>
24			If <i>x</i> is <i>0</i>, the result is saturated to <i>0</i>.
25		</div>
26	<h4>See Also</h4>
27		<ul>
28			<li><a href="inc.html">BOOST_PP_INC</a></li>
29			<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
30		</ul>
31	<h4>Requirements</h4>
32		<div>
33			<b>Header:</b> &nbsp;<a href="../headers/arithmetic/dec.html">&lt;boost/preprocessor/arithmetic/dec.hpp&gt;</a>
34		</div>
35	<h4>Sample Code</h4>
36<div><pre>
37#include &lt;<a href="../headers/arithmetic/dec.html">boost/preprocessor/arithmetic/dec.hpp</a>&gt;
38
39<a href="dec.html">BOOST_PP_DEC</a>(<a href="dec.html">BOOST_PP_DEC</a>(6)) // expands to 4
40<a href="dec.html">BOOST_PP_DEC</a>(0) // expands to 0
41</pre></div>
42	<hr size="1">
43	<div style="margin-left: 0px;">
44		<i>� Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
45		</br><i>� Copyright Paul Mensonides 2002</i>
46	</div>
47	<div style="margin-left: 0px;">
48		<p><small>Distributed under the Boost Software License, Version 1.0. (See
49		accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
50		copy at <a href=
51		"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
52	</div>
53</body>
54</html>
55