Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/preprocessor/doc/ref/greater.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 16 years ago

updated boost from 1_33_1 to 1_34_1

File size: 2.1 KB
Line 
1<html>
2<head>
3        <title>BOOST_PP_GREATER</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_GREATER</b> macro compares two values for greater magnitude.
9        </div>
10        <h4>Usage</h4>
11                <div class="code">
12                        <b>BOOST_PP_GREATER</b>(<i>x</i>, <i>y</i>)
13                </div>
14        <h4>Arguments</h4>
15                <dl>
16                        <dt>x</dt>
17                        <dd>
18                                The left operand of the comparison.&nbsp;
19                                Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
20                        </dd>
21                        <dt>y</dt>
22                        <dd>
23                                The right operand of the comparison.&nbsp;
24                                Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
25                        </dd>
26                </dl>
27        <h4>Remarks</h4>
28                <div>
29                        If <i>x</i> is greater than <i>y</i>, this macro expands to <i>1</i>.&nbsp;
30                        Otherwise, it expands to <i>0</i>.
31                </div>
32                <div>
33                        Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.&nbsp;
34                        There is no longer any such restriction.&nbsp;
35                        It is more efficient, however, to use <b>BOOST_PP_GREATER_D</b> in such a situation.
36                </div>
37        <h4>See Also</h4>
38                <ul>
39                        <li><a href="greater_d.html">BOOST_PP_GREATER_D</a></li>
40                        <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
41                </ul>
42        <h4>Requirements</h4>
43                <div>
44                        <b>Header:</b> &nbsp;<a href="../headers/comparison/greater.html">&lt;boost/preprocessor/comparison/greater.hpp&gt;</a>
45                </div>
46        <h4>Sample Code</h4>
47<div><pre>
48#include &lt;<a href="../headers/comparison/greater.html">boost/preprocessor/comparison/greater.hpp</a>&gt;
49
50<a href="greater.html">BOOST_PP_GREATER</a>(4, 3) // expands to 1
51<a href="greater.html">BOOST_PP_GREATER</a>(5, 5) // expands to 0
52</pre></div>
53        <hr size="1">
54        <div style="margin-left: 0px;">
55                <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
56                </br><i>© Copyright Paul Mensonides 2002</i>
57        </div>
58        <div style="margin-left: 0px;">
59                <p><small>Distributed under the Boost Software License, Version 1.0. (See
60                accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
61                copy at <a href=
62                "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
63        </div>
64</body>
65</html>
Note: See TracBrowser for help on using the repository browser.