blob: 4efb55f7a7e5379c2c9ed185d3e762336a4ada37 [file] [log] [blame]
Brian Silvermanf27e0852018-08-04 23:56:45 -07001<html>
2<head>
3 <title>BOOST_PP_BITOR</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_BITOR</b> macro expands to the bitwise <i>OR</i> of its operands.
9 </div>
10 <h4>Usage</h4>
11 <div class="code">
12 <b>BOOST_PP_BITOR</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 operation.&nbsp;
19 This value must expand to <i>0</i> or <i>1</i>.
20 </dd>
21 <dt>y</dt>
22 <dd>
23 The right operand of the operation.&nbsp;
24 This value must expand to <i>0</i> or <i>1</i>.
25 </dd>
26 </dl>
27 <h4>Remarks</h4>
28 <div>
29 If either <i>x</i> or <i>y</i> is <i>1</i>, this macro expands to <i>1</i>.&nbsp;
30 Otherwise, it expands to <i>0</i>.
31 </div>
32 <div>
33 This macro <i>does not</i> perform a boolean conversion on either operand before performing the bitwise <i>OR</i> operation.&nbsp;
34 If that conversion is necessary, use <b>BOOST_PP_OR</b> instead.
35 </div>
36 <h4>See Also</h4>
37 <ul>
38 <li><a href="or.html">BOOST_PP_OR</a></li>
39 </ul>
40 <h4>Requirements</h4>
41 <div>
42 <b>Header:</b> &nbsp;<a href="../headers/logical/bitor.html">&lt;boost/preprocessor/logical/bitor.hpp&gt;</a>
43 </div>
44 <h4>Sample Code</h4>
45<div><pre>
46#include &lt;<a href="../headers/logical/bitor.html">boost/preprocessor/logical/bitor.hpp</a>&gt;
47
48<a href="bitor.html">BOOST_PP_BITOR</a>(0, 0) // expands to 0
49<a href="bitor.html">BOOST_PP_BITOR</a>(0, 1) // expands to 1
50<a href="bitor.html">BOOST_PP_BITOR</a>(1, 0) // expands to 1
51<a href="bitor.html">BOOST_PP_BITOR</a>(1, 1) // expands to 1
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>