xor.html 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <html>
  2. <head>
  3. <title>BOOST_PP_XOR</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_XOR</b> macro expands to the logical <i>XOR</i> of its operands.
  9. </div>
  10. <h4>Usage</h4>
  11. <div class="code">
  12. <b>BOOST_PP_XOR</b>(<i>p</i>, <i>q</i>)
  13. </div>
  14. <h4>Arguments</h4>
  15. <dl>
  16. <dt>p</dt>
  17. <dd>
  18. The left operand of the operation.&nbsp;
  19. Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
  20. </dd>
  21. <dt>q</dt>
  22. <dd>
  23. The right operand of the operation.&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 either <i>p</i> or <i>q</i> is non-zero exclusively, this macro expands to <i>1</i>.&nbsp;
  30. Otherwise, it expands to <i>0</i>.
  31. </div>
  32. <div>
  33. This macro performs a boolean conversion on each operand before performing the logical <i>XOR</i> operation.&nbsp;
  34. If that conversion is not necessary, use <b>BOOST_PP_BITXOR</b> instead.
  35. </div>
  36. <h4>See Also</h4>
  37. <ul>
  38. <li><a href="bitxor.html">BOOST_PP_BITXOR</a></li>
  39. <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
  40. </ul>
  41. <h4>Requirements</h4>
  42. <div>
  43. <b>Header:</b> &nbsp;<a href="../headers/logical/xor.html">&lt;boost/preprocessor/logical/xor.hpp&gt;</a>
  44. </div>
  45. <h4>Sample Code</h4>
  46. <div><pre>
  47. #include &lt;<a href="../headers/logical/xor.html">boost/preprocessor/logical/xor.hpp</a>&gt;
  48. <a href="xor.html">BOOST_PP_XOR</a>(4, 3) // expands to 0
  49. <a href="xor.html">BOOST_PP_XOR</a>(5, 0) // expands to 1
  50. </pre></div>
  51. <hr size="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>
  55. </div>
  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
  59. copy at <a href=
  60. "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
  61. </div>
  62. </body>
  63. </html>