summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNiels M?ller <nisse@lysator.liu.se>2014-04-14 07:09:29 +0200
committerNiels M?ller <nisse@lysator.liu.se>2014-04-14 07:09:29 +0200
commitccfcd77b97a5cb3a5b75bb7b0981732817cb2719 (patch)
tree67f38b16c286548479da82a5983952532faf49d0 /doc
parent7a6252c51c783f759736dd4cdfcbe69198c8b81e (diff)
downloadgmp-ccfcd77b97a5cb3a5b75bb7b0981732817cb2719.tar.gz
Clarify docs for mpz_invert and the zero ring.
Diffstat (limited to 'doc')
-rw-r--r--doc/gmp.texi4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/gmp.texi b/doc/gmp.texi
index 0e96f2cbf..e467d7aaa 100644
--- a/doc/gmp.texi
+++ b/doc/gmp.texi
@@ -3619,7 +3619,9 @@ Set @var{rop} to the least common multiple of @var{op1} and @var{op2}.
@cindex Inverse modulo functions
Compute the inverse of @var{op1} modulo @var{op2} and put the result in
@var{rop}. If the inverse exists, the return value is non-zero and @var{rop}
-will satisfy @math{0 <= @var{rop} < @GMPabs{@var{op2}}}. If an inverse doesn't
+will satisfy @math{0 @le{} @var{rop} < @GMPabs{@var{op2}}} (with @math{@var{rop}
+= 0} possible only when @math{@GMPabs{@var{op2}} = 1}, i.e., in the
+somewhat degenerate zero ring). If an inverse doesn't
exist the return value is zero and @var{rop} is undefined. The behaviour of
this function is undefined when @var{op2} is zero.
@end deftypefun