diff options
author | Andreas Enge <andreas.enge@inria.fr> | 2016-05-24 15:05:12 +0200 |
---|---|---|
committer | Andreas Enge <andreas.enge@inria.fr> | 2016-05-24 15:05:12 +0200 |
commit | 58abe378b05566391e1916797bb48827e95c4417 (patch) | |
tree | 262f8a2214255376e01b887598b4ae1fd9c32113 /doc | |
parent | 4c311be8cefd88553ef42126227f1ed28ad61af5 (diff) | |
download | mpc-git-58abe378b05566391e1916797bb48827e95c4417.tar.gz |
mpc_cmp_abs: Make the documentation clearer.
* doc/mpc.texi [mpc_cmp_abs]: Modify the description for NaN arguments.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/mpc.texi | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/mpc.texi b/doc/mpc.texi index 1ca5957..6286347 100644 --- a/doc/mpc.texi +++ b/doc/mpc.texi @@ -799,11 +799,12 @@ with @code{mpc_cmp (op1, op2) == 0}. @deftypefn Function int mpc_cmp_abs (mpc_t @var{op1}, mpc_t @var{op2}) Compare the absolute values of @var{op1} and @var{op2}. -The return value is 0 if both are the same (including Infinity), +The return value is 0 if both are the same (including infinity), positive if the absolute value of @var{op1} is greater than that of @var{op2}, and negative if it is smaller. If @var{op1} or @var{op2} has a real or imaginary part which is NaN, -the return value is that of @code{mpfr_cmp (NaN, NaN)}. +the function behaves like @code{mpfr_cmp} on two real numbers of which at least +one is NaN. @end deftypefn |