boostorg/preprocessor
1
0
Fork 1
mirror of https://github.com/boostorg/preprocessor.git synced 2025-07-24 09:17:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

initial revision

Browse Source 
[SVN r15198]
This commit is contained in:
Paul Mensonides
2002-09-08 09:40:56 +00:00
parent cb61e12209
commit cdc4be5256
294 changed files with 12946 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
docs.1/ref/mul_d.html Normal file
View File

@ -0,0 +1,81 @@
<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.&nbsp;
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.&nbsp;
</dd>
<dt>x</dt>
<dd>
The multiplicand of the operation.&nbsp;
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
</dd>
<dt>y</dt>
<dd>
The multiplier of the operation.&nbsp;
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>.&nbsp;
However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.&nbsp;
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> &nbsp;<a href="../headers/arithmetic/mul.hpp.html">&lt;boost/preprocessor/arithmetic/mul.hpp&gt;</a>
</div>
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
<div id="sample"><pre>
#include &lt;boost/preprocessor/arithmetic/mul.hpp&gt;
#include &lt;boost/preprocessor/arithmetic/dec.hpp&gt;
#include &lt;boost/preprocessor/control/while.hpp&gt;
#include &lt;boost/preprocessor/tuple/elem.hpp&gt;
#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>