diff options
| author | enge <enge@211d60ee-9f03-0410-a15a-8952a2c7a4e4> | 2011-09-02 09:34:20 +0000 |
|---|---|---|
| committer | enge <enge@211d60ee-9f03-0410-a15a-8952a2c7a4e4> | 2011-09-02 09:34:20 +0000 |
| commit | 26d2d8b13d1b199493f45e63b27aa084f4cfa09c (patch) | |
| tree | a0999fc60116e5cec26da069aba7b0d7a780f8f5 /doc | |
| parent | b6bc7d0380fefd056311700d9eafa589e81bc44a (diff) | |
| download | mpc-26d2d8b13d1b199493f45e63b27aa084f4cfa09c.tar.gz | |
mpc.texi: corrected documentation of return value for divisions
git-svn-id: svn://scm.gforge.inria.fr/svn/mpc/trunk@1070 211d60ee-9f03-0410-a15a-8952a2c7a4e4
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mpc.texi | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/mpc.texi b/doc/mpc.texi index b593faf..2388393 100644 --- a/doc/mpc.texi +++ b/doc/mpc.texi @@ -877,13 +877,15 @@ Set @var{rop} to the square of @var{op} rounded according to @var{rnd}. @deftypefun int mpc_div (mpc_t @var{rop}, mpc_t @var{op1}, mpc_t @var{op2}, mpc_rnd_t @var{rnd}) @deftypefunx int mpc_div_ui (mpc_t @var{rop}, mpc_t @var{op1}, unsigned long int @var{op2}, mpc_rnd_t @var{rnd}) -@deftypefunx int mpc_ui_div (mpc_t @var{rop}, unsigned long int @var{op1}, mpc_t @var{op2}, mpc_rnd_t @var{rnd}) @deftypefunx int mpc_div_fr (mpc_t @var{rop}, mpc_t @var{op1}, mpfr_t @var{op2}, mpc_rnd_t @var{rnd}) +@deftypefunx int mpc_ui_div (mpc_t @var{rop}, unsigned long int @var{op1}, mpc_t @var{op2}, mpc_rnd_t @var{rnd}) @deftypefunx int mpc_fr_div (mpc_t @var{rop}, mpfr_t @var{op1}, mpc_t @var{op2}, mpc_rnd_t @var{rnd}) Set @var{rop} to @var{op1}/@var{op2} rounded according to @var{rnd}. -For @code{mpc_div} and @code{mpc_ui_div}, the return value may fail to -recognize some exact results. The sign of returned value is -significant only for @code{mpc_div_ui}. +For @code{mpc_div}, @code{mpc_ui_div} and @code{mpc_fr_div}, the usual +semantics of the return value is not yet implemented. We only guarantee +that a return value of 0 indicates an exact result. +But exact results may lead to a non-zero return value, and the sign of a +non-zero return value is not significant. @end deftypefun @deftypefun int mpc_neg (mpc_t @var{rop}, mpc_t @var{op}, mpc_rnd_t @var{rnd}) @@ -926,7 +928,7 @@ when @var{rop} and @var{op1} are identical. @end deftypefun @deftypefun int mpc_fma (mpc_t @var{rop}, mpc_t @var{op1}, mpc_t @var{op2}, mpc_t @var{op3}, mpc_rnd_t @var{rnd}) -Set @var{rop} to @var{op1} times @var{op2} plus @var{op3}, +Set @var{rop} to @var{op1} @times @var{op2} plus @var{op3}, rounded according to @var{rnd}, with only one final rounding. @end deftypefun |