[Gmp-commit] /var/hg/gmp: Clarify docs for mpz_invert and the zero ring.

[mercurial at gmplib.org]

details:   /var/hg/gmp/rev/55ff6b8d9a92
changeset: 16378:55ff6b8d9a92
user:      Niels M?ller <nisse at lysator.liu.se>
date:      Mon Apr 14 07:09:29 2014 +0200
description:
Clarify docs for mpz_invert and the zero ring.

diffstat:

 ChangeLog    |  4 ++++
 doc/gmp.texi |  4 +++-
 2 files changed, 7 insertions(+), 1 deletions(-)

diffs (25 lines):

diff -r 0276be9497df -r 55ff6b8d9a92 ChangeLog
--- a/ChangeLog	Sun Apr 13 16:30:45 2014 +0200
+++ b/ChangeLog	Mon Apr 14 07:09:29 2014 +0200
@@ -1,3 +1,7 @@
+2014-04-14  Niels Möller  <nisse at lysator.liu.se>
+
+	* doc/gmp.texi (mpz_invert): Clarify behavior in the zero ring.
+
 2014-04-13 Marco Bodrato <bodrato at mail.dm.unipi.it>
 
 	* doc/gmp.texi (mpz_invert): rop possibly is 0 (iif |op2| = 1).
diff -r 0276be9497df -r 55ff6b8d9a92 doc/gmp.texi
--- a/doc/gmp.texi	Sun Apr 13 16:30:45 2014 +0200
+++ b/doc/gmp.texi	Mon Apr 14 07:09:29 2014 +0200
@@ -3619,7 +3619,9 @@
 @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