Added mpfr_dim documentation (merged from the trunk rev 4335).

git-svn-id: svn://scm.gforge.inria.fr/svn/mpfr/branches/2.2@4336 280ebfd0-de03-0410-8827-d642c229c3f4

1 files changed, 7 insertions, 0 deletions

diff --git a/mpfr.texi b/mpfr.texi
index dcccf14ba..19083a3d8 100644
--- a/mpfr.texi
+++ b/mpfr.texi
@@ -1130,6 +1130,13 @@ rounded in the direction @var{rnd}.
 Just changes the sign if @var{rop} and @var{op} are the same variable.
 @end deftypefun
 
+@deftypefun int mpfr_dim (mpfr_t @var{rop}, mpfr_t @var{op1}, mpfr_t @var{op2}, mp_rnd_t @var{rnd})
+Set @var{rop} to the positive difference of @var{op1} and @var{op2}, i.e.,
+@math{@var{op1} - @var{op2}} rounded in the direction @var{rnd}
+if @math{@var{op1} > @var{op2}}, and +0 otherwise.
+Returns NaN when @var{op1} or @var{op2} is NaN.
+@end deftypefun
+
 @deftypefun int mpfr_mul_2ui (mpfr_t @var{rop}, mpfr_t @var{op1}, unsigned long int @var{op2}, mp_rnd_t @var{rnd})
 @deftypefunx int mpfr_mul_2si (mpfr_t @var{rop}, mpfr_t @var{op1}, long int @var{op2}, mp_rnd_t @var{rnd})
 Set @var{rop} to @m{@var{op1} \times 2^{op2}, @var{op1} times 2 raised