From e1ade3ea3b49a185ae662b7a3c12314559337145 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 5 Dec 2014 00:16:11 -0500 Subject: [PATCH] Changed explanation of which value should be greater for maximum efficiency. --- doc/ref/add.html | 2 +- doc/ref/add_d.html | 2 +- doc/ref/mul.html | 2 +- doc/ref/mul_d.html | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/ref/add.html b/doc/ref/add.html index a6681d2..569f07e 100644 --- a/doc/ref/add.html +++ b/doc/ref/add.html @@ -34,7 +34,7 @@ It is more efficient, however, to use BOOST_PP_ADD_D in such a situation.
- This macro is the most efficient when x is less than or equal to y.  + This macro is the most efficient when x is greater than or equal to y.  However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.  In other words, x should be the addend that is most likely to be the largest of the two operands.
diff --git a/doc/ref/add_d.html b/doc/ref/add_d.html index e4ead2c..26c46a0 100644 --- a/doc/ref/add_d.html +++ b/doc/ref/add_d.html @@ -34,7 +34,7 @@ If the sum of x and y is greater than BOOST_PP_LIMIT_MAG, the result is saturated to BOOST_PP_LIMIT_MAG.
- This macro is the most efficient when x is less than or equal to y.  + This macro is the most efficient when x is greater than or equal to y.  However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.  In other words, x should be the addend that is most likely to be the largest of the two operands.
diff --git a/doc/ref/mul.html b/doc/ref/mul.html index 2c2ce1a..174d88b 100644 --- a/doc/ref/mul.html +++ b/doc/ref/mul.html @@ -34,7 +34,7 @@ It is more efficient, however, to use BOOST_PP_MUL_D in such a situation.
- This macro is the most efficient when x is less than or equal to y.  + This macro is the most efficient when x is greater than or equal to y.  However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.  In other words, x should be the value that is most likely to be the largest of the two operands.
diff --git a/doc/ref/mul_d.html b/doc/ref/mul_d.html index 1881912..599fb85 100644 --- a/doc/ref/mul_d.html +++ b/doc/ref/mul_d.html @@ -34,7 +34,7 @@ If the product of x and y is greater than BOOST_PP_LIMIT_MAG, the result is saturated to BOOST_PP_LIMIT_MAG.
- This macro is the most efficient when x is less than or equal to y.  + This macro is the most efficient when x is greater than or equal to y.  However, the efficiency gain is not worth actually comparing the two arguments prior to invocation.  In other words, x should be the value that is most likely to be the largest of the two operands.