[doc/mpfr.texi] document mpfr_compound

git-svn-id: https://scm.gforge.inria.fr/anonscm/svn/mpfr/trunk@14343 280ebfd0-de03-0410-8827-d642c229c3f4

3 files changed, 10 insertions, 2 deletions

diff --git a/NEWS b/NEWS
index 4ef73579f..07ef8d86d 100644
--- a/NEWS
+++ b/NEWS
@@ -26,7 +26,7 @@ Changes from versions 4.1.* to version 4.2.0:
   mpfr_atanu.
 - New functions mpfr_cospi, mpfr_sinpi, mpfr_tanpi, mpfr_acospi, mpfr_asinpi
   and mpfr_atanpi.
-- New function log2p1.
+- New function mpfr_log2p1 and mpfr_compound.
 - New function mpfr_fmod_ui.
 - Bug fixes.
   In particular, for the formatted output functions (mpfr_printf, etc.),
diff --git a/TODO b/TODO
index 6693b2685..ff5bb6fc0 100644
--- a/TODO
+++ b/TODO
@@ -115,7 +115,6 @@ Table of contents:
 - cr_xxx functions from http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2596.pdf
   (page 392):
   atan2pi
-  compoundn = (1+x)^n
   exp10m1, exp2m1, log10p1
   pown (but there is mpfr_pow_si with n long instead of intmax_t)
   powr = exp(y*log(x)). The difference with pow = x^y is that when x < 0
diff --git a/doc/mpfr.texi b/doc/mpfr.texi
index 67598d794..ca70ae7b2 100644
--- a/doc/mpfr.texi
+++ b/doc/mpfr.texi
@@ -2263,6 +2263,13 @@ We do not use the usual limit rules in this case, as these rules are not
 used for @code{pow}.
 @end deftypefun
 
+@deftypefun int mpfr_compound (mpfr_t @var{rop}, mpfr_t @var{op}, long int @var{n}, mpfr_rnd_t @var{rnd})
+Set @var{rop} to the power @var{n} of one plus @var{op},
+following IEEE@tie{}754-2019 for the special cases and exceptions.
+When @var{n} is zero and @var{op} is larger or equal @minus{}1,
+@var{rop} is set to 1 (IEEE@tie{}754-2019 also allows NaN).
+@end deftypefun
+
 @deftypefun int mpfr_cos (mpfr_t @var{rop}, mpfr_t @var{op}, mpfr_rnd_t @var{rnd})
 @deftypefunx int mpfr_sin (mpfr_t @var{rop}, mpfr_t @var{op}, mpfr_rnd_t @var{rnd})
 @deftypefunx int mpfr_tan (mpfr_t @var{rop}, mpfr_t @var{op}, mpfr_rnd_t @var{rnd})
@@ -4147,6 +4154,8 @@ that were added after MPFR@tie{}2.2, and in which MPFR version.
 
 @item @code{mpfr_cmpabs_ui} in MPFR@tie{}4.1.
 
+@item @code{mpfr_compound} in MPFR@tie{}4.2.0.
+
 @item @code{mpfr_copysign} in MPFR@tie{}2.3.
 Note: MPFR@tie{}2.2 had a @code{mpfr_copysign} function that was available,
 but not documented,