Squashed 'third_party/boostorg/preprocessor/' content from commit 56090c5
Change-Id: I8c0a13225778c3751a35945439d5304bd9e639ef
git-subtree-dir: third_party/boostorg/preprocessor
git-subtree-split: 56090c56b5c78418b6dbe8c3c2ba576395152f83
diff --git a/doc/ref/mul.html b/doc/ref/mul.html
new file mode 100644
index 0000000..174d88b
--- /dev/null
+++ b/doc/ref/mul.html
@@ -0,0 +1,68 @@
+<html>
+<head>
+ <title>BOOST_PP_MUL</title>
+ <link rel="stylesheet" type="text/css" href="../styles.css">
+</head>
+<body>
+ <div style="margin-left: 0px;">
+ The <b>BOOST_PP_MUL</b> macro expands to the product of its arguments.
+ </div>
+ <h4>Usage</h4>
+ <div class="code">
+ <b>BOOST_PP_MUL</b>(<i>x</i>, <i>y</i>)
+ </div>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>x</dt>
+ <dd>
+ The multiplicand of the operation.
+ Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
+ </dd>
+ <dt>y</dt>
+ <dd>
+ The multiplier of the operation.
+ Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
+ </dd>
+ </dl>
+ <h4>Remarks</h4>
+ <div>
+ If the product of <i>x</i> and <i>y</i> is greater than <b>BOOST_PP_LIMIT_MAG</b>, the result is saturated to <b>BOOST_PP_LIMIT_MAG</b>.
+ </div>
+ <div>
+ Previously, this macro could not be used inside <b>BOOST_PP_WHILE</b>.
+ There is no longer any such restriction.
+ It is more efficient, however, to use <b>BOOST_PP_MUL_D</b> in such a situation.
+ </div>
+ <div>
+ This macro is the most efficient when <i>x</i> is greater than or equal to <i>y</i>.
+ However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.
+ In other words, <i>x</i> should be the value that is <i>most likely</i> to be the largest of the two operands.
+ </div>
+ <h4>See Also</h4>
+ <ul>
+ <li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
+ <li><a href="mul_d.html">BOOST_PP_MUL_D</a></li>
+ </ul>
+ <h4>Requirements</h4>
+ <div>
+ <b>Header:</b> <a href="../headers/arithmetic/mul.html"><boost/preprocessor/arithmetic/mul.hpp></a>
+ </div>
+ <h4>Sample Code</h4>
+<div><pre>
+#include <<a href="../headers/arithmetic/mul.html">boost/preprocessor/arithmetic/mul.hpp</a>>
+
+<a href="mul.html">BOOST_PP_MUL</a>(4, 4) // expands to 16
+</pre></div>
+ <hr size="1">
+ <div style="margin-left: 0px;">
+ <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
+ </br><i>© Copyright Paul Mensonides 2002</i>
+ </div>
+ <div style="margin-left: 0px;">
+ <p><small>Distributed under the Boost Software License, Version 1.0. (See
+ accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
+ copy at <a href=
+ "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
+ </div>
+</body>
+</html>