mirror of
https://github.com/boostorg/preprocessor.git
synced 2025-07-15 13:36:33 +02:00
82 lines
2.8 KiB
HTML
82 lines
2.8 KiB
HTML
<html>
|
|
<head>
|
|
<title>BOOST_PP_MUL_D</title>
|
|
<link rel="stylesheet" type="text/css" href="../styles.css">
|
|
<script language="javascript" type="text/javascript" src="../scripts.js"></script>
|
|
</head>
|
|
<body onload="init('sample');">
|
|
<div style="margin-left: 0px;">
|
|
The <b>BOOST_PP_MUL_D</b> macro expands to the product of its second and third arguments.
|
|
It reenters <b>BOOST_PP_WHILE</b> with maximum efficiency.
|
|
</div>
|
|
<h4>Usage</h4>
|
|
<div class="code">
|
|
<b>BOOST_PP_MUL_D</b>(<i>d</i>, <i>x</i>, <i>y</i>)
|
|
</div>
|
|
<h4>Arguments</h4>
|
|
<dl>
|
|
<dt>d</dt>
|
|
<dd>
|
|
The next available <b>BOOST_PP_WHILE</b> iteration.
|
|
</dd>
|
|
<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>
|
|
This macro is the most efficient when <i>x</i> is less 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.html">BOOST_PP_MUL</a></li>
|
|
</ul>
|
|
<h4>Requirements</h4>
|
|
<div>
|
|
<b>Header:</b> <a href="../headers/arithmetic/mul.hpp.html"><boost/preprocessor/arithmetic/mul.hpp></a>
|
|
</div>
|
|
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
|
|
<div id="sample"><pre>
|
|
#include <boost/preprocessor/arithmetic/mul.hpp>
|
|
#include <boost/preprocessor/arithmetic/dec.hpp>
|
|
#include <boost/preprocessor/control/while.hpp>
|
|
#include <boost/preprocessor/tuple/elem.hpp>
|
|
|
|
#define PRED(d, data) BOOST_PP_TUPLE_ELEM(3, 0, data)
|
|
|
|
#define OP(d, data) /* ............... */ \
|
|
( \
|
|
BOOST_PP_DEC( \
|
|
BOOST_PP_TUPLE_ELEM(3, 0, data) \
|
|
), \
|
|
BOOST_PP_TUPLE_ELEM(3, 1, data), \
|
|
BOOST_PP_MUL_D( \
|
|
d, \
|
|
BOOST_PP_TUPLE_ELEM(3, 2, data), \
|
|
BOOST_PP_TUPLE_ELEM(3, 1, data) \
|
|
) \
|
|
) \
|
|
/**/
|
|
|
|
// raise 'x' to the 'n'-th power
|
|
#define EXP(x, n) BOOST_PP_TUPLE_ELEM(3, 2, BOOST_PP_WHILE(PRED, OP, (n, x, 1)))
|
|
|
|
EXP(4, 2) // expands to 16
|
|
EXP(2, 3) // expands to 8
|
|
<pre></div>
|
|
</body>
|
|
</html>
|